Parsew
API Reference

Get batch scrape status

Poll the status of a batch scrape job and retrieve results.

GET
/batch/scrape/{id}

Poll the status of a batch scrape job and retrieve results.

Authorization

bearerAuth
AuthorizationBearer <token>

Secret API key (sr_ prefix). Pass as Authorization: Bearer sr_...

In: header

Path Parameters

id*string

Query Parameters

offset?|
Default0
Range0 <= value
limit?integer
Default100
Range1 <= value <= 100

Response Body

application/json

application/json

curl -X GET "https://api.parsew.com/v1/batch/scrape/string"
{
  "id": "string",
  "status": "scraping",
  "total": 0,
  "completed": 0,
  "failed": 0,
  "creditsUsed": 0,
  "expiresAt": "string",
  "data": [
    {
      "url": "string",
      "markdown": "string",
      "html": "string",
      "links": [
        "string"
      ],
      "warning": "string",
      "error": "string"
    }
  ]
}
{
  "error": "string"
}

Extract structured data POST

Scrape a web page and extract structured data using an LLM. Define a JSON Schema for the output shape and provide a natural-language prompt. Costs 5 credits.

Map links on a page POST

Scrape a web page and return all discovered links, with optional filtering by substring search or regex pattern. Costs 1 credit.