/midland/indices

POST /api/midland/indices

Price: 20 credits

Hong Kong property market time series published by Midland Realty. Returns the Midland Property Price Index (美聯樓價指數) monthly back to January 1997 or weekly back to 2016, broken down for the whole territory, Hong Kong Island, Kowloon and the New Territories with weekly and monthly percentage changes, deal counts, first-hand deal counts and average prices and rents per gross and saleable area unit; the Midland Confidence Index (美聯信心指數) weekly since 2018 with the accompanying weekly price index; Hong Kong economic indicators monthly since 1997 (mortgage interest rate, rental yield, real saving interest rate, Hang Seng Index, US Dollar Index, unemployment rate, affordability ratio, rental affordability ratio and house-price-to-income ratio); weekly Land Registry registration counts and amounts with week-on-week changes across first-hand and second-hand private housing, subsidised housing, industrial, commercial, shop and carpark categories; and the dated timeline of stamp-duty and interest-rate events that moved the market.

How to use it

Get a Hong Kong property market time series. Pick index: 'property_price_monthly' (Midland Property Price Index since 1997-01), 'property_price_weekly' (since 2016-03), 'confidence' (Midland Confidence Index, weekly since 2018-01), 'economic_indicators' (macro series since 1997-01, includes Hang Seng Index, unemployment and affordability ratios), 'land_registry' (weekly registration volumes by property category — one row per category) or 'market_events' (dated stamp-duty and rate changes). Set count for how many points to return; newest_first controls direction. Only the fields belonging to the chosen series are populated.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• index string required — Which series to return: the Midland Property Price Index (monthly since 1997 or weekly since 2016), the Midland Confidence Index (weekly since 2018), Hong Kong economic indicators (monthly since 1997), weekly Land Registry registration volumes by property category, or the dated market events timeline. (one of: "property_price_monthly", "property_price_weekly", "confidence", "economic_indicators", "land_registry", "market_events")
• count integer required — Max number of data points to return (min: 1)
• lang string — Output language for category and event text. (default: "zh-hk"; one of: "zh-hk", "zh-cn", "en")
• newest_first boolean — Return the most recent data points first instead of oldest first. (default: true)

Response

• @type string (default: "MidlandIndexPoint")
• index string required
• date_at integer nullable
• property_price_index number nullable
• property_price_index_hk_island number nullable
• property_price_index_kowloon number nullable
• property_price_index_new_territories number nullable
• weekly_change_percent number nullable
• weekly_change_percent_hk_island number nullable
• weekly_change_percent_kowloon number nullable
• weekly_change_percent_new_territories number nullable
• monthly_change_percent number nullable
• monthly_change_percent_hk_island number nullable
• monthly_change_percent_kowloon number nullable
• monthly_change_percent_new_territories number nullable
• transaction_count integer nullable
• transaction_count_hk_island integer nullable
• transaction_count_kowloon integer nullable
• transaction_count_new_territories integer nullable
• primary_transaction_count integer nullable
• primary_transaction_count_hk_island integer nullable
• primary_transaction_count_kowloon integer nullable
• primary_transaction_count_new_territories integer nullable
• net_ft_price number nullable
• net_ft_price_hk_island number nullable
• net_ft_price_kowloon number nullable
• net_ft_price_new_territories number nullable
• ft_price number nullable
• ft_price_hk_island number nullable
• ft_price_kowloon number nullable
• ft_price_new_territories number nullable
• net_ft_rent number nullable
• ft_rent number nullable
• confidence_index number nullable
• confidence_avg_index number nullable
• mortgage_interest_rate number nullable
• rental_yield number nullable
• real_saving_interest_rate number nullable
• hang_seng_index number nullable
• us_dollar_index number nullable
• unemployment_rate number nullable
• affordability_ratio number nullable
• rental_affordability_ratio number nullable
• house_price_to_income_ratio number nullable
• category string nullable
• registration_count integer nullable
• registration_amount number nullable
• registration_count_change_percent number nullable
• registration_amount_change_percent number nullable
• event_id string nullable
• description string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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 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 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 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 Wait at least 30 seconds, then retry.

Response 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.