Signal Foundry
ドキュメント
サポート 戻る
ドキュメントユースケースAPI リファレンスリリースノート

概要

Agent が迷わず使える順に整理しています。

はじめに
sf CLI をインストールクイックスタート会社IDの見方データの出所カバレッジとタグ
認証
認証設定APIキーのライフサイクル利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラー
請求
利用プラン利用量の計測クレジット表
CLI
CLI 概要CLI 認証基本コマンド会社検索求人検索会社・事例・観測・開示建設業許可検索ヘルプとエラーコマンドとフラグCLI 更新
トラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意クレジットと maxCredits の失敗
認証

レート制限とエラー

Signal Foundry API のレート制限と、代表的なエラーコードの見方をまとめます。

このページの内容2項目
よくあるエラー運用のコツ

API キー利用時には plan quota と request-based rate limit が適用されます。

現在の Company-first product quota は次です。

PlanSearchCompany CardDeep SignalRPMResult limit
Free1,000/day2,000/day200/day12050
Pro5,000/month10,000/month1,000/month300100

Credit Pack は credit 残高だけを増やします。plan quota、RPM、batch 上限、検索結果上限は増やしません。

上限を超えると 429 rate_limit_exceeded を返します。レスポンスには次が含まれます。

  • Retry-After ヘッダー
  • error.rate_limit.window
  • error.rate_limit.limit
  • error.rate_limit.remaining

よくあるエラー

Code意味
invalid_api_keyAPI キーが見つからない
api_key_revokedrevoke 済み
api_key_rotatedrotate 済みで新キーへ切り替え済み
api_key_expired有効期限切れ
account_scope_conflict利用範囲 の指定が衝突している
company_not_found指定した会社が解決できない
filing_not_found指定した filing が見つからない
compare_target_not_found比較先の filing が見つからない
daily_*_quota_exceeded / monthly_*_quota_exceededplan quota を超過した
credit_balance_insufficientcredit 残高が不足している

運用のコツ

  • smoke 用と本運用用でキーを分ける
  • エージェントごとにキーを分ける
  • 429 が出たら、まず同一キーの使い回しを疑う
  • quota error が出たら sf usage --json で残りと reset を確認する
  • credit error が出たら sf credits balance --json で残高を確認する

このエラーモデルは 現在の会社層 の 読み取り API を前提にしています。将来の別 product object では、追加の error code が増える可能性があります。

このページの内容

よくあるエラー運用のコツ