Browse documentation

Search

POST1 credit / 10 results
https://api.crawlkit.sh/search

Search the public web and return structured DuckDuckGo results with region, recency and cursor controls.

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.

NameTypeDescription
querystringSearch query text.
options.regionstringRegion code.
options.timeRangestringRecency filter.
options.maxResultsnumberMaximum result count.

Example Request

Use direct HTTP requests against the public API base URL.

Example request
const response = await fetch('https://api.crawlkit.sh/search', {
  method: 'POST',
  headers: {
    Authorization: 'ck_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "query": "web research APIs",
    "options": {
      "region": "us-en",
      "timeRange": "m",
      "maxResults": 10
    }
  })
});

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

Response

This example returns one result and uses 1 credit. 1 credit per 10 returned results, rounded up. Empty results cost 0 credits. Unused reservations are refunded.

Success response (200 OK)
{
  "success": true,
  "requestId": "example-request-id",
  "data": {
    "query": "web research APIs",
    "totalResults": 1,
    "results": [
      {
        "position": 1,
        "title": "Example result",
        "url": "https://example.com/result",
        "snippet": "A structured search result."
      }
    ],
    "pagination": {
      "nextCursor": null,
      "hasMore": false
    },
    "creditsUsed": 1
  }
}