# /realtorca/properties/search

`POST /api/realtorca/properties/search`

Price: 20 credits

Search Canadian MLS® listings on REALTOR.ca by area (geo ID, city or map bounding box) with the full REALTOR.ca filter surface: residential or commercial inventory, for sale / for rent / sold, property and building type, ownership, zoning, parking, farm type, price, rent, bedrooms, bathrooms, storeys, interior and building size, lot size, unit count, maintenance fee, property tax, construction year, listing age and free-text keywords.

## How to use it

Search Canada-wide MLS® inventory. Requires count plus a search area: geo_id (from /realtorca/locations/search), city, or the full latitude_min/latitude_max/longitude_min/longitude_max bounding box. transaction_type covers for_sale, for_rent and sold. Each item carries id, mls_number, url, price, display_price, transaction_type, property_type, ownership_type, address/city/province/postal_code, coordinates, bedroom_count, bathroom_count, building_type, size_interior, amenities, parking, images and the listing agents with their brokerage. REALTOR.ca caps any single search at 600 listings — cover a larger market by splitting the area into smaller geo IDs or bounding boxes.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `count` (integer, required) — Max number of listings to return (min: 1; max: 600)
- `geo_id` (string, nullable) — REALTOR.ca geographic area ID, resolvable via /realtorca/locations/search (examples: "g30_dpz89rm7")
- `city` (string, nullable) — City name (examples: "Toronto")
- `latitude_min` (number, nullable) — South edge of the bounding box (min: -90; max: 90)
- `latitude_max` (number, nullable) — North edge of the bounding box (min: -90; max: 90)
- `longitude_min` (number, nullable) — West edge of the bounding box (min: -180; max: 180)
- `longitude_max` (number, nullable) — East edge of the bounding box (min: -180; max: 180)
- `search_type` (string) — Residential or commercial inventory (default: "residential"; one of: "residential", "commercial")
- `transaction_type` (string) — Listing transaction type (default: "for_sale"; 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")
- `property_type` (string, nullable) — Property category (one of: "any", "residential", "condo_strata", "vacant_land", "recreational", "multi_family", "agriculture", "parking", "business", "retail", "industrial", "office", "hospitality", "institutional")
- `building_type` (string, nullable) — Building style (one of: "house", "row_townhouse", "apartment", "duplex", "triplex", "fourplex", "garden_home", "mobile_home", "manufactured_home_mobile", "special_purpose", "residential_commercial_mix", "manufactured_home", "commercial_apartment", "two_apartment_house", "park_model_mobile_home", "floathome", "modular", "offices", "multi_family", "retail", "warehouse", "flex_facility", "multi_tenant_industrial", "commercial_mix", "other")
- `ownership_type` (string, nullable) — Ownership arrangement (one of: "any", "freehold", "condo_strata", "timeshare_fractional", "leasehold")
- `zoning_type` (string, nullable) — Zoning class (commercial inventory) (one of: "agricultural", "commercial_mixed", "commercial_office", "commercial_retail", "industrial", "industrial_heavy", "industrial_light", "industrial_medium", "institutional", "other", "recreational", "residential_high_density", "residential_low_density", "residential_medium_density")
- `parking_type` (string, nullable) — Parking arrangement (one of: "additional_parking", "attached_garage", "boat_house", "carport", "concrete", "covered", "detached_garage", "garage", "heated_garage", "indoor", "integrated_garage", "open", "parking_pad", "paved_yard", "underground")
- `farm_type` (string, nullable) — Farm category (agricultural inventory) (one of: "animal", "boarding", "cash_crop", "feed_lot", "greenhouse", "hobby_farm", "market_gardening", "mixed", "nursery", "orchard", "vineyard")
- `price_min` (integer, nullable) — Lowest price (min: 0)
- `price_max` (integer, nullable) — Highest price (min: 0)
- `rent_min` (integer, nullable) — Lowest monthly rent (min: 0)
- `rent_max` (integer, nullable) — Highest monthly rent (min: 0)
- `beds_min` (integer, nullable) — Fewest bedrooms (min: 0; max: 20)
- `beds_max` (integer, nullable) — Most bedrooms (min: 0; max: 20)
- `baths_min` (integer, nullable) — Fewest bathrooms (min: 0; max: 20)
- `baths_max` (integer, nullable) — Most bathrooms (min: 0; max: 20)
- `storeys_min` (integer, nullable) — Fewest storeys (min: 0; max: 100)
- `storeys_max` (integer, nullable) — Most storeys (min: 0; max: 100)
- `square_footage_min` (integer, nullable) — Smallest interior area in sqft (min: 0)
- `square_footage_max` (integer, nullable) — Largest interior area in sqft (min: 0)
- `building_size_min` (integer, nullable) — Smallest building area in sqft (min: 0)
- `building_size_max` (integer, nullable) — Largest building area in sqft (min: 0)
- `land_size_min` (number, nullable) — Smallest lot size in acres (min: 0)
- `land_size_max` (number, nullable) — Largest lot size in acres (min: 0)
- `unit_count_min` (integer, nullable) — Fewest units (multi-family) (min: 0; max: 100)
- `unit_count_max` (integer, nullable) — Most units (multi-family) (min: 0; max: 100)
- `parking_space_min` (integer, nullable) — Fewest parking spaces (min: 0; max: 100)
- `parking_space_max` (integer, nullable) — Most parking spaces (min: 0; max: 100)
- `maintenance_fee_min` (integer, nullable) — Lowest monthly maintenance fee (min: 0)
- `maintenance_fee_max` (integer, nullable) — Highest monthly maintenance fee (min: 0)
- `property_tax_min` (integer, nullable) — Lowest annual property tax (min: 0)
- `property_tax_max` (integer, nullable) — Highest annual property tax (min: 0)
- `year_built_min` (integer, nullable) — Earliest construction year (min: 1800; max: 2100)
- `year_built_max` (integer, nullable) — Latest construction year (min: 1800; max: 2100)
- `listed_within_days` (integer, nullable) — Only listings published within N days (min: 1)
- `sold_within_days` (integer, nullable) — Only listings sold within N days (sold transaction type) (min: 1)
- `open_houses_only` (boolean) — Only listings with a scheduled open house (default: false)
- `live_streams_only` (boolean) — Only listings with a scheduled live-streamed showing (default: false)
- `keywords` (string, nullable) — Free-text keywords matched against listing text

## Response

### 200 — Successful 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 — 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.