> ## Documentation Index > Fetch the complete documentation index at: https://developer.hayinsights.com/llms.txt > Use this file to discover all available pages before exploring further. # Transaction-level records for one ward (Japan only) > Each row is a single real transaction published by MLIT — distinct from the land-prices endpoint, which aggregates a neighbourhood into median / p25 / p75. Covers every quarter held, and drops transactions whose source records area only as a bound (e.g. "2000㎡以上"). Residential land only (住宅地). Japan only: any other `country` returns `400`. ## OpenAPI ````yaml /openapi.yaml get /openapi/v1/real-estate/{country}/wards/{wardId}/transactions openapi: 3.1.0 info: title: HayInsights Open API version: 0.1.0 description: > Programmatic access to the **HayInsights** financial-data hub — commodities, crypto, ETF, FX, macroeconomic, real-estate, news, economic-calendar and market-index datasets, served from a single API surface under `/openapi/v1/*`. This specification is the **single source of truth** for the public API surface — shared by SDK codegen, the reference docs, and (later) the mock server / contract tests. ## Authentication Every request must carry your API key in the `X-API-Key` header. There is a single authentication tier — no request signing. Create and manage keys in the HayInsights dashboard (Account → API keys). See **Authentication**. ## Plans & quota Access to each data domain and your request quota are governed by the subscription plan attached to your key. Each endpoint consumes a **weighted** amount of your per-minute quota; every response carries `X-RateLimit-*` headers. See **Rate limits** and **Plans & features**. contact: {} servers: - url: https://api-v2.hayinsights.com description: Production security: - HayInsightsApiKey: [] tags: - name: Commodities description: >- Spot prices, top movers, gold–DXY correlation and historical series for energy, metals and agricultural commodities. - name: Crypto description: >- Crypto market overview, dominance, bubble map, on-chain and derivatives metrics. - name: ETF description: >- Exchange-traded fund listings, performance & net-flow rankings, heatmap, holdings, NAV growth and fund composition. - name: FX description: >- Foreign-exchange summary, live table, 90-day correlation matrix and the emerging-market stress monitor. - name: Macro description: >- Macroeconomic indicators — GDP, CPI/PCE, exchange rates, population, central-government debt and policy rates / bond yields. - name: Real Estate description: >- Land prices, transaction-level records, administrative geography (provinces / wards) and choropleth GeoJSON, by country. - name: News description: >- Market news headlines with per-article sentiment, plus an aggregate sentiment reading over a rolling window. - name: Calendar description: >- Economic calendar — rate decisions, CPI and GDP releases, market holidays and asset-level events. - name: Market description: >- Index snapshots and global index closes — levels and daily moves for S&P 500, Nasdaq, Nikkei, VN-Index and others. paths: /openapi/v1/real-estate/{country}/wards/{wardId}/transactions: get: tags: - Real Estate summary: Transaction-level records for one ward (Japan only) description: > Each row is a single real transaction published by MLIT — distinct from the land-prices endpoint, which aggregates a neighbourhood into median / p25 / p75. Covers every quarter held, and drops transactions whose source records area only as a bound (e.g. "2000㎡以上"). Residential land only (住宅地). Japan only: any other `country` returns `400`. operationId: realEstateWardTransactions parameters: - name: country in: path required: true description: Country code — `jp` only; anything else returns `400`. schema: type: string enum: - jp example: jp - name: wardId in: path required: true description: Ward ID, from the province wards endpoint. schema: type: integer example: 3712 - name: property_type in: query required: false description: | Property category. | Value | Description | | --- | --- | | `land_building` | 宅地(土地と建物) — land with buildings | | `land_only` | 宅地(土地) — land only | schema: type: string enum: - land_building - land_only default: land_building - name: limit in: query required: false description: > Transactions to return. The densest ward currently holds 1,328 transactions in a single tab, so the ceiling is set well above it. schema: type: integer minimum: 1 maximum: 2000 default: 200 - name: offset in: query required: false description: Transactions to skip, for paging. schema: type: integer minimum: 0 default: 0 - name: sort in: query required: false description: | Sort order. | Value | Description | | --- | --- | | `unit_price_desc` | Unit price, highest first | | `unit_price_asc` | Unit price, lowest first | | `price_desc` | Total price, highest first | | `price_asc` | Total price, lowest first | | `area_desc` | Area, largest first | | `district_asc` | Neighbourhood name, A–Z | schema: type: string enum: - price_desc - price_asc - unit_price_desc - unit_price_asc - area_desc - district_asc default: unit_price_desc responses: '200': description: One page of transactions for the ward. content: application/json: schema: $ref: '#/components/schemas/RealEstateJpTransactionsResponse' example: success: true statusCode: 200 data: data: - districtName: 日ノ出町 districtNameEn: Hinodecho nearestStation: 北千住 nearestStationEn: Kita-senju nearestStationMin: 9 tradePriceJpy: 260000000 areaM2: 95 areaIsLowerBound: false pricePerM2Jpy: 2736842.11 priceYear: 2025 priceQuarter: 3 meta: total: 974 propertyType: land_building unit: jpy_m2 meta: timestamp: '2026-09-16T07:25:57.670Z' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: schemas: RealEstateJpTransactionsResponse: allOf: - $ref: '#/components/schemas/EnvelopeBase' - type: object required: - data properties: data: type: object description: > 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`. required: - data - meta properties: data: type: array items: $ref: '#/components/schemas/RealEstateJpTransaction' meta: type: object required: - total - propertyType - unit properties: total: type: integer description: >- Transactions matching the ward and property type, across all pages. example: 1328 propertyType: type: string enum: - land_building - land_only example: land_building unit: type: string enum: - jpy_m2 example: jpy_m2 EnvelopeBase: type: object description: > Standard success envelope shared by every endpoint. Each operation's response wrapper extends this (via `allOf`) and adds a typed `data` property. required: - success - statusCode properties: success: type: boolean const: true description: Always `true` for a successful response. example: true statusCode: type: integer description: Mirrors the HTTP status code. example: 200 meta: $ref: '#/components/schemas/Meta' RealEstateJpTransaction: type: object description: > One real transaction as published by MLIT. Unlike the land-price endpoint — which aggregates a neighbourhood into median / p25 / p75 — each row here is a single sale. Residential land only (住宅地). required: - tradePriceJpy - areaM2 - areaIsLowerBound - pricePerM2Jpy - priceYear - priceQuarter properties: districtName: type: - string - 'null' description: 地区名 — neighbourhood name, as published. example: 日ノ出町 districtNameEn: type: - string - 'null' description: Romaji transcription of `districtName`. example: Hinodecho nearestStation: type: - string - 'null' description: 最寄駅 — nearest station, as published. example: 北千住 nearestStationEn: type: - string - 'null' example: Kita-senju nearestStationMin: type: - integer - 'null' description: Walking minutes to the nearest station. example: 9 tradePriceJpy: type: number description: 取引価格（総額） — total transaction price, JPY. example: 260000000 areaM2: type: number description: 面積（㎡） — area in m². example: 95 areaIsLowerBound: type: boolean description: > `true` when the source recorded the area as a bound such as "2000㎡以上", making `areaM2` a lower bound rather than an exact figure. example: false pricePerM2Jpy: type: number description: Unit price, derived as `tradePriceJpy / areaM2`. example: 2736842.11 priceYear: type: integer example: 2025 priceQuarter: type: integer minimum: 1 maximum: 4 example: 3 ErrorBody: type: object description: Standard error envelope returned for every 4xx / 5xx response. required: - success - statusCode - error properties: success: type: boolean const: false description: Always `false` for an error response. example: false statusCode: type: integer description: Mirrors the HTTP status code. example: 401 error: $ref: '#/components/schemas/ErrorDetail' meta: $ref: '#/components/schemas/Meta' Meta: type: object description: >- Response metadata. Always present; `timestamp` is the server time the response was generated. required: - timestamp properties: timestamp: type: string format: date-time description: Server time when the response was generated (ISO 8601). example: '2026-06-19T08:31:59.478Z' additionalProperties: true ErrorDetail: type: object description: Error detail object carried under `error` in the error envelope. required: - code - message properties: code: type: string description: > Machine-readable error code. Specific for authentication / quota errors (e.g. `API_KEY_REQUIRED`, `API_KEY_INVALID`, `FEATURE_NOT_IN_PLAN`, `RATE_LIMIT_EXCEEDED`). For validation (400) and not-found (404) the code is currently `INTERNAL_ERROR` and the HTTP status carries the semantics. example: API_KEY_INVALID message: description: Human-readable message, or a list of validation messages (400). oneOf: - type: string - type: array items: type: string example: Invalid API key responses: BadRequest: description: >- Invalid or missing parameter — bad enum, range, format, or a missing required query parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 400 error: code: INTERNAL_ERROR message: - >- Invalid type parameter. Must be "gdp", "cpi", "pce", or "import-export" - Type parameter is required meta: error: Bad Request statusCode: 400 timestamp: '2026-06-19T08:34:08.081Z' Unauthorized: description: >- Missing, invalid, disabled or expired API key. Send a valid key in the `X-API-Key` header. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 401 error: code: API_KEY_INVALID message: Invalid API key meta: timestamp: '2026-06-19T08:34:08.023Z' Forbidden: description: >- Your subscription plan does not include this data feature, or your key's scope denies it. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 403 error: code: FEATURE_NOT_IN_PLAN message: Your plan does not include this feature meta: timestamp: '2026-06-19T08:34:08.100Z' NotFound: description: The requested resource was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 404 error: code: INTERNAL_ERROR message: Commodity 'zzz-nope' not found meta: error: Not Found statusCode: 404 timestamp: '2026-06-19T08:34:08.205Z' RateLimited: description: > Rate limit exceeded — you have consumed your plan's per-minute weight budget. Wait until `X-RateLimit-Reset` (or `Retry-After` seconds) then retry. headers: X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' X-RateLimit-Weight-Used: $ref: '#/components/headers/XRateLimitWeightUsed' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 429 error: code: RATE_LIMIT_EXCEEDED message: Rate limit exceeded meta: timestamp: '2026-06-19T08:34:09.000Z' InternalError: description: Unexpected server error. Retry after a short exponential backoff. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 500 error: code: INTERNAL_ERROR message: Internal server error meta: timestamp: '2026-06-19T08:34:10.000Z' headers: XRateLimitLimit: description: Your plan's request-weight budget per 1-minute window. schema: type: integer example: 1000 XRateLimitRemaining: description: Remaining request weight in the current 1-minute window. schema: type: integer example: 997 XRateLimitReset: description: Unix timestamp (seconds) when the current rate-limit window resets. schema: type: integer format: int64 example: 1781857979 XRateLimitWeightUsed: description: Request weight consumed by this call (see each endpoint's weight). schema: type: integer example: 3 RetryAfter: description: Seconds to wait before retrying. Present on 429 responses. schema: type: integer example: 30 securitySchemes: HayInsightsApiKey: type: apiKey in: header name: X-API-Key description: > 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. ````