POST
/
scrape
curl --request POST \
  --url https://api.firecrawl.dev/v0/scrape \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "pageOptions": {
    "onlyMainContent": true,
    "includeHtml": true,
    "includeRawHtml": true,
    "screenshot": true,
    "waitFor": 123,
    "removeTags": [
      "<string>"
    ],
    "onlyIncludeTags": [
      "<string>"
    ],
    "headers": {},
    "replaceAllPathsWithAbsolutePaths": true,
    "parsePDF": true
  },
  "extractorOptions": {
    "mode": "llm-extraction",
    "extractionPrompt": "<string>",
    "extractionSchema": {}
  },
  "timeout": 123
}'
{
  "success": true,
  "data": {
    "markdown": "<string>",
    "content": "<string>",
    "html": "<string>",
    "rawHtml": "<string>",
    "metadata": {
      "title": "<string>",
      "description": "<string>",
      "language": "<string>",
      "sourceURL": "<string>",
      "<any other metadata> ": "<string>",
      "pageStatusCode": 123,
      "pageError": "<string>"
    },
    "llm_extraction": {},
    "warning": "<string>"
  }
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required

The URL to scrape

pageOptions
object
extractorOptions
object

Options for LLM-based extraction of structured information from the page content

timeout
integer
default: 30000

Timeout in milliseconds for the request

Response

200 - application/json
success
boolean
data
object