Skip to main content
POST
/realtorca/properties/search

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
count
integer
required
Required range: 1 <= x <= 600
​
timeout
integer
default:300
Required range: 20 <= x <= 1500
​
geo_id
string | null
​
city
string | null
​
latitude_min
number | null
Required range: -90 <= x <= 90
​
latitude_max
number | null
Required range: -90 <= x <= 90
​
longitude_min
number | null
Required range: -180 <= x <= 180
​
longitude_max
number | null
Required range: -180 <= x <= 180
​
search_type
enum<string>
default:residential
Available options:
residential,
commercial
​
transaction_type
enum<string>
default:for_sale
Available options:
for_sale,
for_rent,
sold
​
sort
enum<string>
default:newest
Available options:
newest,
oldest,
lowest_price,
highest_price
​
culture
enum<string>
default:en
Available options:
en,
fr
​
currency
enum<string>
default:CAD
Available options:
CAD,
USD
​
property_type
enum<string> | null
Available options:
any,
residential,
condo_strata,
vacant_land,
recreational,
multi_family,
agriculture,
parking,
business,
retail,
industrial,
office,
hospitality,
institutional
​
building_type
enum<string> | null
Available options:
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
enum<string> | null
Available options:
any,
freehold,
condo_strata,
timeshare_fractional,
leasehold
​
zoning_type
enum<string> | null
Available options:
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
enum<string> | null
Available options:
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
enum<string> | null
Available options:
animal,
boarding,
cash_crop,
feed_lot,
greenhouse,
hobby_farm,
market_gardening,
mixed,
nursery,
orchard,
vineyard
​
price_min
integer | null
Required range: x >= 0
​
price_max
integer | null
Required range: x >= 0
​
rent_min
integer | null
Required range: x >= 0
​
rent_max
integer | null
Required range: x >= 0
​
beds_min
integer | null
Required range: 0 <= x <= 20
​
beds_max
integer | null
Required range: 0 <= x <= 20
​
baths_min
integer | null
Required range: 0 <= x <= 20
​
baths_max
integer | null
Required range: 0 <= x <= 20
​
storeys_min
integer | null
Required range: 0 <= x <= 100
​
storeys_max
integer | null
Required range: 0 <= x <= 100
​
square_footage_min
integer | null
Required range: x >= 0
​
square_footage_max
integer | null
Required range: x >= 0
​
building_size_min
integer | null
Required range: x >= 0
​
building_size_max
integer | null
Required range: x >= 0
​
land_size_min
number | null
Required range: x >= 0
​
land_size_max
number | null
Required range: x >= 0
​
unit_count_min
integer | null
Required range: 0 <= x <= 100
​
unit_count_max
integer | null
Required range: 0 <= x <= 100
​
parking_space_min
integer | null
Required range: 0 <= x <= 100
​
parking_space_max
integer | null
Required range: 0 <= x <= 100
​
maintenance_fee_min
integer | null
Required range: x >= 0
​
maintenance_fee_max
integer | null
Required range: x >= 0
​
property_tax_min
integer | null
Required range: x >= 0
​
property_tax_max
integer | null
Required range: x >= 0
​
year_built_min
integer | null
Required range: 1800 <= x <= 2100
​
year_built_max
integer | null
Required range: 1800 <= x <= 2100
​
listed_within_days
integer | null
Required range: x >= 1
​
sold_within_days
integer | null
Required range: x >= 1
​
open_houses_only
boolean
default:false
​
live_streams_only
boolean
default:false
​
keywords
string | null

Response

Successful Response

​
id
string
required
​
@type
string
default:RealtorcaListing
​
mls_number
string | null
​
url
string | null
​
status_id
string | null
​
price
number | null
​
display_price
string | null
​
transaction_type
string | null
​
property_type
string | null
​
ownership_type
string | null
​
address
string | null
​
city
string | null
​
province
string | null
​
postal_code
string | null
​
community_name
string | null
​
neighbourhood
string | null
​
latitude
number | null
​
longitude
number | null
​
bedroom_count
integer | null
​
bedrooms
string | null
​
bathroom_count
integer | null
​
storey_count
number | null
​
building_type
string | null
​
size_interior
string | null
​
size_interior_sqft
number | null
​
building_amenities
string[]
​
parking_type
string[]
​
parking_space_count
integer | null
​
amenities_nearby
string[]
​
land_size
string | null
​
image
string | null
​
images
string[]
​
time_on_realtor
string | null
​
business
object | null
​
agents
object[]