API の使用
マップのエンドポイント
検索エンドポイント
抽出エンドポイント
Get all active crawls for the authenticated team
コピー
AIに質問
curl --request GET \
--url https://api.firecrawl.dev/v1/crawl/active \
--header 'Authorization: Bearer <token>'コピー
AIに質問
{
"success": true,
"crawls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamId": "<string>",
"url": "<string>",
"options": {
"scrapeOptions": {
"onlyMainContent": true,
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"maxAge": 0,
"headers": {},
"waitFor": 0,
"mobile": false,
"skipTlsVerification": false,
"timeout": 30000,
"parsePDF": true,
"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",
"storeInCache": true,
"formats": [
"markdown"
],
"changeTrackingOptions": {
"modes": [
"git-diff"
],
"schema": {},
"prompt": "<string>",
"tag": null
}
}
}
}
]
}クロール用エンドポイント
進行中のクロールを取得
GET
/
crawl
/
active
Get all active crawls for the authenticated team
コピー
AIに質問
curl --request GET \
--url https://api.firecrawl.dev/v1/crawl/active \
--header 'Authorization: Bearer <token>'コピー
AIに質問
{
"success": true,
"crawls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"teamId": "<string>",
"url": "<string>",
"options": {
"scrapeOptions": {
"onlyMainContent": true,
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"maxAge": 0,
"headers": {},
"waitFor": 0,
"mobile": false,
"skipTlsVerification": false,
"timeout": 30000,
"parsePDF": true,
"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",
"storeInCache": true,
"formats": [
"markdown"
],
"changeTrackingOptions": {
"modes": [
"git-diff"
],
"schema": {},
"prompt": "<string>",
"tag": null
}
}
}
}
]
}注: 機能とパフォーマンスが向上したこの API の新しいv2 版が利用可能です。
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Successful response
Example:
true
表示 子属性
表示 子属性
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
表示 子属性
表示 子属性
表示 子属性
表示 子属性
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 0, which disables caching.
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.
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 PDF files are processed during scraping. When true, the PDF content is extracted and converted to markdown format, with billing based on the number of pages (1 credit per page). When false, the PDF file is returned in base64 encoding with a flat rate of 1 credit total.
JSON options object
表示 子属性
表示 子属性
The schema to use for the extraction (Optional). Must conform to JSON Schema.
The system prompt to use for the extraction (Optional)
The prompt to use for the extraction without a schema (Optional)
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
表示 子属性
表示 子属性
Wait for a specified amount of milliseconds
利用可能なオプション:
wait Number of milliseconds to wait
必須範囲:
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.
表示 子属性
表示 子属性
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 basic.
利用可能なオプション:
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.
Formats to include in the output.
利用可能なオプション:
markdown, html, rawHtml, links, screenshot, screenshot@fullPage, json, changeTracking Options for change tracking (Beta). Only applicable when 'changeTracking' is included in formats. The 'markdown' format must also be specified when using change tracking.
表示 子属性
表示 子属性
The mode to use for change tracking. 'git-diff' provides a detailed diff, and 'json' compares extracted JSON data.
利用可能なオプション:
git-diff, json Schema for JSON extraction when using 'json' mode. Defines the structure of data to extract and compare. Must conform to JSON Schema.
Prompt to use for change tracking when using 'json' mode. If not provided, the default prompt will be used.
Tag to use for change tracking. Tags can separate change tracking history into separate "branches", where change tracking with a specific tagwill only compare to scrapes made in the same tag. If not provided, the default tag (null) will be used.
⌘I