# Apartments — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search thousands of apartment listings, view detailed property information including amenities and pricing, and discover properties managed by specific companies all in one place. Find your ideal rental by filtering through available apartments and learning more about the management companies behind them.

**Category:** Real Estate | **Website:** [apartments.com/](https://apartments.com/) | **Docs:** [parse.bot/marketplace/fba85a8d-f609-4f09-afbe-926cae76e57b/apartments-com-api](https://parse.bot/marketplace/fba85a8d-f609-4f09-afbe-926cae76e57b/apartments-com-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-apartments-com-api-fba85a8d/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_management_companies

Search for properties managed by a specific company in a given market. Uses the company name as a keyword filter within the market area.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `company_name` | string | Yes | Management company name to search for (e.g., 'Greystar', 'Bozzuto'). |
| `market` | string | No | Market/city to search in (e.g., 'Boston', 'New York, NY'). If omitted, searches US-wide. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-apartments-com-api-fba85a8d/get_management_companies \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company_name":"<string>","market":"<string>"}'
```

### get_property_details

Get detailed information for a specific property listing including units, amenities, photos, and reviews.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL or path of the property listing (e.g., 'https://www.apartments.com/the-riverdale-tower-the-bronx-ny/db9r3kj/'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-apartments-com-api-fba85a8d/get_property_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### search_properties

Search for apartment listings by city, region, or coordinates with advanced filters. Returns up to 40 properties per page. Either query or lat+lng must be provided.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `lat` | number | No | Latitude for coordinate-based search. Must be provided together with lng. |
| `lng` | number | No | Longitude for coordinate-based search. Must be provided together with lat. |
| `max_beds` | integer | No | Maximum number of bedrooms. |
| `max_rent` | integer | No | Maximum monthly rent filter. |
| `min_beds` | integer | No | Minimum number of bedrooms. |
| `min_rent` | integer | No | Minimum monthly rent filter. |
| `min_sqft` | integer | No | Minimum square footage. |
| `page` | integer | No | Page number for pagination. |
| `query` | string | No | Location search query (e.g., 'New York, NY', 'Sunnyvale, CA'). Either query or lat+lng required. |
| `radius` | number | No | Search radius in miles when using lat/lng search. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-apartments-com-api-fba85a8d/search_properties \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lat":"<number>","lng":"<number>","max_beds":"<integer>","max_rent":"<integer>","min_beds":"<integer>","min_rent":"<integer>","min_sqft":"<integer>","page":"<integer>","query":"<string>","radius":"<number>"}'
```