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

API リファレンス

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

API 概要
会社検索会社プロフィール会社の観測データ開示一覧開示詳細開示比較インポートAPIリストAPIリスト列追加リストExportクレジット残高クレジット利用サマリーフィードバックAPI
API リファレンス

POST /lists/{listId}/列

保存済みリストに列を追加する object-first endpoint です。

このページの内容9項目
契約サマリーリクエストEstimate実行レスポンスEstimate response実行 responseエラー次に進む

リスト列は、保存済みリストに employee_count、website_presence、website_url などの列 cell を追加する endpoint です。先に execute: false で estimate し、対象件数と クレジット上限を確認してから execute: true で実行に進みます。会社 universe を探す入口ではありません。

契約サマリー

FieldEstimateExecute
MethodPOSTPOST
Path/api/signal-foundry/lists/{listId}/columns/{columnKey}/api/signal-foundry/lists/{listId}/columns/{columnKey}
Authproduction は API key 必須production は API key 必須
Credit消費しないfound 行分
CLIsf list column add <listId> website_presence --estimate --jsonsf list column add <listId> website_presence --execute --max-credits <n> --json

リクエスト

Estimate

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/lists/00000000-0000-4000-8000-000000000000/columns/website_presence" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>" \
  -H "Content-Type: application/json" \
  --data '{
    "execute": false
  }'

CLI equivalent:

sf list column add 00000000-0000-4000-8000-000000000000 website_presence --estimate --json

実行

クレジットを使う書き込みです。execute: true、maxCredits、Idempotency-Key を付けます。

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/lists/00000000-0000-4000-8000-000000000000/columns/website_presence" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: list-column-20260511-001" \
  --data '{
    "execute": true,
    "maxCredits": 35
  }'

CLI equivalent:

sf list column add 00000000-0000-4000-8000-000000000000 website_presence --execute --max-credits 35 --json

レスポンス

Estimate response

中心フィールド:

  • column.column_key
  • estimate.total_rows
  • estimate.existing_found_rows
  • estimate.unknown_rows
  • estimate.target_rows
  • preview_rows
  • billing.estimated_max_credits
{
  "column": {
    "column_key": "website_presence"
  },
  "estimate": {
    "total_rows": 42,
    "existing_found_rows": 35,
    "unknown_rows": 7,
    "target_rows": 7
  },
  "preview_rows": [
    {
      "company_id": "jpx_7203",
      "predicted_status": "found",
      "value": true
    }
  ],
  "billing": {
    "charges_only_found": true,
    "estimated_max_credits": 0
  }
}

実行 response

中心フィールド:

  • run.run_id
  • run.found_count
  • run.not_found_count
  • run.no_data_count
  • run.skipped_count
  • billing.credits_used
  • billing.charges_only_found
  • written_columns[]
{
  "run": {
    "run_id": "run_123",
    "found_count": 35,
    "not_found_count": 3,
    "no_data_count": 2,
    "skipped_count": 2
  },
  "billing": {
    "charges_only_found": true,
    "credits_used": 35
  }
}

列実行では billing.charges_only_found が true になり、billing.credits_used は run.found_count を超えません。not_found / no_data / skipped 行は課金対象外です。

エラー

CodeHTTP復旧方法
list_not_found404listId を確認
max_credits_required400実行に maxCredits を付ける
max_credits_exceeded402estimate response の billing.estimated_max_credits 以上を指定する
credit_balance_insufficient402GET /credits/balance を確認

次に進む

列追加後に CSV が必要なら リスト Export に進みます。列条件で絞る場合は sf list filter <listId> --where "<condition>" --json を使います。

このページの内容

契約サマリーリクエストEstimate実行レスポンスEstimate response実行 responseエラー次に進む