{ "openapi": "3.0.1", "info": { "title": "Flatmates.com.au Scraper โ€” Australia Share Accommodation Data", "description": "Extract Australian flatshare and share-accommodation listings into clean structured data. Search rooms for rent, people looking, and team-ups by suburb, city or university; get weekly rent, room specs, household details, geo and lister info. Bulk, paginated, API-ready.", "version": "1.0", "x-build-id": "nnnnfh5cdOgh972UV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~flatmates-au-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-flatmates-au-property-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/sian.agency~flatmates-au-property-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-flatmates-au-property-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/sian.agency~flatmates-au-property-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-flatmates-au-property-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "๐Ÿงญ Mode", "enum": [ "searchByLocation", "searchSurrounding", "searchByUrl", "listingDetail", "memberListings", "autocomplete", "filters" ], "type": "string", "description": "What to scrape. `searchByLocation` searches a place; `searchSurrounding` widens a thin suburb; `searchByUrl` runs a Flatmates results URL; `listingDetail` fetches full detail for listing ids/URLs; `memberListings` lists all of one member's listings; `autocomplete` resolves text to a location; `filters` returns the accepted filter values.", "default": "searchByLocation" }, "location": { "title": "๐Ÿ“ Location", "type": "string", "description": "Suburb, city, university, transit stop or postcode to search (used by Search by location / Search surrounding). e.g. `Sydney`, `Surry Hills 2010`, `University of Melbourne`.", "default": "Sydney" }, "locations": { "title": "๐Ÿ“ Locations (bulk, PAID)", "type": "array", "description": "Multiple locations to search in one run. Requires a paid Apify plan. Overrides the single Location field when provided.", "items": { "type": "string" } }, "searchType": { "title": "๐Ÿ  Search type", "enum": [ "rooms", "people", "teamups" ], "type": "string", "description": "`rooms` = rooms/properties available ยท `people` = people looking for a place ยท `teamups` = groups looking together. Applies to all search modes.", "default": "rooms" }, "searchUrls": { "title": "๐Ÿ”— Results URLs", "type": "array", "description": "Flatmates.com.au results URLs to scrape (used by Search by results URL). e.g. `https://flatmates.com.au/rooms/melbourne`.", "items": { "type": "string" } }, "listingIds": { "title": "๐Ÿ†” Listing ids / URLs", "type": "array", "description": "Listing ids, links or full listing URLs to fetch full detail (used by Listing detail). Accepts `1645009`, `P1645009`, `F4211214`, a full slug, or a flatmates.com.au listing URL.", "items": { "type": "string" } }, "memberIds": { "title": "๐Ÿ‘ค Member ids", "type": "array", "description": "Member ids to list all active listings for (used by Member's listings). Take a `memberId` from any listing detail.", "items": { "type": "string" } }, "autocompleteInput": { "title": "๐Ÿ”Ž Autocomplete text", "type": "string", "description": "Free text to resolve to a location key (used by Autocomplete). e.g. `Bondi`, `UNSW`." }, "sort": { "title": "โ†•๏ธ Sort", "enum": [ "cheapest", "mostExpensive", "newest", "featured", "earliestAvailable", "moveEarliest", "lowestBudget", "recentlyActive" ], "type": "string", "description": "Result ordering for search modes." }, "budgetMin": { "title": "๐Ÿ’ฐ Budget min (weekly AUD)", "minimum": 0, "type": "integer", "description": "Minimum weekly rent/budget in AUD (search modes)." }, "budgetMax": { "title": "๐Ÿ’ฐ Budget max (weekly AUD)", "minimum": 0, "type": "integer", "description": "Maximum weekly rent/budget in AUD (search modes)." }, "propertyType": { "title": "๐Ÿ˜ Property type", "enum": [ "granny_flat", "homestay", "one_bed", "share_house", "shared_room", "student_accommodation", "studio", "whole_property" ], "type": "string", "description": "Filter rooms searches by property type." }, "roomType": { "title": "๐Ÿ› Room type", "enum": [ "private_room", "shared_room" ], "type": "string", "description": "Private room or shared room." }, "furnishingType": { "title": "๐Ÿ›‹ Furnishing", "enum": [ "furnished", "unfurnished" ], "type": "string", "description": "Furnished or unfurnished." }, "billsIncluded": { "title": "๐Ÿงพ Bills included", "enum": [ "any", "included", "excluded" ], "type": "string", "description": "Filter by whether bills are included in the rent.", "default": "any" }, "numberOfBedroom": { "title": "๐Ÿšช Bedrooms", "minimum": 0, "type": "integer", "description": "Filter by number of bedrooms in the property." }, "keywords": { "title": "๐Ÿ”ค Keywords", "type": "string", "description": "Free-text keywords to match within listings (search modes)." }, "ageMin": { "title": "๐ŸŽ‚ Age min", "minimum": 0, "type": "integer", "description": "Minimum person age (people / team-up searches)." }, "ageMax": { "title": "๐ŸŽ‚ Age max", "minimum": 0, "type": "integer", "description": "Maximum person age (people / team-up searches)." }, "enrichDetail": { "title": "โž• Enrich with full detail (PAID)", "type": "boolean", "description": "Fetch the full listing detail (room specs, bond, bills, household, geo, lister) for every search result. Requires a paid Apify plan and adds a per-listing charge.", "default": false }, "maxResults": { "title": "๐Ÿ”ข Max results per query", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum listings to return per search query (paginated ~12/page).", "default": 60 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }