Scrape Result API

Overview

GET /v1/scrape/{scrape_id} retrieves status and results for async scrape tasks.

Request

Endpoint

GET https://run.xcrawl.com/v1/scrape/{scrape_id}

Headers

Authorization: Bearer <api_key>

Response

Field	Type	Description
`scrape_id`	string	Task ID
`endpoint`	string	Always `scrape`
`version`	string	Version
`status`	string	`pending` / `crawling` / `completed` / `failed`
`url`	string	Target URL
`data`	object	Result data
`started_at`	string	Start time (ISO 8601)
`ended_at`	string	End time (ISO 8601)

See Scrape API for data field details. In-progress or failed tasks may omit data.

Examples

Request example

curl -s -X GET 'https://run.xcrawl.com/v1/scrape/01KKE89TSDTP063R5PEX6XWSE1' \
  -H 'Authorization: Bearer $XCRAWL_API_KEY'

Response example

{
  "scrape_id": "01KKE89TSDTP063R5PEX6XWSE1",
  "endpoint": "scrape",
  "version": "dca0d4b3bff035e4",
  "status": "completed",
  "url": "https://docs.xcrawl.com/doc/introduction/",
  "data": {
    "markdown": "Skip to content\n# Quickstart\nXCrawl quickly turns search results and website content into LLM-friendly formats.\n...",
    "metadata": {
      "charset": "utf-8",
      "content_type": "text/html",
      "description": "Quickstart XCrawl quickly turns search results and website content into LLM-friendly formats. ...",
      "favicon": "https://www.xcrawl.com/favicon.ico",
      "final_url": "https://docs.xcrawl.com/doc/introduction/",
      "generator": "VuePress 2.0.0-rc.26",
      "name": [
        "Home",
        "Documentation",
        "Getting Started",
        "Quickstart"
      ],
      "og:title": "Quickstart",
      "og:type": "article",
      "og:url": "https://docs.xcrawl.com/doc/introduction/",
      "position": [
        "1",
        "2",
        "3",
        "4"
      ],
      "proxy_location": "US",
      "proxy_sticky_session": "sticky-a11edf00",
      "requested_url": "https://docs.xcrawl.com/doc/introduction/",
      "status_code": 200,
      "theme": "VuePress Theme Plume 1.0.0-rc.177",
      "title": "Quickstart",
      "viewport": "width=device-width,initial-scale=1"
    },
    "traffic_bytes": 96895,
    "credits_used": 1,
    "credits_detail": {
      "base_cost": 1,
      "traffic_cost": 0,
      "json_extract_cost": 0
    }
  },
  "started_at": "2026-03-11T10:50:24Z",
  "ended_at": "2026-03-11T10:50:30Z"
}