# Trademe — 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 browse residential properties for sale across New Zealand's largest property marketplace, accessing details like price, location, bedrooms, bathrooms, and property size. Discover listings by region, district, or suburb using the integrated localities lookup to filter your search.

**Category:** Real Estate | **Website:** [www.trademe.co.nz/a/property/residential/sale/canterbury/christchurch-city](https://www.trademe.co.nz/a/property/residential/sale/canterbury/christchurch-city) | **Docs:** [parse.bot/marketplace/fa0ba0c4-c397-4de1-8d62-338e55b7bce1/trademe-co-nz-api](https://parse.bot/marketplace/fa0ba0c4-c397-4de1-8d62-338e55b7bce1/trademe-co-nz-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/trademe/`
**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 localities

Get all New Zealand regions, districts, and suburbs. Returns the full locality hierarchy: regions contain districts, districts contain suburbs. Useful for discovering valid location paths for the search_properties endpoint. Single-page response, no parameters.

**Estimated cost:** Metered

_No parameters required._

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

### Search properties

Search residential properties for sale on TradeMe with optional filters for location, price, bedrooms, bathrooms, property type, and keyword. Returns paginated results with property details including address, price, size, and coordinates. Paginates via integer page number. Each listing carries geo-coordinates and a canonical TradeMe URL.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bathrooms_max` | integer | No | Maximum number of bathrooms. |
| `bathrooms_min` | integer | No | Minimum number of bathrooms. |
| `bedrooms_max` | integer | No | Maximum number of bedrooms. |
| `bedrooms_min` | integer | No | Minimum number of bedrooms. |
| `location` | string | No | Canonical path for location filter (e.g. /property/residential/sale/canterbury/christchurch-city, /property/residential/sale/auckland). Determines region, district, and optionally suburb. |
| `page` | integer | No | Page number (1-based). |
| `price_max` | integer | No | Maximum price in NZD. |
| `price_min` | integer | No | Minimum price in NZD. |
| `property_type` | string | No | Property type filter. |
| `rows` | integer | No | Number of results per page. |
| `search_string` | string | No | Keyword search within listings. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/trademe/search-properties \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"bathrooms_max":"<integer>","bathrooms_min":"<integer>","bedrooms_max":"<integer>","bedrooms_min":"<integer>","location":"<string>","page":"<integer>","price_max":"<integer>","price_min":"<integer>","property_type":"<string>","rows":"<integer>","search_string":"<string>"}'
```

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