ApartmentsCom

get/apartments-com/search

Request

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

Query parameters

locationstring nullable

Free-text place name, resolved to a geography before searching. Typeahead entity types are translated into the search vocabulary, so a neighborhood resolves to geo_type 5. If the text matches only entity types the search route cannot take, such as a property, street, or airport, the request fails with 422 unmappable_location rather than returning an empty result.

geo_midstring nullable

Geography id from the locations endpoint.

geo_typeinteger nullable

1 street address, 2 zip, 3 city, 5 neighborhood.

property_typestring nullable

apartments, houses, condos, comma separated. Townhomes are not filterable upstream; filter listingType 16 from property-placards.

min_rentinteger nullable

Lowest monthly rent.

max_rentinteger nullable

Highest monthly rent.

min_bedsinteger nullable

Lowest bedroom count.

max_bedsinteger nullable

Highest bedroom count.

pet_friendlyboolean nullable

Only listings that accept pets.

amenities[]string[]

Upstream amenity codes, for example gym or parking.

bboxstring nullable

west,south,east,north. Applied locally to returned coordinates, because upstream ignores it; total then counts only listings inside the box.

Response

string required

Changes

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