# Padmapper — 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 and browse rental listings across cities with detailed property information including prices, contact details, and market trends. Discover apartments and homes through city-wide searches or map-based exploration, and access comprehensive listing details to help you find your next rental.

**Category:** Real Estate | **Website:** [padmapper.com/](https://padmapper.com/) | **Docs:** [parse.bot/marketplace/470b3d3b-6c8d-4c31-934b-360f1b8c62bf/padmapper-com-api](https://parse.bot/marketplace/470b3d3b-6c8d-4c31-934b-360f1b8c62bf/padmapper-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/padmapper/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get city overview

Get overview stats and price trends for a city's rental market including neighborhood breakdowns, median prices by bedroom count, and historical price trend data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city_slug` | string | Yes | City slug identifying the market (e.g. 'montreal-qc', 'toronto-on', 'new-york-ny'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/padmapper/get-city-overview \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city_slug":"<string>"}'
```

### Get listing contact

Retrieve contact details for a specific building including agent info, phone number, and brokerage. At least one of listing_id or slug must be provided.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | No | Building ID prefixed with 'p' (e.g. 'p891463'). Either listing_id or slug must be provided. |
| `slug` | string | No | Full URL path of the listing. Either listing_id or slug must be provided. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/padmapper/get-listing-contact \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"<string>","slug":"<string>"}'
```

### Get listing detail

Get full details for a single building/listing including description, amenities, floorplans, media, agents, and all available units. At least one of listing_id or slug must be provided.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | No | Building ID prefixed with 'p' (e.g. 'p891463'). Either listing_id or slug must be provided. |
| `slug` | string | No | Full URL path of the listing (e.g. '/buildings/p123456/apartments-at-123-main-st-new-york-ny-10001'). Either listing_id or slug must be provided. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/padmapper/get-listing-detail \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"listing_id":"<string>","slug":"<string>"}'
```

### Get map listings

Retrieve listings for a map view given a geographic bounding box. Returns building pins with coordinates, price ranges, and bedroom counts.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `east` | number | Yes | East longitude of bounding box. |
| `north` | number | Yes | North latitude of bounding box. |
| `south` | number | Yes | South latitude of bounding box. |
| `west` | number | Yes | West longitude of bounding box. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/padmapper/get-map-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"east":"<number>","north":"<number>","south":"<number>","west":"<number>"}'
```

### Search listings

Search for rental listings in a given city with optional filters for price range and bedroom count. Returns paginated listing results along with neighborhood data for the city. Each page returns up to ~20 listings. Pagination is via page number.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bedrooms` | string | No | Comma-separated list of bedroom counts to filter by (0 for studio, 1, 2, 3, 4). Example: '0,1,2'. |
| `city_slug` | string | Yes | City slug identifying the market to search, formatted as city-state (e.g. 'montreal-qc', 'toronto-on', 'new-york-ny'). |
| `max_price` | integer | No | Maximum monthly rent price filter. |
| `min_price` | integer | No | Minimum monthly rent price filter. |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/padmapper/search-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"bedrooms":"<string>","city_slug":"<string>","max_price":"<integer>","min_price":"<integer>","page":"<integer>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.