> ## 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. # Representative land price per province > One row per province: dot coordinates, average / minimum / maximum price and the number of wards carrying data. Intended for drawing a single dot per province at low zoom, before loading ward-level GeoJSON. Pass `country=all` to get Vietnam and Japan in one request. `meta.byCountry` holds the colour thresholds per country. ## OpenAPI ````yaml /openapi.yaml get /openapi/v1/real-estate/{country}/provinces/prices 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}/provinces/prices: get: tags: - Real Estate summary: Representative land price per province description: > One row per province: dot coordinates, average / minimum / maximum price and the number of wards carrying data. Intended for drawing a single dot per province at low zoom, before loading ward-level GeoJSON. Pass `country=all` to get Vietnam and Japan in one request. `meta.byCountry` holds the colour thresholds per country. operationId: realEstateProvincePrices parameters: - name: country in: path required: true description: | Country code, or `all` to combine every country. | Value | Description | | --- | --- | | `all` | Vietnam and Japan together | | `vn` | Vietnam | | `jp` | Japan | schema: type: string enum: - all - vn - jp example: all - name: lang in: query required: false description: | Language for name fields. | Value | Description | | --- | --- | | `vi` | Vietnamese | | `en` | English | schema: type: string enum: - vi - en default: vi responses: '200': description: Representative price per province. content: application/json: schema: $ref: '#/components/schemas/RealEstateProvincePricesResponse' example: success: true statusCode: 200 data: data: - id: 5 name: Cần Thơ code: CT country: vn lat: 9.79771 lon: 105.740847 bbox: - 105.289632 - 9.297885 - 106.223075 - 10.291719 outline: null avgPrice: 3184.52 minPrice: 700 maxPrice: 27000 wardCount: 83 unit: k_vnd latestYear: 2026 meta: byCountry: vn: unit: k_vnd bands: - 2692.37 - 4495.92 - 7982.4 - 23159.38 bandMethod: percentile usdRate: 0.00003966381630640323 latestYear: 2026 meta: timestamp: '2026-09-16T07:25:17.048Z' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: schemas: RealEstateProvincePricesResponse: allOf: - $ref: '#/components/schemas/EnvelopeBase' - type: object required: - data properties: data: type: object description: > Province rows plus the per-country colour thresholds. 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/RealEstateProvincePrice' meta: type: object required: - byCountry properties: byCountry: type: object description: Keyed by lowercase country code. additionalProperties: $ref: >- #/components/schemas/RealEstateProvincePriceCountryMeta 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' RealEstateProvincePrice: type: object description: > One province-level dot for a low-zoom map: coordinates plus a representative price. Deliberately carries no ward geometry — a single province's GeoJSON runs to several megabytes, which is a lot to download just to draw one dot. required: - id - name - code - country - wardCount - unit properties: id: type: integer example: 1 name: type: string example: Hồ Chí Minh code: type: string example: HCM country: type: string description: Lowercase country code — picks the colour scale and price format. example: vn lat: type: - number - 'null' description: > Representative dot — the mean ward lat/lon, falling back to the centre of the boundary bbox. `null` when the province has neither. example: 10.7412 lon: type: - number - 'null' example: 106.7215 bbox: type: - array - 'null' description: Bounding box `[minLon, minLat, maxLon, maxLat]`. items: type: number minItems: 4 maxItems: 4 example: - 106.415837 - 8.67851 - 107.531438 - 10.737193 outline: type: - array - 'null' description: > Province boundary as MultiPolygon coordinates (`[lon, lat]`), **heavily simplified** for low-zoom drawing. Not for spatial computation — use the per-province GeoJSON endpoint when exact geometry matters. items: type: array items: type: array items: type: array items: type: number avgPrice: type: - number - 'null' description: >- Representative average price, in `unit`. `null` when no price data exists. example: 53811.68 minPrice: type: - number - 'null' example: 1300 maxPrice: type: - number - 'null' example: 687200 wardCount: type: integer description: Wards carrying price data — the denominator behind `avgPrice`. example: 168 unit: type: string enum: - k_vnd - jpy_m2 description: '`k_vnd` for Vietnam, `jpy_m2` for Japan.' example: k_vnd latestYear: type: - integer - 'null' example: 2025 RealEstateProvincePriceCountryMeta: type: object description: > Colour thresholds and unit for one country. These live in `meta` rather than on each province because a threshold is a property of the country, not the province. required: - unit - bands - bandMethod properties: unit: type: string enum: - k_vnd - jpy_m2 example: jpy_m2 bands: type: - array - 'null' description: > Percentile colour thresholds. `null` for Vietnam, where the client falls back to its own fixed bands. items: type: number example: - 120000 - 240000 - 410000 - 780000 bandMethod: type: - string - 'null' enum: - percentile - null example: percentile usdRate: type: - number - 'null' description: >- USD value of one unit of local currency at the data period; `null` when no FX is available. example: 0.0000068 latestYear: type: - integer - 'null' example: 2025 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' 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. ````