# Cbre — 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 CBRE's commercial real estate listings by location, property type, and transaction (lease or sale) to find available properties and spaces that match your criteria. Access detailed property information including pricing, agent contacts, and specific space details to evaluate investment or leasing opportunities.

**Category:** Real Estate | **Website:** [cbre.com/](https://cbre.com/) | **Docs:** [parse.bot/marketplace/60b997c9-3380-4edf-84db-1d392ac529d7/cbre-com-api](https://parse.bot/marketplace/60b997c9-3380-4edf-84db-1d392ac529d7/cbre-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/cbre/`
**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 agent contact

Extract broker/agent contact information for a property. Returns agent names, email addresses, phone numbers, and office locations.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_id` | string | Yes | Primary key of the property (e.g. 'US-SMPL-173239'). Obtainable from search_properties results via Common.PrimaryKey. |

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

### Get property detail

Get full details for a specific property by its primary key. Returns all available fields including address, agents, photos, highlights, parking, lease rate type, available spaces, and dynamic attributes. A separate round-trip per property.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_id` | string | Yes | Primary key of the property (e.g. 'US-SMPL-173239'). Obtainable from search_properties results via Common.PrimaryKey. |

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

### Get property pricing

Extract pricing and lease terms for a property. Returns charges (rent rates, sale prices), lease types, and sale price if applicable. Lease-only properties may have empty charges.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_id` | string | Yes | Primary key of the property (e.g. 'US-SMPL-173239'). Obtainable from search_properties results via Common.PrimaryKey. |

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

### Get property spaces

Extract available spaces and units within a property. Returns floor/unit details including area, status, lease type, and availability. Some properties have no subdivided spaces.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_id` | string | Yes | Primary key of the property (e.g. 'US-SMPL-173239'). Obtainable from search_properties results via Common.PrimaryKey. |

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

### Search properties

Search for commercial real estate properties with filters for location, transaction type (lease/sale), property type, and size. Returns paginated results sorted by last updated date by default. Each property includes address, agents, photos, sizes, highlights, and available spaces. Paginates via integer page counter.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | No | Location string for geographic filtering. Geocoded to a bounding polygon internally. |
| `max_size` | number | No | Maximum size in sqft for client-side filtering. |
| `min_size` | number | No | Minimum size in sqft for client-side filtering. |
| `page` | integer | No | Page number for pagination (1-based). |
| `page_size` | integer | No | Number of results per page. |
| `property_type` | string | No | Property type filter. Accepted values include 'Office', 'Retail', 'Industrial', 'Multifamily', 'Land', 'Hotel', 'Healthcare'. |
| `sort` | string | No | Sort order expression. Default is desc(Common.LastUpdated). |
| `transaction_type` | string | No | Transaction type filter. Accepted values: 'lease', 'sale', 'allTypes'. When omitted, defaults to lease listings. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/cbre/search-properties \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"location":"<string>","max_size":"<number>","min_size":"<number>","page":"<integer>","page_size":"<integer>","property_type":"<string>","sort":"<string>","transaction_type":"<string>"}'
```

### Search properties for lease

Search specifically for properties available for lease. Convenience wrapper around search_properties with transaction_type fixed to lease. Supports location and property type filtering.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | No | Location string for geographic filtering (e.g. 'New York, NY, USA'). |
| `property_type` | string | No | Property type filter (e.g. 'Office', 'Retail', 'Industrial'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/cbre/search-properties-for-lease \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"location":"<string>","property_type":"<string>"}'
```

### Search properties for sale

Search specifically for properties available for sale. Convenience wrapper around search_properties with transaction_type fixed to sale. Sale inventory is generally sparser than lease inventory; not all location/property_type combinations will have results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | No | Location string for geographic filtering (e.g. 'Los Angeles, CA, USA'). |
| `property_type` | string | No | Property type filter (e.g. 'Office', 'Retail', 'Industrial'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/cbre/search-properties-for-sale \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"location":"<string>","property_type":"<string>"}'
```

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