GET/v1/shareholdings/{shareholding_id}/auditプラン · Institutional

Get Shareholding Audit

Full audit bundle for a single shareholding row.

Returns the row's classification with the full provenance chain: real-time view (knowable at filing time), retrospective view (revealed by later evidence on the same filer × issuer pair), confidence + alternative for both, the source filing reference, and a stable classifier version stamp consumers can pin to.

To freeze a response: capture meta.as_of from one call, then pass it back as ?as_of=<token> on later calls: you'll get the same answer regardless of how the data has evolved. Two calls that share the same as_of are guaranteed bit-identical.

パスパラメータ · 1

URLパスに展開される変数。

shareholding_idinteger必須

Row id from /companies/{code}/shareholdings.

クエリパラメータ · 1

任意のフィルターと修飾子。URLエンコードした ?key=value で渡します。

as_ofstring | null任意

Freeze the response to a specific point in time. Pass a value previously returned in meta.as_of to replay the exact same answer. Omit for the live view.

リクエストヘッダー · 1

認証ヘッダー。

Authorizationstring必須

本番用のAPIキー。次の形式で渡します: Bearer ax_live_…

返り値 · 200

標準の { data, meta } エンベロープ。 data は ShareholdingAuditOut 型です。

エンベロープ

dataShareholdingAuditOut

単一の結果オブジェクト。

metaMeta

ページネーションとリクエストメタデータ。request_iddata_as_ofontology_version を含みます。

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

ShareholdingAuditOut

shareholding_idinteger

Row identifier.

sourceobject

Filing reference. Includes doc_id (EDINET), filer EDINET code, issuer security code, and base_date. Every claim in this bundle traces to this filing.

realtimeobject

What was knowable at filing time. Includes predicted_category (= holding_purpose_category), confidence, alternative_label + probability, validated, as_of_date (= source.base_date).

retrospectiveobject | null

What later evidence revealed. Same shape as realtime but predicted_category may differ when later filings from the same filer × issuer disclosed a more-active intent. evidence_cutoff_date marks the latest filing used. Null when no later evidence existed.

classifier_versionstring | null

Opaque label for the classifier configuration applied to this row.

エラー

標準のHTTPステータスコードに加え、{ error: { code, message } } エンベロープ内で型付きの error.code を返します。

すべてのエンドポイントは共通の型付きエラーエンベロープ({ error: { code, message } })を返します。 全コードの一覧はエラーリファレンスを参照してください。