# Peerspace — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.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 explore Peerspace venue listings by location and activity type. Retrieve paginated search results with pricing, ratings, capacity, and amenities, then fetch full listing details including equipment, host information, and availability.

**Category:** Marketplaces | **Website:** [peerspace.com/](https://peerspace.com/) | **Docs:** [parse.bot/marketplace/e02bf5ab-7b83-4c7d-99cf-9b8848b478f3/peerspace-com-api](https://parse.bot/marketplace/e02bf5ab-7b83-4c7d-99cf-9b8848b478f3/peerspace-com-api)

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

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/peerspace/`
**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

### Crawl all listings

Full crawl combining search and detail extraction. Searches listings by activity then fetches each listing's detail page. Returns a flat list of enriched listing objects suitable for CSV export. Slower than search_listings as it fetches each detail page individually.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `activity` | string | No | Activity type slug to search for. |
| `pages` | integer | No | Number of search pages to crawl (24 results per page). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/peerspace/crawl-all-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"activity":"<string>","pages":"<integer>"}'
```

### Get activity suggestions

Autocomplete for activity types. Returns a list of matching activities filtered by an optional query string. When no query is provided, returns all available activities. Use the 'id' field from results as the activity parameter in search_listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | No | Search query to filter activities by name or ID. |

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

### Get listing detail

Get full details for a single Peerspace listing by its ID. Parses the listing HTML page to extract description, amenities, equipment, host name, address, and social links. The listing_id is obtainable from search_listings results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | Yes | Peerspace listing ID (e.g. '645aa0a5613cb2000e25a94b'). Obtainable from search_listings results. |

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

### Get location suggestions

Autocomplete for locations using Google Places. Returns place suggestions with place IDs that can be used as the place_id parameter in search_listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Location search query (e.g. 'New York', 'Los Angeles', 'Chicago'). |

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

### Get search filters

Get available search filter options for a given activity type. Returns categorized filter lists including space types, features, amenities, and styles that can be used to narrow search_listings results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `activity` | string | No | Activity type slug to get filters for. |

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

### Search listings

Search for Peerspace listings by activity type and location. Returns paginated results with listing summaries including pricing, ratings, capacity, and availability. Each page contains up to 24 results. Requires a place_id (from get_location_suggestions) and an activity slug (from get_activity_suggestions) to produce meaningful results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `activity` | string | No | Activity type slug such as 'party', 'meeting', 'photo-shoot'. Discover valid values via get_activity_suggestions. |
| `bbox` | string | No | Bounding box coordinates as a JSON array string in format [lat1,lng1,lat2,lng2]. |
| `pages` | integer | No | Number of pages to fetch (24 results per page). |
| `place_id` | string | No | Google Place ID for location filtering. Obtain from get_location_suggestions. |
| `start_page` | integer | No | Starting page number (1-based). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/peerspace/search-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"activity":"<string>","bbox":"<string>","pages":"<integer>","place_id":"<string>","start_page":"<integer>"}'
```

## Next steps

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