# Flatmates Listing Detail API Documentation

Scrappa's `GET /api/flatmates/listing` returns the full record of one Flatmates.com.au room listing.

## Input

Pass `url` with the `link` from a search result. Or pass `slug` and `id` (the listing link is `{slug}-P{id}`). Only flatmates.com.au room listing links are accepted; any other host returns `422`.

## What you get

Type, property type, status, `activated_at`, titles, the description as HTML and as plain text, key features, parking, internet, accessibility features, preferences and inspection status. Every `rooms[]` entry has `rent`, `deposit`, `deposit_amount`, bills, electricity, water, gas and internet terms, bed size, room, bathroom and furnishing type, `date_available`, `min_stay`, `max_stay` (weeks) and room features. `images[]` has `url` and `url_large`. `lister` has the first name, `last_online`, `response_rate`, `mobile_verified` and the verified social providers.

## Location precision

`location` has state, city, suburb, postcode and key. Flatmates hides the street, so `address` is usually `null` and `latitude` and `longitude` point to the suburb centre (`precision: suburb`).

## Lister

Flatmates has no public agent or agency profile page. The `lister` block is everything it shows publicly.

- **Documentation:** [https://scrappa.co/docs/flatmates-api/flatmates_listing](https://scrappa.co/docs/flatmates-api/flatmates_listing)
- **API group:** Flatmates API
- **Endpoint:** `GET https://scrappa.co/api/flatmates/listing`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | No | The link of a search result, for example https://flatmates.com.au/share-house-sydney-balgowlah-2093-P1432574. |
| `id` | integer | No | Numeric listing id. Use with slug when you have no url. |
| `slug` | string | No | Listing slug without the -P{id} suffix, for example share-house-sydney-balgowlah-2093. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574"
```

## Example response

```json
{
    "success": true,
    "data": {
        "id": 1308391,
        "link": "https://flatmates.com.au/student-accommodation-sydney-camperdown-2050-P1308391",
        "type": "PROPERTY",
        "property_type": "student-accommodation",
        "status": "active",
        "activated_at": "2026-10-26T03:05:14.981Z",
        "page_title": "Student Accommodation for Rent in Camperdown, Sydney | $510, Furnished, Ensuite",
        "title": "Camperdown, Sydney",
        "subtitle": "Student accommodation for rent",
        "description": "<p>Private unit close to Newtown.</p>",
        "description_text": "Private unit close to Newtown.",
        "household_description": "Private studio",
        "key_features": {
            "property_type": "Student accommodation",
            "bedroom_count": 1,
            "bathroom_count": 1,
            "occupant_count": 1
        },
        "parking": "off-street-parking",
        "parking_description": "Off street parking",
        "internet": "internet-included",
        "internet_description": "Included in rent",
        "accessibility_features": [],
        "preferences": [
            {
                "title": "Students",
                "key": "students"
            }
        ],
        "rooms": [
            {
                "id": 2020539,
                "status": "available",
                "rent": 510,
                "deposit": 2,
                "deposit_amount": 1020,
                "bills": "included",
                "room_type": "private-room",
                "bathroom_type": "ensuite",
                "furnishings": "furnished",
                "date_available": "2026-11-24",
                "min_stay": 26,
                "room_features_attributes": [
                    "air-conditioner",
                    "wardrobe",
                    "desk"
                ]
            }
        ],
        "location": {
            "state": "NSW",
            "city": "Sydney",
            "suburb": "Camperdown",
            "postcode": "2050",
            "country": "AU",
            "key": "camperdown-2050",
            "address": null,
            "latitude": -33.8942,
            "longitude": 151.1764,
            "precision": "suburb"
        },
        "images": [
            {
                "url": "https://flatmates-res.cloudinary.com/image/upload/example-small.jpg",
                "url_large": "https://flatmates-res.cloudinary.com/image/upload/example-large.jpg",
                "main": true
            }
        ],
        "inspection": {
            "status": "accepting",
            "timezone": "Australia/Sydney",
            "fully_booked": false,
            "not_accepting": false
        },
        "lister": {
            "first_name": "Anthony",
            "last_online": "Online Today",
            "response_rate": 95.5,
            "mobile_verified": true,
            "verified_providers": [
                "facebook",
                "instagram"
            ],
            "image_url": null
        }
    },
    "meta": {
        "endpoint_family": "listing",
        "billable": true,
        "attempts": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | No room listing exists at that link (`not_found`). Non-billable. |
| 422 | Validation Error | A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored. Non-billable. |
| 503 | Upstream Unavailable | Flatmates could not be reached after retries or answered with something unusable (`upstream_unavailable`, `upstream_blocked`, `parser_drift`). Retryable and never billed. Clients are never rate limited. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)