Skip to main content
GET
Japan related equities

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"

Query Parameters

limit
integer
default:6

Maximum number of peers to return.

Required range: 1 <= x <= 12

Response

Peers 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

Peers in the same TSE 33-sector (common shares on Prime / Standard / Growth), largest market cap first. When the sector has fewer stocks than limit, peers from the same market segment fill the list and basis becomes sector33_segment.

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.