Data API / Firecrawl / Scrape

Scrape a single page and return its main content as markdown.

Fetch one URL and get its main content back as markdown. url and proxy are both required — proxy must be basic on the metered profile — and formats selects the output. Returns success and data with markdown plus a large metadata object carrying the page's og: and twitter: tags, statusCode, sourceURL and language. ⚠️ The URL must be HTTPS and must not point at a PDF; both are rejected rather than best-effort. Use it when you have the URL and want the text. For several URLs at once post_firecrawl_batch_scrape runs them as one background job, and extractWebContent does a small batch synchronously. To find URLs first, post_firecrawl_map.

Parameters

No path, query, or header parameters.

Request body

urlstringRequired
The HTTPS URL to scrape. PDF URLs are not supported on the metered profile.
proxystringRequired
Allowed values: basic
Proxy tier. Must be explicitly set to "basic" on the metered profile.
formatsstring[]Optional
Allowed values: markdown
Optional output formats. When present it must be exactly ["markdown"].

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/firecrawl/scrape" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "<string>",
  "proxy": "<string>",
  "formats": [
    "<string>"
  ]
}'

Response

Response fields

successbooleanOptional
True when the scrape succeeded.
dataobjectOptional
markdownstringOptional
The scraped page content in markdown.
metadataobjectOptional
Page metadata such as title, description, source URL, and HTTP status.
titlestringOptional
descriptionstringOptional
sourceURLstringOptional
statusCodeintegerOptional
creditsUsedintegerOptional
Firecrawl credits consumed by the request (1 per page).