> ## 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. # List ward land-price summaries > Ward-level land-price summaries for a country — average residential prices across value-position tiers, min/max prices and road counts. Data is available for `vn`; `jp` is empty. ## OpenAPI ````yaml /openapi.yaml get /openapi/v1/real-estate/{country}/wards 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 and real-estate 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.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: >- Real-estate statistics, land prices, administrative geography (provinces / wards) and choropleth GeoJSON, by country. paths: /openapi/v1/real-estate/{country}/wards: get: tags: - Real Estate summary: List ward land-price summaries description: > Ward-level land-price summaries for a country — average residential prices across value-position tiers, min/max prices and road counts. Data is available for `vn`; `jp` is empty. operationId: realEstateWards parameters: - name: country in: path required: true description: Country code, lowercase. schema: type: string example: vn - name: lang in: query required: false description: | Language for localized names. | Value | Description | | --- | --- | | `vi` | Vietnamese | | `en` | English | schema: type: string enum: - vi - en default: vi responses: '200': description: List of ward land-price summaries. content: application/json: schema: $ref: '#/components/schemas/RealEstateWardsResponse' example: success: true statusCode: 200 data: - wardId: 1 wardName: Sài Gòn area: Khu vực I avgPriceResidentialVt1: 365020 avgPriceResidentialVt2: null avgPriceResidentialVt3: null avgPriceResidentialVt4: null minPriceResidential: 191200 maxPriceResidential: 687200 roadCount: 60 year: 2025 month: 1 unit: k_vnd meta: timestamp: '2026-06-19T08:54:29.621Z' '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: RealEstateWardsResponse: allOf: - $ref: '#/components/schemas/EnvelopeBase' - type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/RealEstateWard' 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' RealEstateWard: type: object description: > Ward-level land-price summary. The four `avgPriceResidentialVt1..4` fields are the average residential price for value-position tiers 1–4 (frontage → rear). Tiers that do not apply to a ward are `null`. required: - wardId - wardName - area - minPriceResidential - maxPriceResidential - roadCount - year - month - unit properties: wardId: type: integer description: Ward identifier — use as the `{wardId}` path param for ward detail. example: 1 wardName: type: string description: Ward name. example: Sài Gòn area: type: string description: Area / land-value zone label (localized). example: Khu vực I avgPriceResidentialVt1: type: - number - 'null' description: Average residential price, value-position tier 1. example: 365020 avgPriceResidentialVt2: type: - number - 'null' description: Average residential price, value-position tier 2. example: null avgPriceResidentialVt3: type: - number - 'null' description: Average residential price, value-position tier 3. example: null avgPriceResidentialVt4: type: - number - 'null' description: Average residential price, value-position tier 4. example: null minPriceResidential: type: - number - 'null' description: Minimum residential price observed in the ward. example: 191200 maxPriceResidential: type: - number - 'null' description: Maximum residential price observed in the ward. example: 687200 roadCount: type: integer description: Number of priced roads in the ward. example: 60 year: type: integer description: Year the price schedule applies to. example: 2025 month: type: integer description: Month the price schedule applies to. example: 1 unit: type: string description: Price unit. `k_vnd` means thousands of VND per square metre. example: k_vnd 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. ````