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

API リファレンス

認証、利用上限、主要 endpoint を実行単位で確認します。

API 概要
OpenAPI Inventory会社検索会社プロフィール会社の観測データ開示一覧開示詳細開示比較観測データ検索ソースAPIリストAPIリスト見積もりリスト候補確認リスト保存リストEnrichmentリストExport調査アイテムクレジット残高クレジット利用サマリーフィードバックAPI外部調査API
API リファレンス

GET /lists/candidates

estimate から保存前の candidate preview を取得する endpoint です。

このページの内容9項目
契約サマリーリクエストクエリパラメータ例レスポンス中心フィールド例エラー次に進む

GET /api/signal-foundry/lists/candidates は、estimate_id から保存前の候補 preview を返します。preview は無料ですが、saved List ではないため export できません。

契約サマリー

FieldValue
MethodGET
Path/api/signal-foundry/lists/candidates
Authproduction は API key 必須
Usagerequest usage に count
Credit消費しない
CLIsf list candidates --from-estimate <estimateId> --json

リクエスト

クエリパラメータ

ParamTypeNotes
estimate_idstringPOST /lists/estimate が返した id
limitnumberoptional。preview 件数

例

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/lists/candidates?estimate_id=est_123" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>"

CLI equivalent:

sf list candidates --from-estimate est_123 --json

レスポンス

中心フィールド

  • estimate.estimate_id
  • companies[]
  • companies[].company_id_hint
  • companies[].company_hint
  • companies[].reason
  • meta.candidate_preview_only
  • meta.exportable

例

{
  "estimate": {
    "estimate_id": "est_123",
    "definition_hash": "def_abc",
    "expires_at": "2026-05-01T12:00:00.000Z"
  },
  "companies": [
    {
      "company_id_hint": "jpx_7203",
      "company_hint": "Toyota Motor",
      "listing_status": "listed",
      "market_segment": "prime",
      "reason": "Matched revenue threshold and listed status"
    }
  ],
  "meta": {
    "candidate_preview_only": true,
    "exportable": false,
    "preview_is_free": true,
    "returned_companies": 1
  }
}

エラー

CodeHTTP復旧方法
estimate_not_found404POST /lists/estimate から再実行
invalid_query400estimate_id を付ける
preview_export_not_allowed400saved List にしてから export

次に進む

保存する場合は POST /lists/materialize に進みます。保存しない探索なら、この preview を見て query を修正します。

このページの内容

契約サマリーリクエストクエリパラメータ例レスポンス中心フィールド例エラー次に進む