Skip to main content
GET
Japan equity snapshot

Authorizations

X-API-Key
string
header
required

Your HayInsights API key (prefixed apk_). Create and manage keys in the HayInsights dashboard (Account → API keys).

Send it in the X-API-Key header on every request to /openapi/v1/*. Which data domains you may access and your request quota are both governed by the subscription plan attached to the key — see the Plans & features and Rate limits guides.

Path Parameters

market
enum<string>
required

Market code. Only jp (Tokyo Stock Exchange) is supported for now.

Available options:
jp
Example:

"jp"

code
string
required

Stock code — the 4-character ticker (7203) or the 5-character J-Quants code (72030).

Example:

"7203"

Response

Snapshot of the requested stock.

Standard success envelope shared by every endpoint. Each operation's response wrapper extends this (via allOf) and adds a typed data property.

success
boolean
required

Always true for a successful response.

Example:

true

statusCode
integer
required

Mirrors the HTTP status code.

Example:

200

data
object
required

End-of-day snapshot of one Japanese equity. All numbers are raw, in their native unit (JPY, shares, %). A block with no data is null (or an empty array), never an error.

meta
object

Response metadata for the Equities domain. On top of timestamp, every equities response says where the numbers came from and how fresh they are.