Metrocuadrado

get/metrocuadrado/search

Request

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

Query parameters

business_type'venta' | 'arriendo' | 'null' nullable

venta (for sale) or arriendo (for rent). Lowercase.

property_typestring nullable

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.

statusstring nullable

usado, nuevo, or both comma-joined.

citystring nullable

City token from the source location vocabulary, for example bogota or medellin. Not a URL fragment.

zonestring nullable

Zone token from the source location vocabulary.

neighborhoodstring nullable

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.

bedroomsstring nullable

Comma-joined bedroom counts. 0 is a literal zero-bedroom filter.

bathroomsstring nullable

Comma-joined bathroom counts.

stratumstring nullable

Comma-joined Colombian stratum numbers.

keywordstring nullable

Free-text term matched against the listing.

company_idstring nullable

Restrict to one publisher or agency id.

area_mininteger nullable

Minimum area in square metres.

area_maxinteger nullable

Maximum area in square metres.

price_mininteger nullable

Inclusive minimum price in Colombian pesos. Applied to the sale price under business_type=venta and to the rent under business_type=arriendo.

price_maxinteger nullable

Inclusive maximum price in Colombian pesos, on the same field as price_min. Must not be below it.

latitudenumber nullable

Radius search centre latitude. Must be sent with longitude and distance. Default route only: rich=true with a radius is rejected with a 422.

longitudenumber nullable

Radius search centre longitude. Must be sent with latitude and distance. Default route only: rich=true with a radius is rejected with a 422.

distanceinteger nullable

Distance in kilometres. Must be sent with latitude and longitude. Default route only: rich=true with a radius is rejected with a 422.

sort'price_asc' | 'price_desc' | 'date_newest' | 'bedrooms' | 'area' | 'null' nullable

price_asc, price_desc, date_newest, bedrooms, or area. The rich route supports the two price sorts only.

pageinteger nullable

1-based page. A page starting past the 10000 row ceiling returns a non-billable offset_ceiling error.

per_pageinteger nullable

Results per page, up to 48. Not accepted together with rich=true.

richboolean nullable

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.

idsstring nullable

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

string required
OR
OR
OR
OR
OR

Changes

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