メインコンテンツへスキップ
Firecrawl の scrape、crawl、map、agent 各エンドポイントで利用できるすべてのオプションのリファレンスです。

基本的なスクレイピング

単一のページをスクレイピングしてクリーンなMarkdownコンテンツを取得するには、/scrape エンドポイントを使用します。

PDFのスクレイピング

FirecrawlはPDFに対応しています。PDFを確実に解析したい場合は、parsers オプション(例: parsers: ["pdf"])を使用してください。mode オプションで解析戦略を制御できます。
  • auto (デフォルト) — まず高速なテキストベース抽出を試み、必要に応じてOCRにフォールバックします。
  • fast — テキストベースの解析のみ(埋め込みテキスト)。最も高速ですが、スキャンされたページや画像の多いページはスキップされます。
  • ocr — すべてのページで強制的にOCR解析を行います。スキャンされたドキュメントや、auto がページを誤判定する場合に使用してください。
{ type: "pdf" }"pdf" は、どちらもデフォルトで mode: "auto" になります。

スクレイピングのオプション

/scrape エンドポイントを使用する場合、以下のオプションでリクエストをカスタマイズできます。

フォーマット (formats)

formats 配列は、スクレイパーが返す出力フォーマットを制御します。デフォルト: ["markdown"] 文字列フォーマット: 名前をそのまま渡します (例: "markdown")。 オブジェクトフォーマット: type と追加オプションを含むオブジェクトを渡します。

モバイルスクレイピング

モバイル端末をエミュレートするには、mobile: true を設定します。これは、レスポンシブサイトでデスクトップではコンテンツが非表示になる場合や、モバイルブラウザ向けに異なるレイアウトが返される場合に有効です。 地域別のサイトでは、location とモバイルのスクリーンショットを組み合わせることで、実際にレンダリングされたレイアウトを確認できます。
mobile: true を指定してもサイトがデスクトップ向けレイアウトを返す場合は、headers でモバイル用の User-Agent を追加してください。

コンテンツフィルタリング

これらのパラメータは、ページのどの部分を出力に含めるかを制御します。onlyMainContenttrue (デフォルト) の場合、ナビゲーションやフッターなどの共通レイアウト部分は除去されます。includeTagsexcludeTags はフィルタリング後の結果ではなく元のページ DOM に対して適用されるため、セレクタはソース HTML 内での要素を対象にする必要があります。タグフィルタリングの起点としてページ全体を使用するには、onlyMainContent: false を設定します。

タイミングとキャッシュ

PDF 解析

アクション

スクレイピングの前にブラウザアクションを実行します。これは、動的コンテンツ、ページ遷移、またはユーザー操作が必要なページで役立ちます。1リクエストにつき最大50個のアクションを含めることができ、すべての wait アクションと waitFor を合わせた待機時間の合計は60秒を超えてはいけません。

アクション実行時の注意点

  • Write を使う前に、対象要素へフォーカスするための click が必要です。
  • Scroll は、ページ全体ではなく特定の要素をスクロールするために、任意の selector を指定できます。
  • Wait は、milliseconds(固定の待機時間)または selector(指定要素が表示されるまで待機)のいずれかを受け取ります。
  • アクションは 逐次的に 実行されます。各ステップは、次のステップが開始する前に完了します。
  • アクションは PDF では利用できません。URL が PDF に解決される場合、そのリクエストは失敗します。

高度なアクション例

スクリーンショットを撮影する:
cURL
複数の要素をクリックする:
cURL
PDF を生成する:
cURL
JavaScript を実行する (例: ページに埋め込まれたデータを抽出する) :
cURL
executeJavascript アクションの戻り値は、レスポンス内の actions.javascriptReturns 配列に格納されます。

フルスクレイプの例

次のリクエストでは、複数のスクレイプオプションを組み合わせています。
cURL
このリクエストは、Markdown、HTML、raw HTML、リンク、およびページ全体のスクリーンショットを返します。コンテンツの対象を <h1><p><a>.main-content に絞り、#ad#footer を除外し、スクレイピング前に1秒待機し、タイムアウトを15秒に設定し、PDF解析を有効にします。 詳細は Scrape API reference を参照してください。

formats を使った JSON 抽出

formats の JSON フォーマットオブジェクトを使うと、1 回の処理で構造化データを抽出できます。

Agent endpoint

自律的に複数ページにまたがるデータを抽出するには、/v2/agent エンドポイントを使用します。エージェントは非同期で動作します。まずジョブを開始し、その後、結果が返ってくるまでポーリングします。

エージェントオプション

エージェントのステータスを確認する

進捗状況を確認するには、GET /v2/agent/{jobId} をポーリングします。レスポンスの status フィールドは "processing""completed"、または "failed" のいずれかになります。
cURL
Python および Node 用の SDK には、ジョブを開始し、完了するまで自動的にポーリングするための便利なメソッド firecrawl.agent() も用意されています。

複数ページのクロール

複数のページをクロールするには、/v2/crawl エンドポイントを使用します。クロールは非同期で実行され、ジョブ ID が返されます。クロールするページ数を制御するには、limit パラメータを使用します。省略した場合、クロールは最大10,000ページまで処理します。
cURL

レスポンス

クロールジョブを確認する

ジョブ ID を使用してクロールのステータスを確認し、結果を取得します。
cURL
コンテンツが 10MB を超える場合、またはクロールジョブがまだ実行中の場合、レスポンスには next パラメータが含まれることがあります。これは、結果の次のページを指す URL です。

クロール用promptとパラメータのプレビュー

自然言語のpromptを指定すると、Firecrawl がクロール設定を導き出します。まずはその内容をプレビューしてください。
cURL

クローラーオプション

/v2/crawl エンドポイントでは、次のオプションでクロールの挙動をカスタマイズできます。

パスフィルタリング

開始 URL も includePaths に対してチェックされます。いずれのパターンにもマッチしない場合、クロールの結果が 0 ページになる可能性があります。

クロール範囲

サイトマップと重複排除

クローリング時のスクレイプオプション

クロールの例

cURL
/v2/map エンドポイントは、指定したWeb サイトに関連するURLを特定します。
cURL

Map オプション

API リファレンス: Map Endpoint Documentation

Firecrawl をホワイトリストに追加する

自分のウェブサイトのスクレイピングを Firecrawl に許可する

  • User Agent: ファイアウォールやセキュリティルールで FirecrawlAgent を許可してください。
  • IP addresses: Firecrawl は、外向き通信に固定の送信元 IP アドレスを使用していません。

アプリケーションから Firecrawl API への呼び出しを許可する

ファイアウォールがアプリケーションから外部サービスへのアウトバウンドリクエストをブロックしている場合は、アプリケーションが Firecrawl API(api.firecrawl.dev)に到達できるよう、Firecrawl の API サーバーの IP アドレスをホワイトリストに追加する必要があります。
  • IP Address: 35.245.250.27
この IP をファイアウォールのアウトバウンド許可リストに追加し、バックエンドから Firecrawl へ scrape、crawl、map、および agent リクエストを送信できるようにしてください。