/realtorca/offices/properties

POST /api/realtorca/offices/properties

Price: 5 credits

Get the MLS® listing inventory of a Canadian brokerage on REALTOR.ca, with full listing details for each.

How to use it

List the listings held by one brokerage, by numeric office ID or profile URL. Optionally restrict with transaction_type (for_sale, for_rent, sold). Items carry the same fields as /realtorca/properties/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• office string required — REALTOR.ca brokerage ID or an office profile URL (examples: "297462", "https://www.realtor.ca/office/firm/297462/x"; minLength: 1)
• count integer required — Max number of listings to return (min: 1; max: 600)
• transaction_type string nullable — Restrict to one transaction type (one of: "for_sale", "for_rent", "sold")
• sort string — Result ordering (default: "newest"; one of: "newest", "oldest", "lowest_price", "highest_price")
• culture string — Content language (default: "en"; one of: "en", "fr")
• currency string — Price currency (default: "CAD"; one of: "CAD", "USD")

Response

• @type string (default: "RealtorcaListing")
• id string required
• mls_number string nullable
• url string nullable
• status_id string nullable
• description string nullable
• price number nullable
• display_price string nullable
• transaction_type string nullable
• property_type string nullable
• ownership_type string nullable
• address string nullable
• city string nullable
• province string nullable
• postal_code string nullable
• community_name string nullable
• neighbourhood string nullable
• latitude number nullable
• longitude number nullable
• bedroom_count integer nullable
• bedrooms string nullable
• bathroom_count integer nullable
• storey_count number nullable
• building_type string nullable
• size_interior string nullable
• size_interior_sqft number nullable
• building_amenities array (default: [])
• parking_type array (default: [])
• parking_space_count integer nullable
• amenities_nearby array (default: [])
• land_size string nullable
• image string nullable
• images array (default: [])
• time_on_realtor string nullable
• business object nullable
  • @type string (default: "RealtorcaBusiness")
  • type string nullable
  • sub_type string nullable
• agents array (default: [])
  • @type string (default: "RealtorcaIndividualRef")
  • id string nullable
  • name string nullable
  • first_name string nullable
  • last_name string nullable
  • position string nullable
  • image string nullable
  • profile_url string nullable
  • websites array (default: [])
  • phones array (default: [])
    • @type string (default: "RealtorcaPhone")
    • type string nullable
    • number string nullable
  • organization object nullable
    • @type string (default: "RealtorcaOrganizationRef")
    • id string nullable
    • name string nullable
    • designation string nullable
    • organization_type string nullable
    • address string nullable
    • image string nullable
    • profile_url string nullable
    • phones array (default: [])

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.