List provinces
Provinces / cities available for real-estate queries in a country. Data is
available for vn; jp is empty.
Authorizations
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 code, lowercase.
"vn"
Query Parameters
Language for localized names.
| Value | Description |
|---|---|
vi | Vietnamese |
en | English |
vi, en Response
List of provinces / cities.
Standard success envelope shared by every endpoint. Each operation's response
wrapper extends this (via allOf) and adds a typed data property.