メインコンテンツへスキップ
POST
/
search
検索を行い、必要に応じて検索結果をスクレイピングする
curl --request POST \
  --url https://api.firecrawl.dev/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "limit": 5,
  "tbs": "<string>",
  "location": "<string>",
  "timeout": 60000,
  "ignoreInvalidURLs": false,
  "scrapeOptions": {}
}
'
{
  "success": true,
  "data": [
    {
      "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>"
      }
    }
  ],
  "warning": "<string>"
}
注意: 機能とパフォーマンスが向上した new v2 version of this API が利用可能です。
search エンドポイントは、ウェブ検索と Firecrawl のスクレイピング機能を組み合わせ、任意のクエリに対してページ全体のコンテンツを返します。 各検索結果の完全な Markdown コンテンツを取得するには、scrapeOptionsformats: ["markdown"] を指定してください。指定しない場合は、既定で結果(url、title、description)のみが返されます。

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

検索をより適切に絞り込める、さまざまなクエリ演算子をサポートしています。
OperatorFunctionalityExamples
""文字列を厳密一致させる"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

Location パラメータ

location パラメータを使うと、地域に最適化された検索結果を取得できます。形式: "string"。例: "Germany""San Francisco,California,United States" 利用可能なすべての国と言語は、サポート対象ロケーションの一覧をご覧ください。 tbs パラメータを使うと、カスタムの日付範囲を含む期間で結果を絞り込めます。具体例や対応フォーマットは、検索機能のドキュメントを参照してください。

承認

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
tbs
string

時間指定の検索パラメータ。事前定義された時間範囲(qdr:hqdr:dqdr:wqdr:mqdr:y)と、カスタム日付範囲(cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY)をサポートします

location
string

検索結果の location パラメーター

timeout
integer
デフォルト:60000

タイムアウト(ミリ秒)

ignoreInvalidURLs
boolean
デフォルト:false

他の Firecrawl エンドポイントでは無効となる URL を検索結果から除外します。検索結果のデータを他の Firecrawl API エンドポイントにパイプで渡す場合のエラー削減に役立ちます。

scrapeOptions
object

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

レスポンス

成功時のレスポンス

success
boolean
data
object[]
warning
string | null

問題発生時に表示される警告メッセージ