Skip to content
Scrappa Get API key
Flatmates API 1 credit/request

Flatmates Listing Detail API Documentation

GET https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574

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.

Flatmates Listing Detail API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "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.",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

This endpoint has no required query parameters.

3 optional filters available.

url string Optional
Open example

The link of a search result, for example https://flatmates.com.au/share-house-sydney-balgowlah-2093-P1432574.

Example value https://flatmates.com.au/share-house-sydney-balgowlah-2093-P1432574
id integer Optional

Numeric listing id. Use with slug when you have no url.

Example value 1234567890
slug string Optional

Listing slug without the -P{id} suffix, for example share-house-sydney-balgowlah-2093.

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/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"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK
{
    "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

Handle these documented responses before retrying or showing customer-facing failures.

404

Not Found

No room listing exists at that link (`not_found`). Non-billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false,
        "endpoint_family": "listing"
    },
    "error": {
        "code": "not_found",
        "message": "Flatmates has no record for that location or listing."
    },
    "success": false
}
422

Validation Error

A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored. Non-billable.

{
    "errors": {
        "sort": [
            "The selected sort is invalid."
        ]
    },
    "message": "The selected sort is invalid."
}
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.

{
    "meta": {
        "attempts": 3,
        "billable": false,
        "retryable": true,
        "endpoint_family": "listing"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "Flatmates is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.