Flatmates.com.au API
Search

GET/search/surrounding

Flatmates.com.au /search/surrounding API

Build powerful real estate tools with RealtyAPI's /search/surrounding endpoint. Get Flatmates.com.au data programmatically without worrying about rate limits, IP blocks, or constantly breaking selectors. Our engineering team maintains the underlying infrastructure around the clock — monitoring for changes, optimizing request paths, and ensuring data accuracy — so you can treat real estate data as a reliable, always-available resource. The endpoint returns well-structured JSON with consistent field names and data types, making it straightforward to map responses to your application's data models. From solo developers to enterprise teams, thousands of customers trust this endpoint for their production data needs.

99.9% Uptime
|Real-Time Data|JSON Output

quick-start.py

import requests

url = "https://flatmates.realtyapi.io/search/surrounding"

headers = {
    "x-realtyapi-key": "YOUR_API_KEY"
}

params = {
    "location": "Sydney"
}

response = requests.get(url, headers=headers, params=params)
data = response.json()
print(data)

200 OK·application/json

Endpoint Reference

What You Can Do With
the /search/surrounding Endpoint.

Here's what this endpoint provides and how you can use the data it returns.

Endpoint Parameters

22 params

Parameter	Type	Required	Description
`location`	STRING	Required	Suburb, city, university or postcode to expand around. Comma-separate for multiple.
`searchType`	ENUM	Optional	Listing type: `rooms` (rooms/whole properties available), `people` (people looking for a place), or `teamups` (groups looking together). Default `rooms`. Values: `rooms, people, teamups`
`page`	NUMBER	Optional	Page number, 1-based. ~12 results per page (fixed upstream); use the `nextPage` flag to advance.
`sort`	ENUM	Optional	Result ordering. Default `featured`. Values: `featured, newest, cheapest, mostExpensive, earliestAvailable, moveEarliest, lowestBudget, recentlyActive`
`budgetRange`	STRING	Optional	Weekly rent/budget in AUD. Use `min:200`, `max:450`, or `min:200,max:450`.
`numberOfBedroom`	NUMBER	Optional	Exact bedroom count (property listings only).
`propertyType`	STRING	Optional	One or more, comma-separated: `granny_flat`, `homestay`, `one_bed`, `share_house`, `shared_room`, `student_accommodation`, `studio`, `whole_property`.
`roomType`	STRING	Optional	`private_room` or `shared_room`.
`bathroomType`	STRING	Optional	`ensuite` or `own`.
`furnishingType`	STRING	Optional	`furnished` or `unfurnished`.
`parkingType`	STRING	Optional	`no_parking`, `off_street_parking` or `on_street_parking`.
`billsIncluded`	BOOLEAN	Optional	Only listings with bills included in the rent.
`propertyAcceptGenderType`	STRING	Optional	Who the property accepts: `couples`, `females` or `males`.
`propertyAcceptTypes`	STRING	Optional	Comma-separated: `backpackers`, `children`, `lgbt_friendly`, `over_40`, `pets`, `retirees`, `smokers`, `students`.
`flatmateGenderType`	STRING	Optional	People mode — gender: `couples`, `female`, `male` or `no_couples`.
`personProfessionTypes`	STRING	Optional	People mode — comma-separated: `backpacker`, `full_time`, `part_time`, `retired`, `student`, `unemployed`, `working_holiday`.
`flatmatePreferenceTypes`	STRING	Optional	People mode — comma-separated: `have_kids`, `have_pets`, `lgbt`, `no_kids`, `no_pets`, `non_smokers`, `smoker`.
`allFemale`	BOOLEAN	Optional	People mode — all-female households only.
`ageRange`	STRING	Optional	People mode — age range, e.g. `min:20,max:35`.
`lengthOfStay`	STRING	Optional	`one_week`, `two_weeks`, `four_weeks`, `six_weeks`, `two_months`, `three_months`, `four_months`, `six_months`, `nine_months` or `one_year`.
`dateAvailable`	STRING	Optional	Available-from date, `YYYY-MM-DD`.
`keywords`	STRING	Optional	Free-text keyword filter.

Required Parameters

This endpoint requires location to fetch data. Pass these as query parameters in your request.

JSON Response

Receive structured JSON containing /search/surrounding data from Flatmates.com.au. Parse it directly into your application models.

Real-Time Results

Every request fetches live Flatmates.com.au data. No stale caches — you always get the most current information available.

Error Handling

Clear HTTP status codes and error messages help you handle edge cases gracefully. See our documentation for the full error reference.

What You Can Build

/search/surrounding Endpoint Use Cases.

Real-world applications that leverage the /search/surrounding endpoint for Flatmates.com.au data.

Data Analysis

Analyze /search/surrounding data from Flatmates.com.au to gain insights and make data-driven decisions about real estate markets.

Market Monitoring

Monitor Flatmates.com.au /search/surrounding data to track changes, pricing trends, and market movements in real time.

Application Integration

Integrate /search/surrounding data from Flatmates.com.au into your web applications, mobile apps, or internal tools.

Workflow Automation

Automate data collection and processing workflows using Flatmates.com.au /search/surrounding data to improve team efficiency.

Reporting & Analytics

Generate reports and dashboards using Flatmates.com.au /search/surrounding data for stakeholders, investors, or clients.

Custom Solutions

Build custom real estate solutions that leverage Flatmates.com.au /search/surrounding data for your specific business needs.

Frequently Asked Questions

Common questions about the /search/surrounding endpoint.

Is the /search/surrounding endpoint official?

No, RealtyAPI provides an unofficial /search/surrounding endpoint that lets you access Flatmates.com.au data through our platform. We handle the complexities of data collection so you can focus on building your application.

How current is the data?

We provide real-time /search/surrounding data from Flatmates.com.au. When you make a request, we fetch the latest information available.

Can I use this endpoint in production?

Absolutely. Many businesses rely on RealtyAPI's endpoints for their production applications. Our infrastructure is designed for reliability and performance.

What happens if I exceed my API limit?

On paid plans, you can enable overage billing so your application keeps working. Free plan users can upgrade at any time to increase their quota.

Is there rate limiting?

Rate limits vary by plan. Free tier allows up to 10 requests per second. Paid plans offer higher limits suitable for production workloads.

What programming languages are supported?

RealtyAPI is a standard REST API, so it works with any language that can make HTTP requests: Python, JavaScript, Go, PHP, Ruby, Java, C#, and more.

Other Flatmates.com.au Endpoints

GET/details/byid GET/details/byurl GET/search/bylocation GET/search/byurl GET/member/listings GET/autocomplete GET/filters

No credit card required

Ready to integrate the
/search/surrounding endpoint?

Get started with 250 free API calls. No credit card required.

Common Terms for /search/surrounding Endpoint Access

Flatmates.com.au /search/surrounding API integration/search/surrounding data APIAccess /search/surrounding data programmaticallyFlatmates.com.au /search/surrounding API for developers/search/surrounding API endpoint/search/surrounding API documentationHow to use Flatmates.com.au /search/surrounding APIFlatmates.com.au /search/surrounding API wrapper/search/surrounding real estate dataFlatmates.com.au /search/surrounding REST API

Flatmates.com.au /search/surrounding API

What You Can Do With
the /search/surrounding Endpoint.

Endpoint Parameters

Required Parameters

JSON Response

Real-Time Results

Error Handling

Why Choose RealtyAPI's
/search/surrounding Endpoint.

Real-Time Data Access

Simple Integration

High Reliability

Comprehensive Data

/search/surrounding Endpoint Use Cases.

Data Analysis

Market Monitoring

Application Integration

Workflow Automation

Reporting & Analytics

Custom Solutions

Frequently Asked Questions

Other Flatmates.com.au Endpoints

Ready to integrate the
/search/surrounding endpoint?

Common Terms for /search/surrounding Endpoint Access

Flatmates.com.au /search/surrounding API

What You Can Do Withthe /search/surrounding Endpoint.

Endpoint Parameters

Required Parameters

JSON Response

Real-Time Results

Error Handling

Why Choose RealtyAPI's/search/surrounding Endpoint.

Real-Time Data Access

Simple Integration

High Reliability

Comprehensive Data

/search/surrounding Endpoint Use Cases.

Data Analysis

Market Monitoring

Application Integration

Workflow Automation

Reporting & Analytics

Custom Solutions

Frequently Asked Questions

Other Flatmates.com.au Endpoints

Ready to integrate the/search/surrounding endpoint?

Common Terms for /search/surrounding Endpoint Access

What You Can Do With
the /search/surrounding Endpoint.

Why Choose RealtyAPI's
/search/surrounding Endpoint.

Ready to integrate the
/search/surrounding endpoint?