RealtorCa

get/realtor-ca/search

Request

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

Query parameters

transaction_type'for_sale' | 'for_rent' | 'sold' required

for_sale, for_rent or sold.

property_type_group'residential' | 'commercial' required

residential or commercial.

sort'price_asc' | 'price_desc' | 'newest' | 'oldest' | 'virtual_tour' | 'most_photos' | 'floor_area' required

price_asc, price_desc, newest, oldest, virtual_tour, most_photos or floor_area.

property_type_idinteger nullable

Commercial sub-type, so it requires property_type_group=commercial and is refused with 422 on residential inventory. Coverage overlaps between sub-types, so totals are not additive.

pageinteger

Referenced, not repeated: the ceiling RealtorCaService's paging hint stops at. Two bare literals drift, and the symptom is a hint the caller cannot follow — a page that 422s.

records_per_pageinteger

Results requested per page.

zoom_levelinteger

Map zoom used to group result markers. Accepted range 1 to 20, default 12.

min_priceinteger nullable

Minimum price in CAD. Applies to the rental range on rent inventory.

max_priceinteger nullable

Maximum price in CAD. Applies to the rental range on rent inventory.

bed_rangestring nullable

min-max with 0 for no upper bound, for example 3-0.

bath_rangestring nullable

min-max with 0 for no upper bound, for example 2-0.

storey_rangestring nullable

min-max with 0 for no upper bound, for example 1-0.

garageboolean nullable

Only listings with a garage.

poolboolean nullable

Only listings with a pool.

waterfrontboolean nullable

Only waterfront listings.

fireplaceboolean nullable

Only listings with a fireplace.

air_conditionboolean nullable

Only listings with air conditioning.

acreageboolean nullable

Only acreage listings.

individual_idinteger nullable

Listings represented by one REALTOR.

organization_idinteger nullable

Listings from one brokerage.

geo_idstring nullable

Location id from the locations endpoint.

sold_within_daysinteger nullable

Required when transaction_type=sold: look back this many days, capped at 365. A sold search without it is refused with 422 rather than answered with an unbounded national set or a silently narrowed one. Rejected on any other transaction type.

latitude_minnumber nullable

South edge of the bounding box. Send all four bounds together.

latitude_maxnumber nullable

North edge of the bounding box.

longitude_minnumber nullable

West edge of the bounding box.

longitude_maxnumber nullable

East edge of the bounding box.

Response

string required

Changes

No recorded changes to this operation across all 4 revisions of this API.