API Reference

Authentication

All API requests require an API key passed in the Authorization header:

Authorization: Bearer cl_your_api_key

Rate Limits

API requests are limited to 10 requests per minute per API key. Rate limit headers are included in every response:

POST /v2/scrape

Convert a URL to Markdown (Firecrawl v2 compatible).

Request Body

{
  "url": "https://example.com",         // Required: URL to scrape
  "formats": ["markdown"],              // Optional: Output formats (default: ["markdown"])
  "timeout": 60000,                     // Optional: Timeout in ms (1000-120000, default: 60000)
  "excludeTags": ["nav", "footer"]      // Optional: CSS selectors to exclude
}

Response (Success)

{
  "success": true,
  "data": {
    "markdown": "# Page Title\n\nContent...",
    "metadata": {
      "title": "Page Title",
      "url": "https://example.com",
      "statusCode": 200,
      "creditsUsed": 1
    }
  }
}

Response (Error)

{
  "success": false,
  "error": "Error description"
}

POST /v1/scrape

Identical to /v2/scrape. Both endpoints are Firecrawl-compatible.

Supported Formats

Error Codes

Not Yet Available

The following Firecrawl endpoints are not yet available: