メインコンテンツへスキップ
POST
/
search
検索し、必要に応じて検索結果をスクレイピングする
curl --request POST \
  --url https://api.firecrawl.dev/v2/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "limit": 5,
  "sources": [
    "web"
  ],
  "categories": [
    {
      "type": "github"
    }
  ],
  "tbs": "<string>",
  "location": "<string>",
  "country": "US",
  "timeout": 60000,
  "ignoreInvalidURLs": false,
  "scrapeOptions": {}
}
'
{
  "success": true,
  "data": {
    "web": [
      {
        "title": "<string>",
        "description": "<string>",
        "url": "<string>",
        "markdown": "<string>",
        "html": "<string>",
        "rawHtml": "<string>",
        "links": [
          "<string>"
        ],
        "screenshot": "<string>",
        "metadata": {
          "title": "<string>",
          "description": "<string>",
          "sourceURL": "<string>",
          "statusCode": 123,
          "error": "<string>"
        }
      }
    ],
    "images": [
      {
        "title": "<string>",
        "imageUrl": "<string>",
        "imageWidth": 123,
        "imageHeight": 123,
        "url": "<string>",
        "position": 123
      }
    ],
    "news": [
      {
        "title": "<string>",
        "snippet": "<string>",
        "url": "<string>",
        "date": "<string>",
        "imageUrl": "<string>",
        "position": 123,
        "markdown": "<string>",
        "html": "<string>",
        "rawHtml": "<string>",
        "links": [
          "<string>"
        ],
        "screenshot": "<string>",
        "metadata": {
          "title": "<string>",
          "description": "<string>",
          "sourceURL": "<string>",
          "statusCode": 123,
          "error": "<string>"
        }
      }
    ]
  },
  "warning": "<string>"
}

​
v2の新機能

​
複数ソースを検索

Web、画像、ニュースをまとめて検索： 
{
  "query": "firecrawl web scraping",
  "sources": [ "web", "images", "news" ]
}

​
レスポンス形式の変更

v1: 結果のフラットなリスト。v2: ソース種別ごとに整理された構造。 
{
  "success": true,
  "data": {
    "web": [/* web results */],
    "images": [/* 画像結果 */],
    "news": [/* news results */]
  }
}

​
新機能

  • 「past week」「past month」などの期間指定フィルタリング
  • 特定の国や地域の指定
  • カテゴリフィルタリング: GitHub リポジトリやリサーチサイト内を検索
  • アルファ版では結果は最大 500 件まで
この search エンドポイントは、Web 検索と Firecrawl のスクレイピング機能を組み合わせることで、あらゆるクエリに対してページ全体のコンテンツを返します。 各検索結果の Markdown 形式の完全なコンテンツを取得するには、scrapeOptions に formats: [{"type": "markdown"}] を指定してください。指定しない場合は、結果（url、title、description）がデフォルトで返されます。要約されたコンテンツが必要な場合は、{"type": "summary"} など他のフォーマットも使用できます。

​
サポートされているクエリ演算子

検索をより的確に絞り込むための各種クエリ演算子をサポートしています。
演算子機能例
""テキストを厳密一致で検索する"Firecrawl"
-特定のキーワードを除外、または他の演算子を否定する-bad, -site:firecrawl.dev
site:指定したサイトの結果のみを返すsite:firecrawl.dev
inurl:URL に特定の語を含む結果のみを返すinurl:firecrawl
allinurl:URL に複数の語を含む結果のみを返すallinurl:git firecrawl
intitle:ページタイトルに特定の語を含む結果のみを返すintitle:Firecrawl
allintitle:ページタイトルに複数の語を含む結果のみを返すallintitle:firecrawl playground
related:特定のドメインに関連する結果のみを返すrelated:firecrawl.dev
imagesize:指定した寸法と完全一致の画像のみを返すimagesize:1920x1080
larger:指定した寸法より大きい画像のみを返すlarger:1920x1080

​
Location パラメータ

location パラメータで地域ターゲットの検索結果を取得します。形式: "string"。例: "Germany"、"San Francisco,California,United States"。 利用可能な国と言語の一覧は、サポート対象ロケーションの全リストをご覧ください。

​
Country パラメータ

country パラメータで、ISO の国コードを用いて検索結果の対象国を指定します。既定値: "US"。 例: "US", "DE", "FR", "JP", "UK", "CA"。 
{
  "query": "レストラン",
  "country": "DE"
}

​
Categories パラメータ

categories パラメータで、特定のカテゴリに検索結果を絞り込みます：
  • github: GitHub のリポジトリ、コード、Issue、ドキュメントを検索
  • research: 学術系・研究系のウェブサイト（arXiv、Nature、IEEE、PubMed など）を検索
  • pdf: PDF を検索

​
使い方の例

{
  "query": "機械学習",
  "categories": ["github", "research"],
  "limit": 10
}

​
カテゴリレスポンス

各結果には、どのソースからのものかを示す category フィールドが含まれます。 
{
  "success": true,
  "data": {
    "web": [
      {
        "url": "https://github.com/example/ml-project",
        "title": "Machine Learning Project",
        "description": "Implementation of ML algorithms",
        "category": "github"
      },
      {
        "url": "https://arxiv.org/abs/2024.12345",
        "title": "ML Research Paper",
        "description": "Latest advances in machine learning",
        "category": "research"
      }
    ]
  }
}
tbs パラメータを使うと、カスタム日付範囲を含む特定の期間で検索結果をフィルタリングできます。詳細な例とサポートされているフォーマットについては、Search 機能のドキュメントを参照してください。

承認

​
Authorization
string
header
必須

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

ボディ

application/json
​
query
string
必須

検索クエリ

​
limit
integer
デフォルト:5

返す結果の最大数

必須範囲: 1 <= x <= 100
​
sources
(Web · object | Images · object | News · object)[]

検索対象とするソース。レスポンスに含まれる配列の種類を決定します。デフォルトは ['web'] です。

​
categories
(GitHub · object | Research · object | PDF · object)[]

結果をカテゴリでフィルタリングするための指定。デフォルト値は [] で、この場合はカテゴリによるフィルタリングは行われません。

​
tbs
string

時間ベースの検索パラメータです。あらかじめ定義された時間範囲（qdr:h、qdr:d、qdr:w、qdr:m、qdr:y）と、カスタム日付範囲（cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY）をサポートします。

​
location
string

検索結果のロケーションを指定するパラメータ（例: San Francisco,California,United States）。最適な結果を得るには、このパラメータと country パラメータの両方を設定してください。

​
country
string
デフォルト:US

検索結果のジオターゲティングに使用する ISO 国コード（例：US）。最適な結果を得るには、これと location パラメータの両方を設定してください。

​
timeout
integer
デフォルト:60000

タイムアウト時間（ミリ秒）

​
ignoreInvalidURLs
boolean
デフォルト:false

他の Firecrawl エンドポイントでは無効となる URL を検索結果から除外します。これにより、検索から取得したデータを他の Firecrawl API エンドポイントに渡す際のエラーを減らせます。

​
scrapeOptions
object

検索結果をスクレイピングする際のオプション

レスポンス

成功時のレスポンス

​
success
boolean
​
data
object

検索結果。利用可能な配列は、リクエストで指定したソースに応じて変わります。デフォルトでは web 配列が返されます。

​
warning
string | null

何らかの問題が発生した場合の警告メッセージ