メインコンテンツへスキップ
POST
/
map
オプションを指定して複数のURLをマップする
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,
  "limit": 5000,
  "location": {
    "country": "US",
    "languages": [
      "en-US"
    ]
  },
  "timeout": 60000
}
'
{
  "success": true,
  "links": [
    {
      "url": "<string>",
      "title": "<string>",
      "description": "<string>"
    }
  ]
}

​
v2の新着情報

​
サイトマップ制御の強化

サイトマップを扱う方法は3つあります:
  • "include" - サイトマップを使用し、他のページも検出（デフォルト）
  • "skip" - サイトマップを完全に無視
  • "only" - サイトマップのURLのみを返す
{
  "url": "https://example.com",
  "sitemap": "only"
}

​
レスポンス形式の変更

現在は links をオブジェクトの配列として返し、それぞれに拡張されたメタデータを含めています。 
{
  "url": "https://example.com",
  "links": [
    {
      "url": "https://example.com/page1",
      "title": "Page 1",
      "description": "Page 1 description"
    }
  ]
}

承認

​
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を返さない

​
limit
integer
デフォルト:5000

返すリンクの最大数

必須範囲: x <= 100000
​
timeout
integer

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

​
location
object

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

レスポンス

成功したレスポンス

​
success
boolean
​
links
object[]