Skip to main content
POST
/
api
/
apartments
/
listings
/
search
/apartments/listings/search
curl --request POST \
  --url https://api.anysite.io/api/apartments/listings/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "location": "<string>",
  "count": 2,
  "timeout": 300,
  "min_price": 1,
  "max_price": 1
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@apartments_search_listing",
    "name": "<string>",
    "phone": "<string>",
    "address": {
      "@type": "@apartments_address",
      "street": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "geo": {
      "@type": "@apartments_geo",
      "latitude": 123,
      "longitude": 123
    },
    "rent_low": 123,
    "rent_high": 123,
    "currency": "<string>",
    "availability": "<string>",
    "image": "<string>",
    "amenities": [],
    "specials": [],
    "bed_rents": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location
string
required

Location as city-state slug (e.g. houston-tx) or a search URL

Minimum string length: 1
Examples:

"houston-tx"

"austin-tx"

"https://www.apartments.com/chicago-il/"

count
integer
required

Max number of listings to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
bedrooms
enum<string> | null

Filter by number of bedrooms

Available options:
studio,
1,
2,
3,
4
home_type
enum<string> | null

Filter by home type

Available options:
apartments,
houses,
condos,
townhomes
min_price
integer | null

Minimum monthly rent

Required range: x >= 0
max_price
integer | null

Maximum monthly rent

Required range: x >= 0

Response

Successful Response

id
string
required
url
string
required
@type
string
default:@apartments_search_listing
name
string | null
phone
string | null
address
ApartmentsAddress · object
geo
ApartmentsGeo · object
rent_low
integer | null
rent_high
integer | null
currency
string | null
availability
string | null
image
string | null
amenities
string[]
specials
string[]
bed_rents
ApartmentsSearchBedRent · object[]