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
for_sale, for_rent or sold.
residential or commercial.
price_asc, price_desc, newest, oldest, virtual_tour, most_photos or floor_area.
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.
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.
Results requested per page.
Map zoom used to group result markers. Accepted range 1 to 20, default 12.
Minimum price in CAD. Applies to the rental range on rent inventory.
Maximum price in CAD. Applies to the rental range on rent inventory.
min-max with 0 for no upper bound, for example 3-0.
min-max with 0 for no upper bound, for example 2-0.
min-max with 0 for no upper bound, for example 1-0.
Only listings with a garage.
Only listings with a pool.
Only waterfront listings.
Only listings with a fireplace.
Only listings with air conditioning.
Only acreage listings.
Listings represented by one REALTOR.
Listings from one brokerage.
Location id from the locations endpoint.
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.
South edge of the bounding box. Send all four bounds together.
North edge of the bounding box.
West edge of the bounding box.
East edge of the bounding box.
Response
Changes
No recorded changes to this operation across all 4 revisions of this API.