# Rent — 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.

> Browse and extract rental property data from Rent.com. Search listings by location and filter by beds, baths, price, and pet policy. Retrieve full property details, floor plans, unit availability, amenities, nearby schools, points of interest, and active specials.

**Category:** Real Estate | **Website:** [rent.com/](https://rent.com/) | **Docs:** [parse.bot/marketplace/a1396918-0ebd-4b41-8b5a-7b1ad1212ec5/rent-com-api](https://parse.bot/marketplace/a1396918-0ebd-4b41-8b5a-7b1ad1212ec5/rent-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-rent-com-api-a1396918/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_floor_plan_units

Get individual unit details for all floor plans (or a specific floor plan) within a property. Returns unit-level availability, pricing, and move-in dates.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `floor_plan_id` | string | No | Specific floor plan ID to filter units. Omitting returns units from all floor plans. |
| `property_slug` | string | Yes | Property slug identifier (e.g. 'the-ivy-austin-tx-lc6705165'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-rent-com-api-a1396918/get_floor_plan_units \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"floor_plan_id":"<string>","property_slug":"<string>"}'
```

### get_floor_plans

Get all floor plans for a specific property. Returns detailed floor plan information including bed/bath counts, pricing, square footage, amenities, and availability status.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_slug` | string | Yes | Property slug identifier (e.g. 'the-ivy-austin-tx-lc6705165'). |

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

### get_nearby_places

Get places of interest near a property, organized by category (grocery, restaurants, shopping, parks, entertainment, services, bars, community, emergency, sportsAndRecreation).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_slug` | string | Yes | Property slug identifier (e.g. 'the-ivy-austin-tx-lc6705165'). |

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

### get_property_amenities

Get comprehensive amenities and features for a property, organized by category and subcategory.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_slug` | string | Yes | Property slug identifier (e.g. 'the-ivy-austin-tx-lc6705165'). |

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

### get_property_details

Get full details for a specific rental property by its slug. Returns comprehensive property information including description, floor plans, amenities, pricing, nearby places, schools, and deals.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_slug` | string | Yes | Property slug identifier from search results urlPathname (e.g. 'the-ivy-austin-tx-lc6705165'). |

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

### get_property_schools

Get nearby schools for a property including public, private, and charter schools with ratings, grade levels, and distance.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_slug` | string | Yes | Property slug identifier (e.g. 'the-ivy-austin-tx-lc6705165'). |

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

### get_property_specials

Get current deals, specials, and promotions for a property. Returns empty items array if no active specials exist.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_slug` | string | Yes | Property slug identifier (e.g. 'the-ivy-austin-tx-lc6705165'). |

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

### get_search_autocomplete

Autocomplete search suggestions for a location query. Returns matching locations (cities, colleges) and suggested properties matching the query name.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search query text for location or property name (e.g. 'New York', 'Austin'). |

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

### search_listings

Search for rental listings by location slug. Supports filtering by beds, baths, price range, and pets. Returns paginated results with listing summaries.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `baths` | string | No | Filter by number of bathrooms. |
| `beds` | string | No | Filter by number of bedrooms. |
| `location_slug` | string | Yes | Location slug in format 'state/city'. Accepted values: 'texas/austin', 'new-york/new-york', 'california/los-angeles'. |
| `page` | integer | No | Page number for pagination (1-based). |
| `pets` | string | No | Pet filter (e.g. 'dogs', 'cats'). |
| `price_max` | string | No | Maximum monthly rent price filter. |
| `price_min` | string | No | Minimum monthly rent price filter. |
| `sort` | string | No | Sort order for results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-rent-com-api-a1396918/search_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"baths":"<string>","beds":"<string>","location_slug":"<string>","page":"<integer>","pets":"<string>","price_max":"<string>","price_min":"<string>","sort":"<string>"}'
```