Overview

GET /v1/crawl/{crawl_id} retrieves crawl task status and results.

Request

Endpoint

• GET https://run.xcrawl.com/v1/crawl/{crawl_id}

Headers

• Authorization: Bearer <api_key>

Response

Field	Type	Description
crawl_id	string	Task ID
endpoint	string	Always crawl
version	string	Version
status	string	pending / crawling / completed / failed
completed	integer	Number of completed pages so far
total	integer	Total pages currently scheduled
url	string	Entry URL
data	object[]	Result array
started_at	string	Start time (ISO 8601)
ended_at	string	End time (ISO 8601)
total_credits_used	integer	Total credits used

data is an array; each item represents a page. Fields follow output.formats:

• html: cleaned body HTML
• raw_html: raw HTML
• markdown: Markdown conversion
• links: extracted links
• metadata: page metadata (title, statusCode, contentType, proxy_location, proxy_sticky_session, sourceURL, etc; may expand)
• screenshot: screenshot URL
• summary: AI summary
• json: structured extraction result
• traffic_bytes: traffic used
• credits_used: credits used
• credits_detail: credit breakdown

Examples

Request example

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

Response example

{
  "crawl_id": "01KKE8BNNVQH9PCYEEKJGXKE07",
  "endpoint": "crawl",
  "version": "dca0d4b3bff035e4",
  "status": "completed",
  "completed": 1,
  "total": 1,
  "url": "https://docs.xcrawl.com/doc/",
  "data": [
    {
      "markdown": "[ Skip to content ](https://docs.xcrawl.com/doc/developer-guides/proxies/#VPContent)\n# Proxy Setup\nXCrawl supports proxy configuration to choose an exit region or reuse sticky sessions.\n...",
      "metadata": {
        "contentType": "text/html",
        "description": "Proxy Setup XCrawl supports proxy configuration to choose an exit region or reuse sticky sessions. ...",
        "favicon": "https://www.xcrawl.com/favicon.ico",
        "keywords": null,
        "og:title": "Proxy Setup",
        "og:type": "article",
        "og:url": "https://docs.xcrawl.com/doc/developer-guides/proxies/",
        "proxy_location": "US",
        "proxy_sticky_session": "sticky-e7ad98da",
        "sourceURL": "https://docs.xcrawl.com/doc/developer-guides/proxies",
        "statusCode": 200,
        "timezone": "Wed, 11 Mar 2026 10:51:30 GMT",
        "title": "Proxy Setup",
        "url": "https://docs.xcrawl.com/doc/developer-guides/proxies/"
      },
      "traffic_bytes": 1129,
      "credits_used": 1,
      "credits_detail": {
        "base_cost": 1,
        "traffic_cost": 0,
        "json_extract_cost": 0
      }
    }
  ],
  "started_at": "2026-03-11T10:51:24Z",
  "ended_at": "2026-03-11T10:51:37Z",
  "total_credits_used": 1
}

Previous pageCrawl API