Using the API
Scrape Endpoints
Map Endpoints
Search Endpoints
Extract Endpoints
Account Endpoints
Scrape Endpoints
Scrape
POST
/
scrape
curl --request POST \
--url https://api.firecrawl.dev/v1/scrape \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"url": "<string>",
"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",
"changeTrackingOptions": {
"modes": [
"git-diff"
],
"schema": {},
"prompt": "<string>"
}
}'
{
"success": true,
"data": {
"markdown": "<string>",
"html": "<string>",
"rawHtml": "<string>",
"screenshot": "<string>",
"links": [
"<string>"
],
"actions": {
"screenshots": [
"<string>"
],
"scrapes": [
{
"url": "<string>",
"html": "<string>"
}
],
"javascriptReturns": [
{
"type": "<string>",
"value": "<any>"
}
]
},
"metadata": {
"title": "<string>",
"description": "<string>",
"language": "<string>",
"sourceURL": "<string>",
"<any other metadata> ": "<string>",
"statusCode": 123,
"error": "<string>"
},
"llm_extraction": {},
"warning": "<string>",
"changeTracking": {
"previousScrapeAt": "2023-11-07T05:31:56Z",
"changeStatus": "new",
"visibility": "visible",
"diff": "<string>",
"json": {}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
curl --request POST \
--url https://api.firecrawl.dev/v1/scrape \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"url": "<string>",
"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",
"changeTrackingOptions": {
"modes": [
"git-diff"
],
"schema": {},
"prompt": "<string>"
}
}'
{
"success": true,
"data": {
"markdown": "<string>",
"html": "<string>",
"rawHtml": "<string>",
"screenshot": "<string>",
"links": [
"<string>"
],
"actions": {
"screenshots": [
"<string>"
],
"scrapes": [
{
"url": "<string>",
"html": "<string>"
}
],
"javascriptReturns": [
{
"type": "<string>",
"value": "<any>"
}
]
},
"metadata": {
"title": "<string>",
"description": "<string>",
"language": "<string>",
"sourceURL": "<string>",
"<any other metadata> ": "<string>",
"statusCode": 123,
"error": "<string>"
},
"llm_extraction": {},
"warning": "<string>",
"changeTracking": {
"previousScrapeAt": "2023-11-07T05:31:56Z",
"changeStatus": "new",
"visibility": "visible",
"diff": "<string>",
"json": {}
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.