FireCrawl

Tools Dashboard

Choose your scraping tool

Back to Home

API Access

Integrate our scraping tools into your applications

Endpoints

5

Rate Limit

1000/h

Security

TLS 1.3

Uptime

99.9%

API Key Management

Generate and manage your API keys for authentication. Keep your keys secure and never share them publicly.

Quick Start

Get started with our API in minutes. Here are examples in different programming languages:

JavaScript

// JavaScript/Node.js Example
const response = await fetch('https://yourapi.com/api/content', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'your-api-key-here'
  },
  body: JSON.stringify({
    url: 'https://example.com',
    format: 'markdown'
  })
});

const data = await response.json();
console.log(data.content);

Python

# Python Example
import requests

url = "https://yourapi.com/api/content"
headers = {
    "Content-Type": "application/json",
    "x-api-key": "your-api-key-here"
}
data = {
    "url": "https://example.com",
    "format": "markdown"
}

response = requests.post(url, json=data, headers=headers)
result = response.json()
print(result["content"])

cURL

# cURL Example
curl -X POST https://yourapi.com/api/content \
  -H "Content-Type: application/json" \
  -H "x-api-key: your-api-key-here" \
  -d '{
    "url": "https://example.com",
    "format": "markdown"
  }'

Authentication

All API requests require an API key to be included in the headers. Use the header x-api-key to provide your key.

Important: Keep your API key secure and never expose it in client-side code or public repositories.

API Endpoints

All endpoints use POST requests and return JSON responses.

POST/api/content

Content

Extracts the main article content from a URL.

Request Body:

{
  "url": "https://example.com",
  "format": "markdown" | "text"
}

Response:

{
  "content": "..."
}
POST/api/images

Images

Extracts all image URLs from the main content of a webpage.

Request Body:

{
  "url": "https://example.com"
}

Response:

{
  "images": ["url1", "url2", ...]
}
POST/api/links

Links

Extracts all hyperlink URLs from the main content of a webpage.

Request Body:

{
  "url": "https://example.com"
}

Response:

{
  "links": ["url1", "url2", ...]
}
POST/api/emails

Emails

Extracts all email addresses found on a webpage.

Request Body:

{
  "url": "https://example.com"
}

Response:

{
  "emails": ["email1", "email2", ...]
}
POST/api/screenshot

Screenshot

Takes a full-page screenshot of a webpage.

Request Body:

{
  "url": "https://example.com"
}

Response:

Returns a PNG image.