Hotpads

get/hotpads/search

Request

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

Query parameters

areastring required

HotPads area slug: city and state such as albuquerque-nm, a zip code such as 60607, a state such as il, or a neighborhood such as river-west-chicago-il. Example: albuquerque-nm.

type'apartments' | 'houses' | 'condos' | 'townhomes'

Property type: apartments, houses, condos or townhomes. Defaults to apartments.

bedsinteger

Number of bedrooms, 0 to 5. Use 0 for studios. Works with the apartments and houses types only.

min_priceinteger

Minimum monthly rent in USD, 0 to 100000.

max_priceinteger

Maximum monthly rent in USD, at least min_price.

pageinteger

Page number, 1 to 100. Defaults to 1. Each page holds up to 40 results.

Response

string required
OR

Changes

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