Centris

Changed on
get/centris/search

Request

  • Base URL: https://scrappa.co/api
  • URL: https://scrappa.co/api/centris/search
  • Auth: API key in header X-API-KEY

Query parameters

transaction_type'for_sale' | 'for_rent' | 'null' nullable

for_sale (default) or for_rent.

property_type'condo' | 'single_family' | 'plex' | 'null' nullable

condo, single_family or plex.

building_type'detached' | 'semi_detached' | 'attached' | 'null' nullable

detached, semi_detached or attached.

min_priceinteger nullable

Minimum price in CAD. For for_rent this is the monthly rent.

max_priceinteger nullable

Maximum price in CAD. For for_rent this is the monthly rent.

bedroomsinteger nullable

Minimum number of bedrooms, 1 to 9.

bathroomsinteger nullable

Minimum number of bathrooms and powder rooms, 1 to 9.

parkinginteger nullable

Minimum number of parking spaces, 1 to 9.

garageinteger nullable

Minimum number of garage spaces, 1 to 9.

poolboolean nullable

Only listings with a pool.

location_idstring nullable

The pair travels together: the location type is the origin's field id.

location_type'CityDistrictAll' | 'CityDistrict' | 'CityDistrictNeighbourhoodSearch' | 'GeographicArea' | 'GeographicSubArea' | 'PostalCodeSearch' | 'null' nullable

The type of that location: CityDistrictAll, CityDistrict, CityDistrictNeighbourhoodSearch, GeographicArea, GeographicSubArea or PostalCodeSearch.

broker_idstring nullable

Only listings of one broker. Use the broker_id from the broker autocomplete route.

sort'price_asc' | 'price_desc' | 'newest' | 'oldest' | 'null' nullable

price_asc, price_desc, newest or oldest. Without it the origin default order applies.

pageinteger nullable

Page number, 1 to 250. A page past the end of the scope returns no listings.

Response

string required

Changes