# Privateproperty — 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 property listings for sale and rent across South Africa by location, price, features, and size, then view detailed information about specific properties. Get location suggestions to help narrow down your search area.

**Category:** Real Estate | **Website:** [privateproperty.co.za/](https://privateproperty.co.za/) | **Docs:** [parse.bot/marketplace/0c04c766-c22d-4880-aff8-dde404b01677/privateproperty-co-za-api](https://parse.bot/marketplace/0c04c766-c22d-4880-aff8-dde404b01677/privateproperty-co-za-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/privateproperty/`
**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 location suggestions

Search for location suggestions to use in property searches. Returns location names and IDs that serve as the location_id parameter in search_properties. Query matches against suburb, city, and region names across South Africa.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search phrase for location (e.g. 'Sandton', 'Cape Town') |

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

### Get property details

Retrieve full details for a specific property listing by its URL. Returns structured data including address, price, photos, property features (bedrooms, bathrooms, lounges, amenities), main features (summary values), and geo coordinates. The URL must be a valid privateproperty.co.za listing page obtained from search_properties results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | The full property detail page URL from search_properties results (e.g. 'https://www.privateproperty.co.za/for-sale/gauteng/johannesburg/sandton/morningside/0000-central-square/5-lower-road/T5497619') |

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

### Search properties

Search for properties for sale or rent with extensive filters. Returns paginated listings with basic property info including price, address, bedrooms, bathrooms, and listing URL. Each page returns up to 20 listings. Use location_id from get_location_suggestions to scope results to a specific area.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `baths` | integer | No | Minimum number of bathrooms |
| `beds` | integer | No | Minimum number of bedrooms |
| `category` | string | No | Category filter (e.g. 'commercial', 'farms', 'developments') |
| `features` | string | No | Feature filter (e.g. 'SecurityPost', 'BankAssistedSales', 'OnShow') |
| `listing_type` | string | No | Listing type: 'for-sale' or 'to-rent' |
| `location_id` | string | No | The itemId from get_location_suggestions results (e.g. '34' for Sandton, '1' for all South Africa) |
| `max_floor` | integer | No | Maximum floor size in square meters |
| `min_floor` | integer | No | Minimum floor size in square meters |
| `page` | integer | No | Page number for pagination (1-based) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/privateproperty/search-properties \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"baths":"<integer>","beds":"<integer>","category":"<string>","features":"<string>","listing_type":"<string>","location_id":"<string>","max_floor":"<integer>","min_floor":"<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.