Skip to main content
GET
/
openapi
/
v1
/
real-estate
/
{country}
/
wards
/
{wardId}
Ward land-price detail
curl --request GET \
  --url https://api.hayinsights.com/openapi/v1/real-estate/{country}/wards/{wardId} \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "statusCode": 200,
  "data": {
    "wardId": 1,
    "wardName": "Sài Gòn",
    "area": "Khu vực I",
    "summary": {
      "avgPriceResidentialVt1": 365020,
      "avgPriceResidentialVt2": null,
      "avgPriceResidentialVt3": null,
      "avgPriceResidentialVt4": null,
      "minPriceResidential": 191200,
      "maxPriceResidential": 687200,
      "roadCount": "60",
      "year": 2025,
      "month": 1,
      "unit": "k_vnd"
    },
    "roads": [
      {
        "roadName": "NGUYỄN HUỆ",
        "segmentFrom": "TRỌN ĐƯỜNG",
        "segmentTo": null,
        "priceResidentialVt1": 687200,
        "priceResidentialVt2": null,
        "priceResidentialVt3": null,
        "priceResidentialVt4": null,
        "priceCommercialVt1": 481000,
        "priceProductionVt1": 412300
      }
    ]
  },
  "meta": {
    "timestamp": "2026-06-19T08:54:29.812Z"
  }
}

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
string
required

Country code, lowercase.

Example:

"vn"

​
wardId
integer
required

Ward identifier.

Example:

1

Response

Land-price detail for a single 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

Full land-price detail for a single ward — an aggregate summary plus the list of priced roads. The Vt1..4 suffixes denote value-position tiers (frontage → rear); tiers that do not apply are null.

​
meta
object

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