Using the REST API

FireScraper provides a REST API so you can trigger scrapes, check session status, and download results from your own scripts, CI pipelines, or workflow tools like n8n and Make.

Getting an API key

Open the API Keys page from the sidebar (or go to Settings → API Keys)

Give your key a descriptive name (e.g. "CI Pipeline" or "n8n workflow")

Click Create API key

Copy the key immediately — it won't be shown again

Your key starts with fsk_ and should be kept secret. Never commit it to version control or share it publicly.

Authentication

Include your API key in the Authorization header of every request:

Authorization: Bearer fsk_your_api_key_here

Core endpoints

Start a scrape

POST /api/v1/scrape

Request body:

{
  "urls": ["https://docs.example.com"],
  "depth": 2,
  "minTextLength": 50,
  "scraperMode": "article"
}

Response:

{
  "sessionId": "abc123",
  "status": "PENDING_START"
}

Check session status

GET /api/v1/sessions/:sessionId

Returns the current status of a scrape session. Poll this endpoint until status is DONE or ERROR.

Download results

GET /api/v1/sessions/:sessionId/results

Returns the scraped data as JSON. Each item includes the page URL, extracted text, title, and metadata.

Example workflow

POST to /api/v1/scrape with your URLs and settings

Poll /api/v1/sessions/:id every few seconds until status is DONE

GET /api/v1/sessions/:id/results to download the scraped content

Process the results in your pipeline

Rate limits

API requests are rate-limited per account. If you hit the limit, you'll receive a 429 Too Many Requests response. Wait a moment and retry.

Tips

Use descriptive key names so you know which key is used where (e.g. "Production webhook" vs "Local testing")

Revoke keys you no longer use from the API Keys page to keep your account secure

Check the API docs in the app for the full endpoint reference and response schemas