GET /v1/companies/{code}/health · API Reference

Path parameters · 1

Variables interpolated into the URL path.

codestringrequired

Request headers · 1

Authentication.

Authorizationstringrequired

Production API key. Pass it as Bearer ax_live_…

Returns · 200

The standard { data, meta } envelope. data contains HealthScoreOut.

Envelope

dataHealthScoreOut

A single result object.

metaMeta

Pagination and request metadata, including request_id, data_as_of, and ontology_version.

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

HealthScoreOut

edinet_codestring

EDINET submitter code.

scoreinteger

Financial health score from 0 to 100. Higher is healthier.

componentsobject

Score breakdown by component (stability, profitability, cash_flow).

flagsstring[]

Risk flags (e.g. net_loss, negative_operating_cf).

industry_adjustmentnumber

Industry adjustment points (-5 to +5) vs sector medians.

fiscal_yearinteger

Fiscal year the score is based on.

computed_atstring · date-time

When the score was computed.

format date-time

data_sourcestring

Data provenance.

default EDINET (Financial Services Agency of Japan)

methodologystring

Human-readable summary of the scoring methodology.

default

Base 50 + stability (max 20) + profitability (max 20) + cash flow (max 10) + industry adjustment (±5). All inputs derived from audited XBRL filings.

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.

RequestcURL

curl "https://api.axiora.dev/v1/companies/6330/health" \
  -H "Authorization: Bearer ax_live_…"

Response · 200

200 OK

{
  "data": {
    "edinet_code": "…",
    "score": 0,
    "components": "…",
    "flags": [],
    "industry_adjustment": 0,
    "fiscal_year": 0,
    "computed_at": "…",
    "data_source": "EDINET (Financial Services Agency of Japan)"
    // …more fields
  },
  "meta": {
    "request_id": "req_abc123",
    "data_as_of": "2026-05-12T03:25:11Z",
    "ontology_version": "2.1.0",
    "as_of": "frz_01HRX9KQ2T8N7P4M"
  }
}

Response · 401

401 UNAUTHORIZED

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key. Pass it as `Authorization: Bearer ax_live_…`."
  }
}