# Flatmates.com.au — 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.

> Access room seeker profiles and property listings from Flatmates.com.au. Retrieve structured seeker details — including move dates, budgets, and preferred locations — alongside paginated discovery of active seekers and properties, all via straightforward HTTP requests.

**Category:** Real Estate | **Website:** [flatmates.com.au/](https://flatmates.com.au/) | **Docs:** [parse.bot/marketplace/90c86daf-a064-4598-8e67-57c13ecf1f60/flatmates-com-au-api](https://parse.bot/marketplace/90c86daf-a064-4598-8e67-57c13ecf1f60/flatmates-com-au-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-flatmates-com-au-api-90c86daf/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### discover_properties

Discover active property listing IDs and URLs from the flatmates.com.au sitemap. Returns a paginated slice of all active property listings with extracted title and ID.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Number of properties to return. |
| `offset` | integer | No | Offset into the full list for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-flatmates-com-au-api-90c86daf/discover_properties \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>"}'
```

### discover_seekers

Discover active seeker IDs from the flatmates.com.au sitemap. Returns a paginated slice of all active person listing IDs. Use these IDs with get_seeker_details to retrieve full profiles.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Number of seeker IDs to return. |
| `offset` | integer | No | Offset into the full list for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-flatmates-com-au-api-90c86daf/discover_seekers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>"}'
```

### get_moving_leads

Discover and return seeker profiles that have upcoming move dates, sourced from the sitemap. Fetches up to limit*3 seeker profiles and returns those with near-term move dates based on move date presence and keyword analysis. Each returned lead matches the get_seeker_details schema.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of qualified leads to return. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-flatmates-com-au-api-90c86daf/get_moving_leads \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>"}'
```

### get_seeker_details

Retrieve a seeker's full profile including move date, budget, preferred locations, accommodation preferences, and a potential-customer qualification flag. The seeker ID (F-prefixed) is required; if the prefix is omitted it is added automatically.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `seeker_id` | string | Yes | The unique ID of the person, prefixed with F (e.g. F4746278). If the F prefix is omitted it is added automatically. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-flatmates-com-au-api-90c86daf/get_seeker_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"seeker_id":"<string>"}'
```