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

概要

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

はじめに
Claude Code / Codex で始めるドキュメントマップsf CLI をインストールデータ・API・CLIの現況クイックスタートCLI 接続設定会社IDの見方初日の進め方Data Provenance
認証請求認証設定利用プランCLI
CLI 概要CLI 認証基本コマンド会社検索観測データ検索会社・観測・開示開示の表示・比較リスト・調査・クレジットヘルプとエラーコマンドとフラグCLI 更新
APIキーのライフサイクル利用量の計測提供中の機能
会社検索とプロフィール観測データ検索チームワークスペース会社の観測データ開示と比較APIキー管理UIリストワークスペース外部調査とクレジットSkills / CLI / API
Credit Schedule利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラートラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意credit と maxCredits の失敗estimate と materialize の失敗
概要

Company ID Surface Map

Signal Foundry の surface は `company_id` を中心につながっています。検索語から company を解決し、そのあとにどの endpoint / CLI command を使うかを整理します。

このページの内容6項目
まず company_id を解決するsurface 対応表何を受け取ったら次へ進むかよくある間違いClaude Code / Codex に教えるべきこと次に読むページ

Signal Foundry を使い始めるときに、最初に覚えるべきルールは 1 つです。

検索語をそのまま profile や filings に渡さず、必ず先に companies search で company_id を解決する。

この company_id が、以降の surface の共通キーです。

まず company_id を解決する

companies search は、次のような入力から canonical company 候補を返します。

  • 証券コード
  • 社名
  • 既知の識別子

CLI:

sf companies search 7203 --json
sf companies search トヨタ --listing-status listed --json

HTTP API:

curl -H 'x-api-key: <SIGNAL_FOUNDRY_API_KEY>' \
  'https://signal-foundry.app/api/signal-foundry/companies?q=7203&limit=3'

この結果で最低限保持したいのは次です。

  • company.company_id
  • company.display_name
  • query_match

surface 対応表

目的CLIHTTP API返るもの
会社候補を解決するsf companies search <query> --jsonGET /api/signal-foundry/companies?q=<query>company 候補、match 情報、簡易 profile
1 社の canonical profile を見るsf company profile <companyId> --jsonGET /api/signal-foundry/companies/{companyId}/profilecompany、identifiers、profile
1 社の観測を見るsf company observations <companyId> --jsonGET /api/signal-foundry/companies/{companyId}/observationsevidence 付き observations
1 社の filing 一覧を見るsf company filings <companyId> --jsonGET /api/signal-foundry/companies/{companyId}/filingsfiling 一覧
単一 filing の detail を見るsf filing show <companyId> <filingId> --jsonGET /api/signal-foundry/companies/{companyId}/filings/{filingId}metrics、sections、facts
filing を比較するsf filing compare <companyId> <filingId> --jsonGET /api/signal-foundry/companies/{companyId}/filings/{filingId}/compare直前 filing との差分

何を受け取ったら次へ進むか

companies search の次に見る値:

  • companies[0].company.company_id
  • companies[0].company.display_name
  • meta.returned_companies

company profile の次に見る値:

  • company.company_id
  • identifiers
  • profile.website_domain

company observations の次に見る値:

  • observations[].source
  • observations[].type
  • observations[].summary
  • observations[].evidence

company filings の次に見る値:

  • filings[].filing_id
  • filings[].document_type
  • filings[].submitted_at

よくある間違い

間違い:

sf company profile 7203 --json

推奨:

sf companies search 7203 --json
sf company profile jpx_7203 --json

profile や filings が受け取るのは検索語ではなく company_id です。検索語しか持っていない段階では、常に companies search から始めます。

Claude Code / Codex に教えるべきこと

agent に渡すときは、次の 3 点を明示してください。

  • company_id は先に解決する
  • 各コマンドは --json で実行する
  • 失敗時は error.hint と error.suggested_next_commands をそのまま次アクションに使う

この 3 つだけで、初回の詰まり方はかなり減ります。

次に読むページ

  • 実際の初日ループを見たい: First Day Playbook
  • agent にそのまま渡す prompt が欲しい: Claude Code / Codex で始める

このページの内容

まず company_id を解決するsurface 対応表何を受け取ったら次へ進むかよくある間違いClaude Code / Codex に教えるべきこと次に読むページ