Path parameters · 1
Variables interpolated into the URL path.
Query parameters · 1
Optional filters and modifiers. Pass as URL-encoded ?key=value.
Request headers · 1
Authentication.
Production API key. Pass it as Bearer ax_live_…
Returns · 200
The standard { data, meta } envelope. data contains an array of PeerOut.
Envelope
Array of result objects.
Pagination and request metadata, including request_id, data_as_of, and ontology_version.
PeerOut
Peer company details.
Fiscal year of the peer data.
Revenue in JPY.
Net income in JPY.
Return on equity for this fiscal year, expressed as a decimal (0.124 = 12.4%). Null when underlying inputs are unavailable.
Financial-health composite (0-100). See the health-score documentation for the published methodology. Null when not yet available for this period.
Errors
Standard HTTP status codes plus a typed error.code in the { error: { code, message } } envelope.
Every endpoint returns the same typed error envelope ({ error: { code, message } }). For the full list of codes, see the Errors reference.