Query parameters · 5
Optional filters and modifiers. Pass as URL-encoded ?key=value.
Search query
Filter by section
Filter by fiscal year
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 TranslationSearchResult.
Envelope
Array of result objects.
Pagination and request metadata, including request_id, data_as_of, and ontology_version.
TranslationSearchResult
Filing section where the match was found.
Text snippet with matching terms highlighted.
EDINET submitter code of the matched company.
Company name in Japanese.
Fiscal year of the matched filing.
EDINET document ID of the matched filing.
PostgreSQL ts_rank relevance score. Higher means more relevant.
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.