Request
- Base URL: https://scrappa.co/api
- URL: https://scrappa.co/api/metrocuadrado/search
- Auth: API key in header X-API-KEY
Query parameters
venta (for sale) or arriendo (for rent). Lowercase.
Numeric code or comma-joined codes: 1 apartment, 2 house, 3 office, 4,15 plot, 5 consulting room, 6 retail, 7 farm, 8 storage, 9 apartment building, 10 office building, 14 studio apartment.
usado, nuevo, or both comma-joined.
City token from the source location vocabulary, for example bogota or medellin. Not a URL fragment.
Zone token from the source location vocabulary.
Neighbourhood token from the source location vocabulary, for example chapinero. A working filter for targeting an area; not a partition. To subdivide a large cell use a lat/long radius grid, 3 km or tighter.
Comma-joined bedroom counts. 0 is a literal zero-bedroom filter.
Comma-joined bathroom counts.
Comma-joined Colombian stratum numbers.
Free-text term matched against the listing.
Restrict to one publisher or agency id.
Minimum area in square metres.
Maximum area in square metres.
Inclusive minimum price in Colombian pesos. Applied to the sale price under business_type=venta and to the rent under business_type=arriendo.
Inclusive maximum price in Colombian pesos, on the same field as price_min. Must not be below it.
Radius search centre latitude. Must be sent with longitude and distance. Default route only: rich=true with a radius is rejected with a 422.
Radius search centre longitude. Must be sent with latitude and distance. Default route only: rich=true with a radius is rejected with a 422.
Distance in kilometres. Must be sent with latitude and longitude. Default route only: rich=true with a radius is rejected with a 422.
price_asc, price_desc, date_newest, bedrooms, or area. The rich route supports the two price sorts only.
1-based page. A page starting past the 10000 row ceiling returns a non-billable offset_ceiling error.
Results per page, up to 48. Not accepted together with rich=true.
Return the full source card instead of the compact card. One lookup either way. Not accepted together with ids, latitude, longitude or distance: those are default-route only and combining them is rejected with a 422.
Up to 50 comma-joined listing ids to hydrate in one lookup, for example 20622-M6020965. At least one id is required: an empty ids value is rejected with a 422 rather than answered as an unfiltered search. Default route only: the rich route answers it with an empty page, so rich=true with ids is rejected with a 422. An id batch is a single fixed window upstream, so no other parameter applies to it: every filter, page and per_page sent alongside ids is rejected with a 422 rather than dropped.
Response
Changes
No recorded changes to this operation across all 4 revisions of this API.