{ "openapi": "3.0.1", "info": { "title": "Flatmates.com.au Scraper", "description": "Scrape Flatmates.com.au, Australia's #1 share-accommodation marketplace. Search rooms & whole properties, people looking, or team-ups by suburb/city/university/postcode or URL; get full listing details by id or URL, a member's listings, surrounding-suburb results, and location autocomplete.", "version": "1.0", "x-build-id": "LbS11lpxYYA0VYr8w" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/one-api~flatmates-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-one-api-flatmates-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/one-api~flatmates-scraper/runs": { "post": { "operationId": "runs-sync-one-api-flatmates-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/one-api~flatmates-scraper/run-sync": { "post": { "operationId": "run-sync-one-api-flatmates-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": { "property_inputs": { "title": "Listing id or flatmates.com.au URL (one per line)", "type": "array", "description": "Auto-detects each entry and calls the right endpoint:\n• A listing id — `P1087596` (a room/property), `F3892184` (a person/team-up), or bare digits — → `/details/byid`\n• A `https://flatmates.com.au/...` listing URL → `/details/byurl`\n\nEach row = one full listing record: per-room rent, availability, preferences, photos, lister, map (for rooms/properties) or budget, move date, professions, preferences (for people/team-ups).", "items": { "type": "string" } }, "search_inputs": { "title": "Location or search-results URL (one per line)", "type": "array", "description": "Auto-detects each entry and routes to the right `/search/*` endpoint:\n• A flatmates.com.au results URL, e.g. `https://flatmates.com.au/rooms/sydney` → `/search/byurl`\n• Anything else — a suburb, city, university or postcode, e.g. `Sydney`, `surry-hills-2010`, `unsw`, `2010` → `/search/bylocation`\n\nThe filters below apply to every query. Each hit returns one row per listing.", "items": { "type": "string" } }, "searchType": { "title": "Listing type", "enum": [ "rooms", "people", "teamups" ], "type": "string", "description": "What to search for — Flatmates' three listing axes. Applies to Search and Surrounding Suburbs.", "default": "rooms" }, "propertyType": { "title": "Property type (rooms only)", "enum": [ "any", "share_house", "whole_property", "studio", "one_bed", "granny_flat", "shared_room", "student_accommodation", "homestay" ], "type": "string", "description": "Restrict room/property searches to a property type. Leave as Any for all.", "default": "any" }, "roomType": { "title": "Room type (rooms only)", "enum": [ "any", "private_room", "shared_room" ], "type": "string", "description": "Private or shared room.", "default": "any" }, "furnishingType": { "title": "Furnishing (rooms only)", "enum": [ "any", "furnished", "unfurnished" ], "type": "string", "description": "Furnished or unfurnished room/property.", "default": "any" }, "bathroomType": { "title": "Bathroom (rooms only)", "enum": [ "any", "ensuite", "own" ], "type": "string", "description": "Ensuite or own (private) bathroom.", "default": "any" }, "parkingType": { "title": "Parking (rooms only)", "enum": [ "any", "off_street_parking", "on_street_parking", "no_parking" ], "type": "string", "description": "Off-street, on-street, or no parking.", "default": "any" }, "billsIncluded": { "title": "Bills included (rooms only)", "type": "boolean", "description": "Only listings where bills are included in the rent.", "default": false }, "budgetRange": { "title": "Weekly rent / budget (AUD)", "type": "string", "description": "Weekly rent (rooms) or budget (people), e.g. `min:200,max:400` — or just `min:200` / `max:400`.", "default": "" }, "numberOfBedroom": { "title": "Bedrooms (rooms only)", "type": "string", "description": "Number of bedrooms in the property, e.g. `3`.", "default": "" }, "flatmateGenderType": { "title": "Gender (people only)", "enum": [ "any", "female", "male", "couples", "no_couples" ], "type": "string", "description": "Gender filter for people / team-up searches.", "default": "any" }, "ageRange": { "title": "Age range (people only)", "type": "string", "description": "Person age, e.g. `min:20,max:35`.", "default": "" }, "lengthOfStay": { "title": "Length of stay", "enum": [ "any", "one_week", "two_weeks", "four_weeks", "six_weeks", "two_months", "three_months", "four_months", "six_months", "nine_months", "one_year" ], "type": "string", "description": "Desired length of stay.", "default": "any" }, "keywords": { "title": "Keywords", "type": "string", "description": "Free-text keyword filter, e.g. `pet friendly`.", "default": "" }, "sort": { "title": "Sort order", "enum": [ "featured", "newest", "cheapest", "mostExpensive", "earliestAvailable", "moveEarliest", "lowestBudget", "recentlyActive" ], "type": "string", "description": "Result ordering.", "default": "featured" }, "pages": { "title": "Pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many result pages to fetch for each Search / Surrounding query (~12 listings per page).", "default": 1 }, "surrounding_inputs": { "title": "Location for surrounding-suburb search (one per line)", "type": "array", "description": "Find listings in the suburbs *surrounding* a location via `/search/surrounding` — useful when an exact suburb is thin. Same listing type and filters as Search apply. One row per listing.", "items": { "type": "string" } }, "member_inputs": { "title": "Member id (one per line)", "type": "array", "description": "A lister's currently active listings via `/member/listings`. A `memberId` comes from any listing detail's `Member ID` field. One row per listing.", "items": { "type": "string" } }, "autocomplete_inputs": { "title": "Location text to resolve (one per line)", "type": "array", "description": "Resolve a suburb / city / university / postcode to the location key used by Search, via `/autocomplete`. Each suggestion = one row (key, type, title).", "items": { "type": "string" } }, "include_filters": { "title": "Include the filters reference", "type": "boolean", "description": "Add rows listing every accepted filter value and range (via `/filters`) — handy for discovering valid inputs without trial and error.", "default": false } } }, "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 } } } } } } } } } }