flatmates.com.au APIflatmates.com.au ↗
Access structured room seeker profiles and property listings from Flatmates.com.au. Retrieve budgets, move dates, locations, and paginated property discovery.
curl -X GET 'https://api.parse.bot/scraper/51849592-0bb5-4823-91fd-7216a82c43c4/get_seeker_details?seeker_id=%3Cseeker_id%3E' \ -H 'X-API-Key: $PARSE_API_KEY'
Get detailed information about a room seeker profile, including move date, budget, preferred locations, and lifestyle preferences. Extracts structured data from the React props embedded in the seeker profile page.
| Param | Type | Description |
|---|---|---|
| seeker_idrequired | string | The unique ID of the person, prefixed with F (e.g. F4746278). If the F prefix is omitted it is added automatically. |
{
"type": "object",
"fields": {
"id": "string — seeker ID with F prefix",
"url": "string — full profile URL",
"name": "string — display name",
"budget": "string — weekly budget with dollar sign (e.g. $250)",
"about_me": "string — free-text description from the seeker",
"move_date": "string — when the seeker wants to move (e.g. Now)",
"stay_length": "string — intended stay duration (e.g. 3 months stay)",
"preferred_locations": "array of strings — suburb and postcode (e.g. Surry Hills, 2010)",
"is_potential_customer": "boolean — whether the seeker qualifies as a moving lead",
"potential_customer_reasons": "array of strings — reasons for qualification",
"preferred_accommodation_types": "array of strings — accommodation type labels"
},
"sample": {
"data": {
"id": "F4746278",
"url": "https://flatmates.com.au/F4746278",
"name": "Renato",
"budget": "$250",
"about_me": "Polite and quiet person",
"move_date": "Now",
"stay_length": "3 months stay",
"preferred_locations": [
"Surry Hills, 2010"
],
"is_potential_customer": true,
"potential_customer_reasons": [
"Move date: Now"
],
"preferred_accommodation_types": [
"Teamup"
]
},
"status": "success"
}
}About the flatmates.com.au API
The Flatmates.com.au API exposes 4 endpoints covering room seeker profiles and active property listings from Australia's largest flatmate-finding platform. Use get_seeker_details to pull structured profile data — including weekly budget, move date, and preferred suburbs — or use discover_seekers and discover_properties to paginate through the full catalogue of active listings. The get_moving_leads endpoint filters seekers by upcoming move dates for lead generation workflows.
Seeker Profile Data
The get_seeker_details endpoint accepts a seeker ID (e.g. F4746278 — the F prefix is added automatically if omitted) and returns a structured profile object. Fields include name, budget (weekly, formatted as a dollar string like $250), about_me (free-text self-description), move_date, stay_length, and preferred_locations as an array of suburb/postcode strings. Two qualification fields — is_potential_customer (boolean) and potential_customer_reasons (array) — indicate whether the seeker represents an active moving lead based on timeline and intent signals.
Lead Discovery
The get_moving_leads endpoint is purpose-built for identifying near-term movers. It accepts an optional limit parameter and returns a list of seeker detail objects — the same schema as get_seeker_details — filtered to those with imminent move dates. The response includes a count field alongside the leads array. For broader discovery, discover_seekers returns paginated seeker IDs (seeker_ids array plus total_count) using limit and offset parameters, letting you iterate through the full active seeker index.
Property Listing Discovery
The discover_properties endpoint paginates through active property listings. Each item in the properties array includes an id, url, and title field. Combined with total_count, the limit and offset parameters give you full control over traversal. This endpoint is useful for building indexes or monitoring new listings over time, though detailed per-property data (room count, amenities, photos) is not returned at this layer.
- Build a moving-lead pipeline using
get_moving_leadsto surface seekers with near-term move dates and weekly budgets above a threshold. - Monitor new room seeker registrations by paginating
discover_seekerswithoffsetand comparing against a locally stored ID list. - Enrich a property management CRM by pairing
preferred_locationssuburb data from seeker profiles with your available listings. - Track active property listing counts over time using
discover_propertieswithtotal_countas a market signal for Sydney or Melbourne rental demand. - Filter qualified tenant leads by
stay_lengthandbudgetfields fromget_seeker_detailsto match against minimum lease requirements. - Index all active property listing URLs from
discover_propertiesfor downstream processing or availability monitoring.
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 250 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does Flatmates.com.au have an official developer API?+
What does `get_seeker_details` return beyond basic contact info?+
get_seeker_details returns structured fields including budget (weekly dollar amount), move_date, stay_length, preferred_locations (suburb + postcode pairs), a free-text about_me field, and two lead-qualification fields: is_potential_customer (boolean) and potential_customer_reasons (array of strings explaining the qualification).Does the API return full property details — room count, amenities, or photos — for individual listings?+
discover_properties endpoint returns id, url, and title per listing, and discover_seekers returns seeker IDs. Full per-property detail fields are not exposed at this layer. You can fork this API on Parse and revise it to add a property detail endpoint that returns those fields.How does pagination work across the discovery endpoints?+
discover_seekers and discover_properties accept limit and offset integer parameters. Each response also returns a total_count field so you can calculate how many pages remain. There is no cursor-based pagination; you increment offset by limit to walk through the full dataset.Is seeker profile data available for all Australian cities, or is coverage limited?+
preferred_locations field reflects only what seekers have entered on their profiles — not all profiles include location preferences, and data freshness depends on when listings were last active on the site.