URL Scraper
Creating a URL Scraping Task
Submit a URL scraping task to fetch the full HTML content of any page using a real browser. Text, markdown and structured JSON responses are supported as well.
Requires the url-scraper scope on your API key.
Endpoint
POST /api/parsing/v1/url
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | yes | Target URL to scrape |
| proxy | string | no | Proxy URL: http://user:pass@host:port |
| useragent | string | no | Custom User-Agent string (printable ASCII only) |
| isMobile | boolean | no | Emulate mobile browser |
| solveCaptcha | boolean | no | Attempt to solve captcha if detected |
| callbackUrl | string | no | Webhook URL to POST result when done |
| takeScreenshot | boolean | no | Capture a screenshot of the page |
| parseHeaders | boolean | no | Capture response headers |
| output | object | no | Output formats to include. Default: {"html": true}. At least one format must be enabled. |
| output.html | boolean | no | Include raw HTML |
| output.markdown | boolean | no | Include Markdown version of the page |
| output.text | boolean | no | Include plain text version of the page |
| output.json | boolean | no | Include structured JSON representation |
Example Request
curl https://app.scrapering.com/api/parsing/v1/url \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data '{
"url": "https://example.com",
"isMobile": false,
"solveCaptcha": false,
"takeScreenshot": false
}'
Example Response
{
"id": "ac9c7911-b32c-4890-a850-227003ee2d35",
"status": "parsing",
"scope": "url",
"costCredits": 1,
"createdAt": "2026-05-08T10:00:00.000Z"
}
| Field | Type | Description |
|---|---|---|
| id | string | Task ID used to poll for the result |
| status | string | Current task status (parsing, done, error) |
| scope | string | Task type — always url for this endpoint |
| costCredits | number | Credits charged for the task |
| createdAt | string | ISO 8601 timestamp of when the task was created |
The task is processed asynchronously. Use the id to poll for the result or set callbackUrl to receive a webhook when parsing completes.
Next steps
- Receiving result — poll for the result using the task ID
- Webhook — receive the result via callback instead of polling
- Pricing — see how credits are calculated for this request
