Skip to main content
GET
List priced road segments

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.

Available options:
residential,
commercial,
production
area
enum<string>

Filter by area / land-value zone.

Available options:
I,
II,
III,
IV
ward_id
integer

Filter by ward identifier.

Example:

169

q
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
meta
object

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