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:
X-RateLimit-Limit: Maximum requests per windowX-RateLimit-Remaining: Remaining requests in current windowX-RateLimit-Reset: Unix timestamp when the window resets
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
markdown- Clean Markdown texthtml- Cleaned HTMLrawHtml- Original HTMLlinks- Extracted linksimages- Extracted images
Error Codes
401- Invalid or missing API key402- Credits exhausted. Your monthly quota has been used.422- Validation error (invalid URL, unsupported options)429- Rate limit exceeded502- Failed to fetch the target URL
Not Yet Available
The following Firecrawl endpoints are not yet available:
/v1/crawl,/v2/crawl- Website crawling/v1/map- Site mapping/v1/search- Web search/v1/extract- Structured extraction/v1/batch/scrape- Batch operations