Firecrawl Docs

POST

extract

Copy
curl --request POST \
  --url https://api.firecrawl.dev/v1/extract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "urls": [
    "<string>"
  ],
  "prompt": "<string>",
  "schema": {
    "property1": "<string>",
    "property2": 123
  },
  "enableWebSearch": false,
  "ignoreSitemap": false,
  "includeSubdomains": true,
  "showSources": false,
  "scrapeOptions": {
    "formats": [
      "markdown"
    ],
    "onlyMainContent": true,
    "includeTags": [
      "<string>"
    ],
    "excludeTags": [
      "<string>"
    ],
    "headers": {},
    "waitFor": 0,
    "mobile": false,
    "skipTlsVerification": false,
    "timeout": 30000,
    "jsonOptions": {
      "schema": {},
      "systemPrompt": "<string>",
      "prompt": "<string>"
    },
    "actions": [
      {
        "type": "wait",
        "milliseconds": 2,
        "selector": "#my-element"
      }
    ],
    "location": {
      "country": "US",
      "languages": [
        "en-US"
      ]
    },
    "removeBase64Images": true,
    "blockAds": true,
    "proxy": "basic"
  }
}'

Copy
{
  "success": true,
  "id": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

urls

string[]

required

The URLs to extract data from. URLs should be in glob format.

prompt

string

Prompt to guide the extraction process

schema

object

Schema to define the structure of the extracted data

enableWebSearch

boolean

default:false

When true, the extraction will use web search to find additional data

ignoreSitemap

boolean

default:false

When true, sitemap.xml files will be ignored during website scanning

includeSubdomains

boolean

default:true

When true, subdomains of the provided URLs will also be scanned

showSources

boolean

default:false

When true, the sources used to extract the data will be included in the response as sources key

scrapeOptions

object

scrapeOptions.formats

enum<string>[]

Formats to include in the output.

Available options:

markdown,

html,

rawHtml,

links,

screenshot,

screenshot@fullPage,

json

scrapeOptions.onlyMainContent

boolean

default:true

Only return the main content of the page excluding headers, navs, footers, etc.

scrapeOptions.includeTags

string[]

Tags to include in the output.

scrapeOptions.excludeTags

string[]

Tags to exclude from the output.

scrapeOptions.headers

object

Headers to send with the request. Can be used to send cookies, user-agent, etc.

scrapeOptions.waitFor

integer

default:0

Specify a delay in milliseconds before fetching the content, allowing the page sufficient time to load.

scrapeOptions.mobile

boolean

default:false

Set to true if you want to emulate scraping from a mobile device. Useful for testing responsive pages and taking mobile screenshots.

scrapeOptions.skipTlsVerification

boolean

default:false

Skip TLS certificate verification when making requests

scrapeOptions.timeout

integer

default:30000

Timeout in milliseconds for the request

scrapeOptions.jsonOptions

object

Extract object

scrapeOptions.actions

object[]

Actions to perform on the page before grabbing the content

scrapeOptions.location

object

Location settings for the request. When specified, this will use an appropriate proxy if available and emulate the corresponding language and timezone settings. Defaults to 'US' if not specified.

scrapeOptions.removeBase64Images

boolean

Removes all base 64 images from the output, which may be overwhelmingly long. The image's alt text remains in the output, but the URL is replaced with a placeholder.

scrapeOptions.blockAds

boolean

default:true

Enables ad-blocking and cookie popup blocking.

scrapeOptions.proxy

enum<string>

Specifies the type of proxy to use.

basic: Proxies for scraping sites with none to basic anti-bot solutions. Fast and usually works.
stealth: Stealth proxies for scraping sites with advanced anti-bot solutions. Slower, but more reliable on certain sites.

If you do not specify a proxy, Firecrawl will automatically attempt to determine which one you need based on the target site.

Available options:

basic,

stealth

Response

200

application/json

Successful extraction

success

boolean

string

Suggest edits Raise issue

Map Get Extract Status

Copy
curl --request POST \
  --url https://api.firecrawl.dev/v1/extract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "urls": [
    "<string>"
  ],
  "prompt": "<string>",
  "schema": {
    "property1": "<string>",
    "property2": 123
  },
  "enableWebSearch": false,
  "ignoreSitemap": false,
  "includeSubdomains": true,
  "showSources": false,
  "scrapeOptions": {
    "formats": [
      "markdown"
    ],
    "onlyMainContent": true,
    "includeTags": [
      "<string>"
    ],
    "excludeTags": [
      "<string>"
    ],
    "headers": {},
    "waitFor": 0,
    "mobile": false,
    "skipTlsVerification": false,
    "timeout": 30000,
    "jsonOptions": {
      "schema": {},
      "systemPrompt": "<string>",
      "prompt": "<string>"
    },
    "actions": [
      {
        "type": "wait",
        "milliseconds": 2,
        "selector": "#my-element"
      }
    ],
    "location": {
      "country": "US",
      "languages": [
        "en-US"
      ]
    },
    "removeBase64Images": true,
    "blockAds": true,
    "proxy": "basic"
  }
}'

Copy
{
  "success": true,
  "id": "<string>"
}

Using the API

Scrape Endpoints

Crawl Endpoints

Map Endpoints

Extract Endpoints

Search Endpoints

Account Endpoints

Extract

Authorizations

Body

Response