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

API リファレンス

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

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

GET /companies

会社検索と lightweight listing の contract を説明します。

このページの内容7項目
契約サマリーリクエストクエリパラメータMatching behaviorレスポンスCLI equivalent復旧方法

GET /api/signal-foundry/companies は、最初の入口です。自由入力をそのまま downstream endpoint に渡すのではなく、まずここで company_id を解決してください。

契約サマリー

FieldValue
MethodGET
Path/api/signal-foundry/companies
Authproduction は API key 必須
Usagerequest usage と heavy usage に count
Creditdata credit は消費しない
CLIsf companies search <query> --json
Nextprofile / observations / filings へ進む

この endpoint の job は、社名、証券コード、法人番号、domain などの入力から canonical company_id 候補を返すことです。profile / observations / filings へは、ここで選んだ company.company_id を渡してください。

リクエスト

curl -s \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>" \
  "https://signal-foundry.app/api/signal-foundry/companies?q=7203&limit=3"

クエリパラメータ

ParamTypeDefaultNotes
qstringnullidentifier exact / company_id exact / 正規化社名 exact / prefix を優先する検索
has_websitebooleannulltrue / false
industry_33_codearray[]JPX 33 業種コード。repeated または comma-separated
listing_statusarray[]listed / delisted / unknown
market_segmentarray[]repeated または comma-separated
limitinteger201..100
offsetinteger00..10000

Matching behavior

この endpoint は単純な全文検索ではありません。次の順で company candidate を集めます。

  • identifier exact match
  • company_id exact match
  • normalized name exact match
  • normalized name prefix match

さらに relevance を付けて並べ替えます。identifier_matched=true の結果は強く優先され、上場会社は軽く boost されます。

レスポンス

まず見る key:

  • companies[].company.company_id
  • companies[].company.display_name
  • companies[].profile.website_domain
  • companies[].query_match.identifier_matched
  • companies[].query_match.relevance
  • meta.returned_companies
  • meta.has_more
{
  "companies": [
    {
      "company": {
        "company_id": "jpx_7203",
        "display_name": "トヨタ自動車",
        "legal_name": "トヨタ自動車株式会社",
        "listing_status": "listed",
        "market_segment": "prime"
      },
      "profile": {
        "website_domain": "global.toyota",
        "website_url": "https://global.toyota",
        "latest_observed_at": "2026-04-30T00:00:00.000Z",
        "observation_counts": {},
        "technologies": []
      },
      "query_match": {
        "identifier_matched": true,
        "relevance": 120
      }
    }
  ],
  "meta": {
    "query": "7203",
    "returned_companies": 1,
    "matched_companies": 1,
    "has_more": false
  }
}

この HTTP response では、候補会社は companies[] に入り、canonical ID は companies[].company.company_id、表示名は companies[].company.display_name で確認します。

CLI equivalent

sf companies search "7203" --json

CLI でも見る key は同じです。

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

復旧方法

状態復旧
400 invalid_querylimit / offset / array filter を schema に合わせる
401 invalid_api_keyAPI key を再発行し、CLI なら sf auth setup をやり直す
429 rate_limit_exceededRetry-After まで待つ。companies は heavy usage にも count される
0 件長い自然文を社名、証券コード、法人番号、domain のどれかに分解する
候補が多いlisting_status / market_segment / industry_33_code / has_website で絞る

0 件を「会社が存在しない」と断定しないでください。まず query を短くし、sf companies search <query> --json で候補の company_id を確認してから、profile / observations / filings に進みます。

このページの内容

契約サマリーリクエストクエリパラメータMatching behaviorレスポンスCLI equivalent復旧方法