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

API リファレンス

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

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

GET /companies/{companyId}/filings/{filingId}/compare

summary metrics と sections を比較する contract を説明します。

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

GET /api/signal-foundry/companies/{companyId}/filings/{filingId}/compare は、対象 filing と比較先 filing を並べて返します。

契約サマリー

FieldValue
MethodGET
Path/api/signal-foundry/companies/{companyId}/filings/{filingId}/compare
Authproduction は API key 必須
Usagerequest usage / rate limit 対象
Creditdata credit は消費しない
CLIsf filing compare <companyId> <filingId> --json
Nextchanged section / metric を調査メモへ落とす

この endpoint の job は、同一 company 内の 2 つの filing を比較することです。競合 company 同士を比較する endpoint ではありません。比較対象が自動解決できない場合は、against を明示します。

リクエスト

HTTP

curl "https://signal-foundry.app/api/signal-foundry/companies/jpx_5574/filings/edinet_fil_S100XYUO/compare?summary_metric=revenue,net_income&section_key=business_risks" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>"

CLI

sf filing compare jpx_5574 edinet_fil_S100XYUO \
  --summary-metric revenue,net_income \
  --section-key business_risks \
  --json

比較先を明示する場合:

sf filing compare jpx_5574 edinet_fil_S100XYUO \
  --against edinet_fil_S100PREV \
  --json

見る key:

  • filings.current.filing_id
  • filings.against.filing_id
  • compare.summary_metrics
  • compare.sections
  • compare.summary_metrics.<metric>.status
  • compare.sections.<section_key>.status
  • meta.compared_against
  • meta.returned_section_keys

クエリパラメータ

ParamTypeDefaultNotes
againststringauto明示しない場合は previous_comparable_filing を使う
summary_metricarray[]revenue / operating_income / ordinary_income / profit_before_tax / net_income / total_assets / net_assets / employee_count
section_keyarray[]business_risks / strategy / event_details / report_contents
include_section_contentbooleantruefalse で本文省略

レスポンス

中心フィールド

  • company
  • filings
    • current
    • against
  • compare.summary_metrics
    • current
    • previous
    • delta_value
    • delta_ratio
    • status
  • compare.sections
    • current
    • previous
    • status
  • meta
    • compared_against
    • requested_against_identifier
    • resolved_against_by
    • resolved_filing_by

status は metric / section ごとに次を返します。

  • updated
  • unchanged
  • added
  • removed
  • unavailable

例

{
  "company": {
    "company_id": "jpx_5574",
    "display_name": "ABEJA, Inc."
  },
  "filings": {
    "current": {
      "filing_id": "edinet_fil_S100XYUO",
      "doc_id": "S100XYUO",
      "document_type": "annual_report",
      "period_end": "2025-08-31"
    },
    "against": {
      "filing_id": "edinet_fil_S100PREV",
      "doc_id": "S100PREV",
      "document_type": "annual_report",
      "period_end": "2024-08-31"
    }
  },
  "compare": {
    "summary_metrics": {
      "revenue": {
        "current": {
          "value": 1234567890,
          "unit": "JPY"
        },
        "previous": {
          "value": 1111111111,
          "unit": "JPY"
        },
        "delta_value": 123456779,
        "delta_ratio": 0.111111101,
        "status": "updated"
      }
    },
    "sections": {
      "business_risks": {
        "current": {
          "section_key": "business_risks",
          "section_title": "事業等のリスク"
        },
        "previous": {
          "section_key": "business_risks",
          "section_title": "事業等のリスク"
        },
        "status": "updated"
      }
    }
  },
  "meta": {
    "compared_against": "previous_comparable_filing",
    "current_filing_id": "edinet_fil_S100XYUO",
    "requested_against_identifier": null,
    "resolved_filing_by": {
      "field": "filing_id",
      "value": "edinet_fil_S100XYUO"
    },
    "resolved_against_by": {
      "field": "filing_id",
      "value": "edinet_fil_S100PREV"
    },
    "returned_section_keys": ["business_risks"]
  }
}

エラー

StatusCodeMeaning
400invalid_queryquery parameter が schema に合わない
401invalid_api_key などAPI key が無効、失効、または revoke 済み
404company_not_found{companyId} を canonical company に解決できない
404filing_not_foundcurrent filing を同一 company 内で解決できない
404compare_target_not_found比較先 filing を自動または against で解決できない
429rate_limit_exceededAPI key の rate limit を超えた

compare_target_not_found の例

{
  "error": {
    "code": "compare_target_not_found",
    "message": "No automatic comparable filing was found for the requested filing",
    "hint": "Inspect the company filings list and rerun compare with an explicit against filing id.",
    "suggested_next_commands": [
      "sf company filings jpx_5574 --json",
      "sf filing compare jpx_5574 edinet_fil_S100XYUO --against <filingId> --json"
    ]
  }
}

復旧方法

compare_target_not_found が返る場合:

  1. sf company filings <companyId> --limit 10 --json を実行します。
  2. filings[].filing_id, filings[].document_type, filings[].period_end を確認します。
  3. 必要なら sf filing show <companyId> <filingId> --json で artifact / facts の状態を確認します。
  4. 比較したい filing を選び、--against <filingId> を付けて再実行します。

filing_not_found が返る場合:

  1. sf company filings <companyId> --json に戻ります。
  2. current filing の filing_id または doc_id を取り直します。
  3. 同じ company 内の filing だけを compare に渡してください。

section 本文が重い場合は、include_section_content=false を付けます。差分の有無だけを見る場合は、compare.sections.<section_key>.status と compare.summary_metrics.<metric>.status を先に確認してください。

次に進む先

  • filing の facts / sections を読む: GET /companies/{companyId}/filings/{filingId}
  • filing 候補を選び直す: GET /companies/{companyId}/filings

このページの内容

契約サマリーリクエストHTTPCLIクエリパラメータレスポンス中心フィールド例エラーcompare_target_not_found の例復旧方法次に進む先