# Realestate — 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 retrieve property listing data from realestate.com.au, including listings for sale and rent, detailed property information, and nearby schools for any location across Australia.

**Category:** Real Estate | **Website:** [realestate.com.au/](https://realestate.com.au/) | **Docs:** [parse.bot/marketplace/2ea21ebb-6e03-48e0-9871-01ef25043559/realestate-com-au-api](https://parse.bot/marketplace/2ea21ebb-6e03-48e0-9871-01ef25043559/realestate-com-au-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/realestate/`
**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 nearby schools

Fetch schools near a given latitude and longitude. Returns up to 5 schools in each category (all, primary, secondary). Each school includes name, sector, type, year range, address, location coordinates, and distance from the queried point.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `lat` | number | Yes | Latitude coordinate (e.g. -37.8136) |
| `lon` | number | Yes | Longitude coordinate (e.g. 144.9631) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/realestate/get-nearby-schools \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"lat":"<number>","lon":"<number>"}'
```

### Get property details

Get detailed information about a specific property listing by its ID. Returns address, price, features, description, listing company, property sizes, media URLs, and inspection times. The property_id is obtained from search results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_id` | string | Yes | The unique numeric listing ID (e.g. '149037324'). Obtained from search endpoint results. |

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

### Get sold properties

Search for recently sold properties by location. Results are sorted by sold date descending (most recently sold first). Returns paginated results with sold price, sold date, and property details. Each page returns up to ~25 listings. The total count reflects server-side matches for the location.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | Yes | Suburb, city, postcode, or state to search in (e.g. 'melbourne', 'sydney', '2000') |
| `page` | integer | No | Page number for pagination |

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

### Search

Search for property listings for sale or rent. Returns paginated results with property summaries. Supports location-based search by suburb, city, postcode, or state. Each page returns up to ~25 listings. The total count reflects server-side matches for the location and purpose. When listed_since is provided, results are automatically sorted by date (newest first) and filtered to only include properties listed within the specified time period; listings older than the period or without listing date information are excluded from results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listed_since` | string | No | Filter results to only properties listed within the specified time period. When provided, results are sorted by date newest first. Listing date availability is limited to approximately the most recent 7 days of listings. |
| `location` | string | Yes | Suburb, city, postcode, or state to search in (e.g. 'melbourne', 'sydney', '2000') |
| `page` | integer | No | Page number for pagination |
| `purpose` | string | No | Listing type: 'buy' or 'rent' |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/realestate/search \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"listed_since":"<string>","location":"<string>","page":"<integer>","purpose":"<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.