# /28hse/indices

`POST /api/28hse/indices`

Price: 10 credits

Get the Eva Property Index (易發樓價指數, EPI) and the Eva Rental Index (易發租金指數, ERI) — the weekly Hong Kong secondary residential price and rent benchmarks that 28Hse publishes together with the University of Hong Kong, computed from Land Registry deals and market reporting. Returns the current level of both indices with their week-on-week and month-on-month changes, the release note naming the publication date and the contract-signing window the reading covers, the four sub-indices for Hong Kong Island, Kowloon, New Territories East and New Territories West for prices and for rents with their own weekly and monthly changes, the full monthly history of both indices back to 2010, and the constituent estates of each regional index with their current price per saleable square foot and estate ids.

## How to use it

Get the Hong Kong Eva Property Index and Eva Rental Index published weekly by 28Hse with HKU. No arguments beyond site and lang. The same reading is served by both sites, so site only picks the language edition. Values are index points; constituent estate prices are HKD per saleable square foot and carry estate_id for 28hse/estates.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `site` (string) — Which Hong Kong portal to read. Both run on the same platform but hold different listing inventories: 28hse is the larger Chinese-first marketplace, squarefoot is the English-first one. (default: "28hse"; one of: "28hse", "squarefoot")
- `lang` (string) — Language of names, addresses and descriptions. It also changes which listings exist: some categories are only published in the Chinese editions. (default: "tc"; one of: "tc", "cn", "en")

## Response

### 200 — Successful Response

- `@type` (string) (default: "Hse28MarketIndex")
- `property_index` (number, nullable)
- `property_index_week_change_percent` (number, nullable)
- `property_index_month_change_percent` (number, nullable)
- `rental_index` (number, nullable)
- `rental_index_week_change_percent` (number, nullable)
- `rental_index_month_change_percent` (number, nullable)
- `release_note` (string, nullable)
- `district_property_indices` (array) (default: [])
  - `@type` (string) (default: "Hse28RegionIndex")
  - `region` (string, required)
  - `region_name` (string, nullable)
  - `value` (number, nullable)
  - `week_change_percent` (number, nullable)
  - `month_change_percent` (number, nullable)
- `district_rental_indices` (array) (default: [])
  - `@type` (string) (default: "Hse28RegionIndex")
  - `region` (string, required)
  - `region_name` (string, nullable)
  - `value` (number, nullable)
  - `week_change_percent` (number, nullable)
  - `month_change_percent` (number, nullable)
- `property_index_history` (array) (default: [])
  - `@type` (string) (default: "Hse28IndexPoint")
  - `date_at` (integer, required)
  - `value` (number, required)
- `rental_index_history` (array) (default: [])
  - `@type` (string) (default: "Hse28IndexPoint")
  - `date_at` (integer, required)
  - `value` (number, required)
- `constituent_estates` (array) (default: [])
  - `@type` (string) (default: "Hse28ConstituentEstate")
  - `region` (string, required)
  - `name` (string, required)
  - `estate_id` (string, nullable)
  - `url` (string, nullable)
  - `price_per_sqft` (number, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The entity was not found, or a precondition failed

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.