/realtorca/markets

POST /api/realtorca/markets

Price: 10 credits

Get the MLS® Home Price Index (HPI) benchmark for a Canadian city: current benchmark price, the year-over-year change, the monthly series for the past 12 months and the yearly series for the past 10 years. This is CREA's own market yardstick, published nowhere else.

How to use it

Fetch CREA's MLS® Home Price Index benchmark for one Canadian city (city plus its province). Returns one item with name, geo_id (reusable as the geo_id filter of /realtorca/properties/search), board_id, property_type (the HPI composite the benchmark is computed on), market_price in CAD, price_change_year_percent, and the past_12_months / past_10_years series of label+price points. Use it to place an individual listing's price against its local market.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string required — City name as it appears in REALTOR.ca URLs (examples: "Toronto"; minLength: 1)
• province string required — Province or territory the city belongs to (one of: "alberta", "british_columbia", "manitoba", "new_brunswick", "newfoundland_and_labrador", "northwest_territories", "nova_scotia", "nunavut", "ontario", "prince_edward_island", "quebec", "saskatchewan", "yukon")

Response

• @type string (default: "RealtorcaMarket")
• name string required
• geo_id string nullable
• board_id string nullable
• property_type string nullable
• currency string (default: "CAD")
• market_price number nullable
• price_change_year_percent number nullable
• past_12_months array (default: [])
  • @type string (default: "RealtorcaMarketPoint")
  • label string required
  • price number nullable
• past_10_years array (default: [])
  • @type string (default: "RealtorcaMarketPoint")
  • label string required
  • price number 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 — No MLS® HPI benchmark published for this city 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.