Flatmates: Search
Search from Flatmates as JSON. 1 credit per successful call.
GET /v1/flatmates/search
Parameters
Send parameters in the query string.
| Parameter | Type | Required | Allowed values |
|---|---|---|---|
location | string | Required | Up to 80 characters |
page | integer | Optional | Any |
sort | string | Optional | cheapest, most-expensive, newest, earliest-available, recently-active |
property_type | string | Optional | share-houses, whole-properties, granny-flats, homestays, studios, 1-beds, student-accommodation |
bathroom_type | string | Optional | ensuite, ensuite-or-own |
min_budget | integer | Optional | Any |
max_budget | integer | Optional | Any |
stay_length | string | Optional | 1-week, 2-weeks, 3-weeks, 4-weeks, 2-months, 3-months, 6-months, 12-months |
room_type | string | Optional | private-room, shared-room |
gender | string | Optional | females, males, couples |
furnishings | string | Optional | furnished, unfurnished |
parking | string | Optional | no-parking, off-street-parking, on-street-parking |
bills_included | string | Optional | true, false, 1, 0 |
preferences | string | Optional | Up to 80 characters |
Example request
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.
Run this endpoint in the playground with your own parameters. 1 credit per successful call; failed calls are free.