マップ

POST /map

オプションを指定して複数のURLをマップする

cURL

curl --request POST \
  --url https://api.firecrawl.dev/v2/map \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "search": "<string>",
  "sitemap": "include",
  "includeSubdomains": true,
  "ignoreQueryParameters": true,
  "ignoreCache": false,
  "limit": 5000,
  "location": {
    "country": "US",
    "languages": [
      "en-US"
    ]
  },
  "timeout": 60000
}
'

200

{
  "success": true,
  "links": [
    {
      "url": "<string>",
      "title": "<string>",
      "description": "<string>"
    }
  ]
}

承認

Authorization · string · header · 必須

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

ボディ

application/json

url · string<uri> · 必須

クロールの開始地点となるベースURL

search · string

検索クエリを指定すると、結果が関連度の高い順に並べ替えられます。例: 「blog」を指定すると、URL 内に「blog」を含むものが関連度順に返されます。

sitemap · enum<string> · デフォルト: include

マッピング時のサイトマップモードです。skip に設定すると、URL の検出にサイトマップは使用されません。only に設定すると、サイトマップ内にある URL だけが返されます。デフォルトの include では、サイトマップとその他の手法を併用して URL を検出します。

利用可能なオプション: skip, include, only

includeSubdomains · boolean · デフォルト: true

このサイトのサブドメインを含める

ignoreQueryParameters · boolean · デフォルト: true

クエリパラメータ付きのURLを返さない

ignoreCache · boolean · デフォルト: false

サイトマップキャッシュを無視して最新のURLを取得します。サイトマップデータは最大7日間キャッシュされるため、サイトマップを最近更新した場合はこのパラメータを指定してください。

limit · integer · デフォルト: 5000

返すリンクの最大数

必須範囲: x <= 100000

timeout · integer

タイムアウト（ミリ秒単位）。既定ではタイムアウトはありません。

location · object

リクエストのロケーション設定です。指定すると、利用可能な場合は適切なプロキシを使用し、対応する言語およびタイムゾーン設定をエミュレートします。指定しない場合は、デフォルトで「US」が使用されます。

Show child attributes

レスポンス

200

application/json

成功したレスポンス

success · boolean

links · object[]

Show child attributes