Skip to main content

.NET

Firecrawl .NET SDK は、Firecrawl API のラッパーで、Web サイトを簡単に Markdown に変換できます。
2 min read

インストール#

公式の .NET SDK は、Firecrawl のモノレポ内の apps/dot-net-sdk で管理されています。

Firecrawl .NET SDK をインストールするには、NuGet パッケージを追加します。

Note
.NET 8.0 以降が必要です。

使い方#

  1. firecrawl.devでAPIキーを取得します
  2. APIキーを FIRECRAWL_API_KEY という環境変数に設定するか、FirecrawlClient のコンストラクターに渡します

以下は、現在のSDK APIでの簡単な例です。

URLをスクレイピングする#

単一のURLをスクレイピングするには、ScrapeAsyncメソッドを使用します。

JSON抽出#

JsonFormat を使用して、/scrape エンドポイントで構造化された JSON を抽出します。

Web サイトのクロール#

Web サイトをクロールして完了を待つには、CrawlAsync を使用します。このメソッドは、ポーリングとページネーションを自動的に処理します。

クロールを開始する#

StartCrawlAsync を使用すると、待たずにジョブを開始できます。

クロールのステータスを確認する#

GetCrawlStatusAsync でクロールの進行状況を確認します。

クロールをキャンセルする#

実行中のクロールは CancelCrawlAsync でキャンセルできます。

Web サイトのマッピング#

MapAsync で Web サイト内のリンクを見つけます。

Webを検索#

任意の検索設定を指定して、SearchAsync で検索します。

バッチスクレイプ#

BatchScrapeAsync を使用すると、複数のURLを並列でスクレイピングできます。このメソッドは、ポーリングとページネーションを自動的に処理します。

冪等性キーを使ったバッチスクレイプ#

重複したリクエストが処理されないようにするには、IdempotencyKey を渡します:

使用状況 & メトリクス#

並行実行数と残りのクレジットを確認:

非同期サポート#

.NET SDK のすべてのメソッドは既定で非同期で、Task<T> を返します。協調的なキャンセルに対応するため、CancellationToken をサポートしています。

設定#

FirecrawlClient コンストラクターは、以下のオプションをサポートしています。

OptionTypeDefaultDescription
apiKeystring?FIRECRAWL_API_KEY env varFirecrawl APIキー
apiUrlstring?https://api.firecrawl.dev (or FIRECRAWL_API_URL)API のベース URL
timeoutTimeSpan?5 分HTTP リクエストのタイムアウト
maxRetriesint3一時的な障害に対する自動再試行
backoffFactordouble0.5秒単位の指数バックオフ係数
httpClientHttpClient?timeout から構築事前設定済みの HttpClient インスタンス

カスタム HTTP クライアント#

接続プーリング、プロキシ、メッセージ ハンドラー、その他の HttpClient 機能を制御するために、事前設定済みの HttpClient を渡せます。これを指定すると、timeout の設定は無視され、代わりにクライアント自体の設定が使用されます。

環境変数による設定#

コンストラクタのパラメータが省略されている場合、SDK は環境変数から設定を読み取ります。

エラーハンドリング#

SDK は Firecrawl.Exceptions 以下に定義された特定の例外をスローします。

例外の階層:

ExceptionHTTPコード発生条件
AuthenticationException401APIキーが無効、または指定されていない
RateLimitException429リクエスト数が多すぎる
JobTimeoutException非同期ジョブ (クロール/バッチスクレイプ) が時間内に完了しなかった
FirecrawlExceptionvariesその他すべてのAPIエラーのベース例外

一時的な障害 (408、409、502、その他の5xxエラー) は、例外がスローされる前に指数バックオフを使用して自動的に再試行されます。

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