List priced road segments - HayInsights Open API

{ "success": true, "statusCode": 200, "data": [ { "wardId": 169, "wardName": "Khu vực 1", "area": "Khu vực 1", "roadName": "Nhà Thờ", "segmentFrom": "Đầu đường", "segmentTo": "Cuối đường", "priceResidentialVt1": 702194, "priceResidentialVt2": 316389, "priceResidentialVt3": 229626, "priceResidentialVt4": 196388, "priceCommercialVt1": null, "priceCommercialVt2": null, "priceCommercialVt3": null, "priceCommercialVt4": null, "priceProductionVt1": null, "priceProductionVt2": null, "priceProductionVt3": null, "priceProductionVt4": null, "unit": "k_vnd", "year": 2026, "month": 1 } ], "meta": { "timestamp": "2026-06-19T08:54:29.621Z" } }

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"

Query Parameters

type

enum<string>

Filter by land-use type.

Value	Description
`residential`	Residential land
`commercial`	Commercial land
`production`	Production / industrial land

Available options:

residential,

commercial,

production

area

enum<string>

Filter by area / land-value zone.

Value	Description
`I`	Value zone I (highest)
`II`	Value zone II
`III`	Value zone III
`IV`	Value zone IV (lowest)

Available options:

I,

II,

III,

IV

ward_id

integer

Filter by ward identifier.

Example:

169

string

Free-text search on road / ward name.

Example:

"Hai Bà Trưng"

limit

integer

Maximum number of segments to return.

Example:

100

Response

List of priced road segments.

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

Show child attributes