Uso de la API
Endpoints de scraping
Endpoints de búsqueda
Puntos de conexión de Map
Endpoints de rastreo
Puntos finales de extracción
Get all active crawls for the authenticated team
Copiar
Preguntar a la IA
curl --request GET \
--url https://api.firecrawl.dev/v2/crawl/active \
--header 'Authorization: Bearer <token>'Copiar
Preguntar a la IA
{
"success": true,
"crawls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamId": "<string>",
"url": "<string>",
"options": {
"scrapeOptions": {
"formats": [
"markdown"
],
"onlyMainContent": true,
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"maxAge": 172800000,
"headers": {},
"waitFor": 0,
"mobile": false,
"skipTlsVerification": true,
"timeout": 123,
"parsers": [
"pdf"
],
"actions": [
{
"type": "wait",
"milliseconds": 2,
"selector": "#my-element"
}
],
"location": {
"country": "US",
"languages": [
"en-US"
]
},
"removeBase64Images": true,
"blockAds": true,
"proxy": "auto",
"storeInCache": true
}
}
}
]
}Endpoints de rastreo
Obtener rastreos activos
GET
/
crawl
/
active
Get all active crawls for the authenticated team
Copiar
Preguntar a la IA
curl --request GET \
--url https://api.firecrawl.dev/v2/crawl/active \
--header 'Authorization: Bearer <token>'Copiar
Preguntar a la IA
{
"success": true,
"crawls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamId": "<string>",
"url": "<string>",
"options": {
"scrapeOptions": {
"formats": [
"markdown"
],
"onlyMainContent": true,
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"maxAge": 172800000,
"headers": {},
"waitFor": 0,
"mobile": false,
"skipTlsVerification": true,
"timeout": 123,
"parsers": [
"pdf"
],
"actions": [
{
"type": "wait",
"milliseconds": 2,
"selector": "#my-element"
}
],
"location": {
"country": "US",
"languages": [
"en-US"
]
},
"removeBase64Images": true,
"blockAds": true,
"proxy": "auto",
"storeInCache": true
}
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Successful response
Example:
true
Mostrar atributos secundarios
Mostrar atributos secundarios
The unique identifier of the crawl
The ID of the team that owns the crawl
The origin URL of the crawl
The crawler options used for this crawl
Mostrar atributos secundarios
Mostrar atributos secundarios
Mostrar atributos secundarios
Mostrar atributos secundarios
crawls.options.scrapeOptions.formats
(Markdown · object | Summary · object | HTML · object | Raw HTML · object | Links · object | Images · object | Screenshot · object | JSON · object | Change Tracking · object | Branding · object)[]
Output formats to include in the response. You can specify one or more formats, either as strings (e.g., 'markdown') or as objects with additional options (e.g., { type: 'json', schema: {...} }). Some formats require specific options to be set. Example: ['markdown', { type: 'json', schema: {...} }].
- Markdown
- Summary
- HTML
- Raw HTML
- Links
- Images
- Screenshot
- JSON
- Change Tracking
- Branding
Mostrar atributos secundarios
Mostrar atributos secundarios
Opciones disponibles:
markdown Only return the main content of the page excluding headers, navs, footers, etc.
Tags to include in the output.
Tags to exclude from the output.
Returns a cached version of the page if it is younger than this age in milliseconds. If a cached version of the page is older than this value, the page will be scraped. If you do not need extremely fresh data, enabling this can speed up your scrapes by 500%. Defaults to 2 days.
Headers to send with the request. Can be used to send cookies, user-agent, etc.
Specify a delay in milliseconds before fetching the content, allowing the page sufficient time to load. This waiting time is in addition to Firecrawl's smart wait feature.
Set to true if you want to emulate scraping from a mobile device. Useful for testing responsive pages and taking mobile screenshots.
Skip TLS certificate verification when making requests
Timeout in milliseconds for the request.
Controls how files are processed during scraping. When "pdf" is included (default), the PDF content is extracted and converted to markdown format, with billing based on the number of pages (1 credit per page). When an empty array is passed, the PDF file is returned in base64 encoding with a flat rate of 1 credit total.
Opciones disponibles:
pdf crawls.options.scrapeOptions.actions
(Wait · object | Screenshot · object | Click · object | Write text · object | Press a key · object | Scroll · object | Scrape · object | Execute JavaScript · object | Generate PDF · object)[]
Actions to perform on the page before grabbing the content
- Wait
- Screenshot
- Click
- Write text
- Press a key
- Scroll
- Scrape
- Execute JavaScript
- Generate PDF
Mostrar atributos secundarios
Mostrar atributos secundarios
Wait for a specified amount of milliseconds
Opciones disponibles:
wait Number of milliseconds to wait
Rango requerido:
x >= 1Query selector to find the element by
Example:
"#my-element"
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.
Mostrar atributos secundarios
Mostrar atributos secundarios
ISO 3166-1 alpha-2 country code (e.g., 'US', 'AU', 'DE', 'JP')
Preferred languages and locales for the request in order of priority. Defaults to the language of the specified location. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language
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.
Enables ad-blocking and cookie popup blocking.
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. Costs up to 5 credits per request.
- auto: Firecrawl will automatically retry scraping with stealth proxies if the basic proxy fails. If the retry with stealth is successful, 5 credits will be billed for the scrape. If the first attempt with basic is successful, only the regular cost will be billed.
If you do not specify a proxy, Firecrawl will default to auto.
Opciones disponibles:
basic, stealth, auto If true, the page will be stored in the Firecrawl index and cache. Setting this to false is useful if your scraping activity may have data protection concerns. Using some parameters associated with sensitive scraping (actions, headers) will force this parameter to be false.
⌘I