Skip to main content
GET
Transaction-level records for one ward (Japan only)

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

country
enum<string>
required

Country code — jp only; anything else returns 400.

Available options:
jp
Example:

"jp"

wardId
integer
required

Ward ID, from the province wards endpoint.

Example:

3712

Query Parameters

property_type
enum<string>
default:land_building

Property category.

Available options:
land_building,
land_only
limit
integer
default:200

Transactions to return. The densest ward currently holds 1,328 transactions in a single tab, so the ceiling is set well above it.

Required range: 1 <= x <= 2000
offset
integer
default:0

Transactions to skip, for paging.

Required range: x >= 0
sort
enum<string>
default:unit_price_desc

Sort order.

Available options:
price_desc,
price_asc,
unit_price_desc,
unit_price_asc,
area_desc,
district_asc

Response

One page of transactions for the ward.

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

Transaction rows plus paging metadata. Note the nesting: the rows are at data.data, and data.meta is the route's own metadata, distinct from the envelope's meta.

meta
object

Response metadata. Always present; timestamp is the server time the response was generated.