Scrape

POST1 credit / page

https://api.crawlkit.sh/scrape

Fetch clean Markdown, HTML, text, metadata, links and screenshots.

Try on Playground

Authentication

Send your Crawlkit API key directly in the Authorization header.

Authorization: ck_your_api_key

Request Parameters

Send these JSON body fields in your request payload.

Name	Type	Description
`url`	string	Public target URL.
`formats`	string[]	Request field.

Example Request

Use direct HTTP requests against the public API base URL.

Example request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16const response = await fetch('https://api.crawlkit.sh/scrape', {
  method: 'POST',
  headers: {
    Authorization: 'ck_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "url": "https://example.com",
    "formats": [
      "markdown",
      "metadata"
    ]
  })
});

console.log(await response.json());

Response

1 credit per successful page. Screenshots included. Use Extract for AI processing. Unused reservations are refunded.

Success response (200 OK)

1
2
3
4
5
6
7
8
9
10{
  "success": true,
  "requestId": "example-request-id",
  "data": {
    "url": "https://example.com",
    "finalUrl": "https://example.com/",
    "markdown": "# Example Domain",
    "creditsUsed": 1
  }
}