検索

この search エンドポイントは、Web 検索と Firecrawl のスクレイピング機能を組み合わせることで、あらゆるクエリに対してページ全体のコンテンツを返します。

各検索結果の Markdown 形式の完全なコンテンツを取得するには、scrapeOptions に formats: [{"type": "markdown"}] を指定してください。指定しない場合は、結果（url、title、description）がデフォルトで返されます。要約されたコンテンツが必要な場合は、{"type": "summary"} など他のフォーマットも使用できます。

検索をより的確に絞り込むための各種クエリ演算子をサポートしています。

location パラメータで地域ターゲットの検索結果を取得します。形式: "string"。例: "Germany"、"San Francisco,California,United States"。

利用可能な国と言語の一覧は、サポート対象ロケーションの全リストをご覧ください。

country パラメータで、ISO の国コードを用いて検索結果の対象国を指定します。既定値: "US"。

例: "US", "DE", "FR", "JP", "UK", "CA"。

{
  "query": "レストラン",
  "country": "DE"
}

categories パラメータで、特定のカテゴリに検索結果を絞り込みます：

• github: GitHub のリポジトリ、コード、Issue、ドキュメントを検索
• research: 学術系・研究系のウェブサイト（arXiv、Nature、IEEE、PubMed など）を検索
• pdf: PDF を検索

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

includeDomains を使うと結果を特定のドメインに限定でき、excludeDomains を使うと検索結果から特定のドメインを除外できます。ドメインには、プロトコルやパスを含めず、ホスト名のみを指定してください。

includeDomains と excludeDomains は同時に使用できません。

{
  "query": "web scraping",
  "includeDomains": ["firecrawl.dev", "docs.firecrawl.dev"],
  "limit": 10
}

{
  "query": "web scraping tools",
  "excludeDomains": ["example.com"],
  "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 パラメータを使用すると、カスタム日付範囲を含む期間で検索結果を時間別に絞り込むことができます。詳細な例とサポートされている形式については、検索機能のドキュメントを参照してください。

Firecrawl API key が必要な AI agent ですか？自動オンボーディング手順については、firecrawl.dev/agent-onboarding/SKILL.mdを参照してください。