Sign inGet a free API keyDashboard
Menu

APIs / Real estate / Flatmates

1 credit per call3 endpoints21 datapoints

Flatmates API

Flatmates API for Australian share house and rental search, room listings and location autocomplete as JSON, with rent and bills. 1 credit per successful call.

Get a free API keyRun it below
Flatmates
GET/v1/flatmates/search?location=sydney&property_type=share-houses&bathroom_type=ensuite&min_budget=200&max_budget=300
{
  "success": true,
  "data": [
    {
      "id": 1100563,
      "link": "https://flatmates.com.au/share-house-sydney-croydon-2132-P1100563",
      "listing_kind": "property",
      "tile_kind": "premium",
      "label": "Boosted",
      "title": "<a href=\"/croydon-2132\">Croydon</a>, <a href=\"/sydney\">Sydney</a>",
      "subtitle": "Room with ensuite in a share house",
      "summary": "2 Rooms in Share House",
      "description": "*FEMALE ONLY*\r\n\r\nCosy, light-filled rooms. It’s a super short walking distance to Croydon train station and the best strip of Cafe’s, restaurants, grocery shops and amenities. Not to mention off street and unmetered on street parking.\r\nLets…",
      "rent": {
        "display": "$290-360",
        "min": 290,
        "max": 360,
        "currency": "AUD",
        "period": "week",
        "price_valid": true
      },
      "bills": "inc. bills",
      "date_available": "Available 17 November 2026",
      "suburb": "Croydon, Sydney",
      "locality": "Sydney",
      "distance": "8.76 km",
      "bedrooms": 3,
      "bathrooms": 2,
      "occupants": 3,
      "photo": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/npsupga39nybcie3trg1",
      "photos": [
        {
          "mobile": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/npsupga39nybcie3trg1",
          "desktop": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_360,q_auto,w_640/v1/user_property/npsupga39nybcie3trg1"
        },
        {
          "mobile": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/zdobntyaqgeirdcejvoo",
          "desktop": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_360,q_auto,w_640/v1/user_property/zdobntyaqgeirdcejvoo"
        },
        {
          "mobile": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/w0lgn1qnkktvkxxqfrrj",
          "desktop": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_360,q_auto,w_640/v1/user_property/w0lgn1qnkktvkxxqfrrj"
        }
      ],
      "activated_at": "2026-11-11T23:26:57.883Z"
    },
    {
      "id": 539678,
      "link": "https://flatmates.com.au/share-house-sydney-telopea-2117-P539678",
      "listing_kind": "property",
      "tile_kind": "premium",
      "label": "Boosted",
      "title": "<a href=\"/people/telopea-2117\">Telopea</a>, <a href=\"/people/sydney\">Sydney</a>",
      "subtitle": "Furnished room with ensuite in a share house",
      "summary": "1 Room in Share House",
      "description": "LARGE bedroom with its own big bathroom and  Price is  $290 for a single Person . \r\nBedroom furnished with large inbuilt wardrobe and Queen Bed . \r\n\r\nYour own Large bathroom with a large shower head.  But bathroom is external not inside the…",
      "rent": {
        "display": "$290",
        "min": 290,
        "max": 290,
        "currency": "AUD",
        "period": "week",
        "price_valid": true
      },
      "bills": "inc. bills",
      "date_available": "Available now",
      "suburb": "Telopea, Sydney",
      "locality": "Sydney",
      "distance": "17.1 km",
      "bedrooms": 5,
      "bathrooms": 4,
      "occupants": 5,
      "photo": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/ekpfih4pw06q62qlbnrw",
      "photos": [
        {
          "mobile": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/ekpfih4pw06q62qlbnrw",
          "desktop": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_360,q_auto,w_640/v1/user_property/ekpfih4pw06q62qlbnrw"
        },
        {
          "mobile": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/dxwdknt0cyyec4nqn5nf",
          "desktop": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_360,q_auto,w_640/v1/user_property/dxwdknt0cyyec4nqn5nf"
        },
        {
          "mobile": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/kgnpyfe2ugil3piog5lq",
          "desktop": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_360,q_auto,w_640/v1/user_property/kgnpyfe2ugil3piog5lq"
        }
      ],
      "activated_at": "2026-11-09T11:06:46.577Z"
    },
    {
      "id": 2047172,
      "link": "https://flatmates.com.au/share-house-sydney-revesby-2212-P2047172",
      "listing_kind": "property",
      "tile_kind": "premium",
      "label": "Boosted",
      "title": "<a href=\"/revesby-2212\">Revesby</a>, <a href=\"/sydney\">Sydney</a>",
      "subtitle": "Furnished room with ensuite in a share house",
      "summary": "6 Rooms in Share House",
      "description": "🏡 Beautiful Brand New Setup in Revesby | Ensuite & Private Rooms | Next to Train Station\r\n\r\nLooking for more than just a room? Somewhere you can genuinely feel at home? ❤️\r\n\r\n✨ Why You’ll Love This Place\r\n\r\n📍 Fantastic location in Revesby…",
      "rent": {
        "display": "$300-400",
        "min": 300,
        "max": 400,
        "currency": "AUD",
        "period": "week",
        "price_valid": true
      },
      "bills": "inc. bills",
      "date_available": "Available now",
      "suburb": "Revesby, Sydney",
      "locality": "Sydney",
      "distance": "20.1 km",
      "bedrooms": 6,
      "bathrooms": 4,
      "occupants": 4,
      "photo": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/odtbfjuqx9bb9pnd4bpn",
      "photos": [
        {
          "mobile": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/odtbfjuqx9bb9pnd4bpn",
          "desktop": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_360,q_auto,w_640/v1/user_property/odtbfjuqx9bb9pnd4bpn"
        },
        {
          "mobile": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/eo2x3fledhkel2koarvx",
          "desktop": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_360,q_auto,w_640/v1/user_property/eo2x3fledhkel2koarvx"
        },
        {
          "mobile": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/ywyarrs1rjx8fia4j3lx",
          "desktop": "https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_360,q_auto,w_640/v1/user_property/ywyarrs1rjx8fia4j3lx"
        }
      ],
      "activated_at": "2026-11-07T12:09:46.515Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 12,
    "returned": 12,
    "filtered_out": 0,
    "has_more": true,
    "next_page": 2
  },
  "applied_filters": {
    "location": "sydney",
    "property_type": "share-houses",
    "bathroom_type": "ensuite",
    "min_budget": 200,
    "max_budget": 300
  },
  "meta": {
    "endpoint_family": "search",
    "attempts": 1,
    "request_id": "req_dd8542a7f7fa42caa1dd355edcdf27f9",
    "credits_charged": 1,
    "credits_remaining": 1871
  }
}
200 OKJSONX-Credits-Used: 1
Recorded from our API and shortened.

Sample data

What one call returns

A recorded run of search: the fields and shapes you will get, shortened to 3 items.

#idintegerlinkurllisting_kindstringtile_kindstringlabelstringtitlestringsubtitlestringsummarystringdescriptionstringrentobjectbillsstringdate_availablestringsuburbstringlocalitystringdistancestringbedroomsintegerbathroomsintegeroccupantsintegerphotourlphotosobject[]activated_atstring
11100563https://flatmates.com.au/share-house-sydney-croydon-2132-P1100563propertypremiumBoosted<a href="/croydon-2132">Croydon</a>, <a href="/sydney">Sydney</a>Room with ensuite in a share house2 Rooms in Share House*FEMALE ONLY* Cosy, light-filled rooms. It’s a super short walking distance to Croydon train station and the best strip of Cafe’s, restaurants, grocery shops and amenities. Not to mention off street and unmetered on street parking. Lets…{6 fields}inc. billsAvailable 17 November 2026Croydon, SydneySydney8.76 km323https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/npsupga39nybcie3trg1[3 items]2026-11-11T23:26:57.883Z
2539678https://flatmates.com.au/share-house-sydney-telopea-2117-P539678propertypremiumBoosted<a href="/people/telopea-2117">Telopea</a>, <a href="/people/sydney">Sydney</a>Furnished room with ensuite in a share house1 Room in Share HouseLARGE bedroom with its own big bathroom and Price is $290 for a single Person . Bedroom furnished with large inbuilt wardrobe and Queen Bed . Your own Large bathroom with a large shower head. But bathroom is external not inside the…{6 fields}inc. billsAvailable nowTelopea, SydneySydney17.1 km545https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/ekpfih4pw06q62qlbnrw[3 items]2026-11-09T11:06:46.577Z
32047172https://flatmates.com.au/share-house-sydney-revesby-2212-P2047172propertypremiumBoosted<a href="/revesby-2212">Revesby</a>, <a href="/sydney">Sydney</a>Furnished room with ensuite in a share house6 Rooms in Share House🏡 Beautiful Brand New Setup in Revesby | Ensuite & Private Rooms | Next to Train Station Looking for more than just a room? Somewhere you can genuinely feel at home? ❤️ ✨ Why You’ll Love This Place 📍 Fantastic location in Revesby…{6 fields}inc. billsAvailable nowRevesby, SydneySydney20.1 km644https://flatmates-res.cloudinary.com/image/upload/c_fill,dpr_2.0,f_auto,h_342,q_auto,w_414/v1/user_property/odtbfjuqx9bb9pnd4bpn[3 items]2026-11-07T12:09:46.515Z

Recorded from our API · 3 items shown · 21 datapoints per itemGET /v1/flatmates/search?location=sydney&property_type=share-houses&bathroom_type=ensuite&min_budget=200&max_budget=300

21 datapoints

Identity

  • idinteger
  • titlestring
  • subtitlestring

Contact

  • linkurl

Reputation

  • photourl
  • photosobject[]

Other

  • listing_kindstring
  • tile_kindstring
  • labelstring
  • summarystring
  • descriptionstring
  • rentobject
  • billsstring
  • date_availablestring
  • suburbstring
  • localitystring
  • distancestring
  • bedroomsinteger
  • bathroomsinteger
  • occupantsinteger
  • activated_atstring

Playground

Run this API

cURLshell
curl "https://api.perceptlayer.com/v1/flatmates/search?location=sydney&property_type=share-houses&bathroom_type=ensuite&min_budget=200&max_budget=300" \
  -H "X-API-Key: $API_KEY"

Flatmates · 3 endpoints

Endpoints

Every endpoint takes the same key. Open one for its parameters and an example request.

EndpointRequired parametersCost
GET/v1/flatmates/listing
none+3 optional
1 credit
GET/v1/flatmates/location-autocomplete
query+2 optional
1 credit
GET/v1/flatmates/search
location+13 optional
1 credit

Overview

What you can get

The Flatmates API returns Australian share house and rental data from Flatmates as JSON through 3 endpoints.

  • Search: search takes a location, with page, sort (cheapest, most-expensive, newest, earliest-available or recently-active), property_type (share-houses, whole-properties, granny-flats, homestays, studios, 1-beds or student-accommodation), bathroom_type (ensuite or ensuite-or-own), min_budget, max_budget, stay_length (1-week to 12-months), room_type (private-room or shared-room), gender (females, males or couples), furnishings (furnished or unfurnished), parking (no-parking, off-street-parking or on-street-parking), bills_included and preferences.
  • Listings: listing takes a url, id or slug.
  • Locations: location-autocomplete takes a query, with type (suburb, city, train_station or university) and limit.

The recorded search for share houses in Sydney with an ensuite and a weekly budget of 200 to 300 returns data, each item with id, link, listing_kind, title, subtitle, summary, description, rent (with min, max, currency and period), bills, date_available, suburb, distance, bedrooms, bathrooms, occupants, photos and activated_at. It also returns pagination with page_size, has_more and next_page, plus applied_filters.

How a call works

Search a city: GET /v1/flatmates/search?location=sydney&property_type=share-houses&bathroom_type=ensuite&min_budget=200&max_budget=300 with your key in the X-API-Key header. Each item's link is a listing URL that listing takes as url. Ask for next_page while has_more is true. Every successful call costs 1 credit; failed calls cost nothing.

Real estateJSONRESTMCP

More real estate APIs

28Hse4zida59199.co99acresAdondevivirApartment ListApartments.comAqarAqarmapArgenpropathome

Use cases

Track weekly room rents by suburb in Sydney, Melbourne and other Australian cities

Use the Flatmates API to track weekly room rents by suburb in Sydney, Melbourne and other Australian cities

Find rooms near a university or train station with `location-autocomplete`

Use the Flatmates API to find rooms near a university or train station with `location-autocomplete`

Compare share houses with and without bills included

Use the Flatmates API to compare share houses with and without bills included

Watch rooms coming up with `sort=earliest-available`

Use the Flatmates API to watch rooms coming up with `sort=earliest-available`

FAQ

Questions

Do I need a Flatmates account?

No. You call this Flatmates API with your Perceptlayer key in the `X-API-Key` header, with no Flatmates login.

How much does the Flatmates API cost?

Each successful call costs one credit. New accounts get free credits to start, and credit packs bring the price down as you scale.

What format are responses in?

Every endpoint returns JSON, with no HTML parsing on your side.

Are rents weekly?

In the recorded search, each `rent` carries a `period` of week, with `min`, `max` and `currency` (AUD). Read `period` rather than assuming it.

Should I build a Flatmates scraper instead?

You can, but a Flatmates scraper is code you maintain: page changes break it, requests get blocked, and Flatmates's terms govern how you collect data. The Flatmates API gives you 3 endpoints of named JSON fields for 1 credit per successful call, and failed calls cost nothing. A scraper makes sense only for data these endpoints don't return, so check the response in the playground on this page first.

Try the Flatmates API with 100 free credits

No credit card. Failed calls are never billed.

Get a free API keyRead the docs