Sign in Get API key
Flatmates API

Australian Rooms, Shared Rentals, Listing Details and Suburbs

Scrappa's read-only Flatmates API turns Flatmates.com.au into structured JSON. Search rooms and shared rentals across Australia by location, property type, bathroom type, weekly budget and stay length; read full listing details with rooms, deposit, bills, features, images and lister info; and find the suburbs the search accepts. Flatmates lists rentals only.

500 free credits
No card needed
From $0.20 / 1k
Pay as you go
Structured JSON
Ready for apps
API key access
Test in minutes
Start for free View documentation
Browse endpoints Try first endpoint
3
Endpoints
Australia
Market
AUD per week
Rents

Try it now

Make one request. Inspect structured JSON.

Use the first endpoint in this API family with a Scrappa API key. Every account includes 500 free monthly credits, so you can validate the response shape before buying credits.

Get free API key Try in Playground Open docs
Request preview
Request 
curl -X GET "https://scrappa.co/api/flatmates/search?location=sydney&property_type=share-houses&min_budget=200&max_budget=300" \
  -H "Accept: application/json" \
  -H "X-API-KEY: YOUR_API_KEY"
JSON response 
{
  "success": true,
  "data": [],
  "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",
    "min_budget": 200,
    "max_budget": 300
  },
  "meta": {
    "endpoint_family": "search",
    "billable": true,
    "attempts": 1
  }
}

What you can build

Structured data for real applications. Here are some ideas.

Room Search Applications

Build Australian room and share house search with filters for location, property type, bathroom type and weekly budget.

Rent Monitoring

Track weekly room rents by city and suburb with cheapest, newest and earliest-available sorting.

Listing Data Enrichment

Pull the full record of a room: rent, deposit, bills, bed size, furnishings, stay limits, preferences and images.

Student and Relocation Tools

Help students and newcomers compare suburbs with autocomplete keys and average rents.

Flatmates scraper API

Flatmates API for room search, listing details and suburbs in Australia

The Flatmates API is built for proptech teams, student housing services and analysts working with Australian shared rentals. Search rooms by location and weekly budget, then use listing details and suburb autocomplete to build search tools, rent monitors and data products.

Search rooms and shares across Australia.

Filter by property type, room type, bathroom, gender, furnishings, parking, bills, preferences, weekly budget and stay length.

Sort by price, newest, earliest available or recent activity.

Get full listing details with rooms, deposit, bills and images.

Find suburb, station and university keys with autocomplete.

Call 3 read-only endpoints that return structured JSON.

Choose the right Flatmates API endpoint

Search Flatmates rooms

Find a suburb key with location autocomplete, then pass it to the search endpoint with a weekly budget. Filters are checked, and rooms outside your budget are removed.

Open Flatmates Room Search API docs

Read the full record of a room

Take the link from a search result and request the listing endpoint for rooms, deposit, bills, features, images and the lister summary.

Open Flatmates Listing Details API docs

Available endpoints

Everything you need in one API.

Related resources

Realestate.com.au API overview

Add Australian homes for sale and rent from realestate.com.au.

Domain.com.au API overview

Add Australian listings from Domain.

Scrappa vs Do-it-yourself rental data extraction

See how Scrappa compares to the official API.

Dedicated Flatmates endpoints
Scrappa: yes (3 endpoints)
Do-it-yourself rental data extraction:
Output format
Scrappa: Structured JSON
Do-it-yourself rental data extraction: Raw page content
Unknown filters and locations
Scrappa: Rejected with a clear error
Do-it-yourself rental data extraction: Silently ignored by the platform
Bot protection
Scrappa: Handled by Scrappa
Do-it-yourself rental data extraction: Your team
Request mode
Scrappa: Read-only
Do-it-yourself rental data extraction: Depends on implementation

Key features

3 read-only endpoints for Australia
Rooms and shared rentals only
Filters for property type, room, bathroom, gender, furnishings, parking, bills, preferences, budget and stay length
Full listing details with rooms, deposit, bills and images
Autocomplete for suburbs, cities, stations and universities with search-ready keys
No contact data or private data

Frequently asked questions

The Flatmates API is Scrappa's read-only REST API for rooms and shared rentals on Flatmates.com.au. It covers search, listing details and suburb autocomplete.

No. Scrappa is an independent service and is not affiliated with or endorsed by Flatmates. A Scrappa API key is used to access the endpoints on this page.

No. Flatmates lists rentals and shares only, and it has no public agent or agency profile page.

The API removes rooms whose weekly rent lies outside your budget. The page number and has_more still follow Flatmates, and pagination.filtered_out shows how many rooms were removed.

No. All Flatmates endpoints on this page are read-only.

Start using the Flatmates API

Sign up and get 500 free credits. No credit card required.

Create Free Account View Documentation