latitude | NUMBER | Required | Latitude of the search center (decimal degrees).
**Example**: `40.6943` (Brooklyn, NY). |
longitude | NUMBER | Required | Longitude of the search center (decimal degrees).
**Example**: `-73.9903` (Brooklyn, NY). |
radius | NUMBER | Optional | Search radius around the centroid, in **miles**.
- **Default**: `5`
- Sensible range: `1` – `25`. |
page | NUMBER | Optional | 1-based page number. The response includes a `nextPage` boolean — keep paging until `nextPage = false`. |
resultCount | NUMBER | Optional | Results per page.
- **Default**: `50`
- **Min**: `1`
- **Max**: `500` |
sortOrder | ENUM | Optional | Sort order for the result list. **Default**: `Default` (apartments.com's relevance bucket).
- `Default` — apartments.com's default ranking
- `Lowest_Rent` — cheapest first
- `Highest_Rent` — most expensive first
- `Newest` — most recently listed first
- `Has_Video` — only listings with a video
- `Has_3D_Tour` — only listings with a 3D tour
- `Recently_Updated` — listings whose price/availability changed most recently Values: Default, Lowest_Rent, Newest, Highest_Rent, Has_Video, Has_3D_Tour, Recently_Updated |
propertyType | STRING | Optional | Comma-separated property types to include. Leave empty for **all types**.
**Allowed values**: `Apartment`, `House`, `Condo`, `Townhouse`, `Room`
**Aliases accepted**: `Townhome` → `Townhouse`; `Single_Family` / `SFH` → `House`.
**Examples**: `Apartment`, `Apartment,Condo`, `House,Townhouse`. |
priceRange | STRING | Optional | Monthly **rent** range, in dollars.
**Possible Inputs**:
- For Minimum Rent: `min:1500`
- For Maximum Rent: `max:4000`
- For a Range: `min:1500,max:4000` |
bedRange | STRING | Optional | Bedroom range. Studio = `min:0,max:0`.
**Possible Inputs**:
- For Minimum Beds: `min:1`
- For Maximum Beds: `max:3`
- For an Exact Match: `min:2,max:2`
- For a Range: `min:1,max:3` |
bathRange | STRING | Optional | Bathroom range — integers only on apartments.com.
**Possible Inputs**:
- For Minimum Baths: `min:1`
- For Maximum Baths: `max:2`
- For a Range: `min:1,max:2` |
squareFeetRange | STRING | Optional | Living area range, in **square feet**.
**Possible Inputs**:
- For Minimum Sqft: `min:600`
- For Maximum Sqft: `max:1500`
- For a Range: `min:600,max:1500` |
petPolicy | ENUM | Optional | Pet allowance.
- `Dog` — listings that allow dogs
- `Cat` — listings that allow cats
- `Dog_and_Cat` — listings that allow both
Omit to include all listings (pet-free or pet-friendly). Values: Dog, Cat, Dog_and_Cat |
amenities | STRING | Optional | Comma-separated amenity filters. Listings must have **all** of the selected amenities.
**Allowed values** (38): `smoke_free, washer_dryer, dishwasher, heating, air_conditioning, balcony, fireplace, furnished, gym, pool, tennis_court, roof_terrace, basketball_court, playground, rent_specials, garage_parking, wheelchair_access, parking, high_speed_internet, elevator, washer_dryer_hookup, laundry_facilities, gated, utilities_included, lofts, basement, business_center, clubhouse, concierge, controlled_access, den, doorman, hardwood_floors, office, patio, walk_in_closets, yard, car_charging_station`
**Aliases accepted**: `ac` → `air_conditioning`, `fitness` → `gym`, `internet`/`wifi` → `high_speed_internet`, `garage` → `garage_parking`, `accessible` → `wheelchair_access`, `loft` → `lofts`, `walk_in_closet` → `walk_in_closets`, `ev_charging` → `car_charging_station`.
**Examples**: `pool,gym`, `washer_dryer,dishwasher,parking`. |
specialties | STRING | Optional | Comma-separated specialty-housing filters.
**Allowed values**: `Senior`, `Military`, `Student`, `Corporate`, `Short_Term`, `Income_Restricted`
**Examples**: `Student`, `Senior,Income_Restricted`, `Short_Term,Corporate`. |
toolFilters | STRING | Optional | Comma-separated apartments.com **deal-finder** filters (powered by their internal ranking).
**Allowed values**: `Rent_Special`, `Best_Value`, `Top_Deal`, `Luxury`, `Cheap`
- `Rent_Special` — listings actively running rent specials / move-in incentives.
- `Best_Value` / `Top_Deal` — apartments.com's value-ranked picks.
- `Luxury` — premium/luxury inventory.
- `Cheap` — budget-leaning inventory.
**Examples**: `Rent_Special`, `Best_Value,Top_Deal`. |
minRating | NUMBER | Optional | Minimum **resident rating**, on a 1–5 star scale (integer).
Returns listings with a resident-rating ≥ N stars. Leave empty to include unrated listings.
**Examples**: `3`, `4`. |
availableFrom | STRING | Optional | Earliest **move-in date** (`YYYY-MM-DD`). Listings whose earliest available date is on or after this value are returned.
**Example**: `2026-06-01`. |
availableTo | STRING | Optional | Latest **move-in date** (`YYYY-MM-DD`). Listings whose earliest available date is on or before this value are returned.
**Example**: `2026-09-01`. |
keywords | STRING | Optional | Free-text keywords matched against listing descriptions (comma- or space-separated).
**Examples**: `loft brick`, `hardwood,exposed brick`, `pool,doorman`. |