Skip to main content
GET
/
openapi
/
v1
/
real-estate
/
{country}
Country real-estate summary
curl --request GET \
  --url https://api.hayinsights.com/openapi/v1/real-estate/{country} \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "statusCode": 200,
  "data": [],
  "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"

Response

Country summary rows (currently empty on staging).

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

Country-level summary rows (currently empty on staging).

​
meta
object

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