{ "openapi": "3.0.1", "info": { "title": "TrueLocal AU Directory Listings & Reviews Scraper", "description": "Scrape TrueLocal.com.au business listings by keyword, location, or URL. Extract names, addresses, GPS coordinates, phones, emails, websites, ratings, and review counts. Optional review mode exports individual reviews with author, rating, text, and date. Automatic pagination included.", "version": "1.0", "x-build-id": "RkhAbamSPhU4h0x88" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~truelocal-com-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-truelocal-com-au-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/abotapi~truelocal-com-au-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-truelocal-com-au-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/abotapi~truelocal-com-au-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-truelocal-com-au-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", "required": [ "mode" ], "properties": { "mode": { "title": "1. Mode", "enum": [ "search", "url", "reviews" ], "type": "string", "description": "Search = keyword + location builder (one record per listing). URL = paste TrueLocal search or profile URLs. Reviews = same inputs as Search/URL but the output is one flat record PER review.", "default": "search" }, "searchTerms": { "title": "Search terms (what)", "type": "array", "description": "Keywords or categories to search, e.g. \"restaurants\", \"plumber\", \"hairdresser\". One or more.", "items": { "type": "string" } }, "locations": { "title": "Locations (where)", "type": "array", "description": "Free-text locations, e.g. \"Sydney NSW\", \"Melbourne VIC\", \"Bondi Beach\". Suburb-level granularity is accepted. Every keyword above is searched in every location here.", "items": { "type": "string" } }, "urls": { "title": "TrueLocal URLs", "type": "array", "description": "One or more full TrueLocal URLs. Either a search URL (https://www.truelocal.com.au/search?search_terms=cafe&geo_location_terms=Sydney+NSW) which is paginated forward, or a profile URL (https://www.truelocal.com.au/sydney-nsw/tlp/some-listing-580000000) which is fetched directly. Multi-URL supported.", "items": { "type": "string" } }, "fetchDetails": { "title": "Fetch profile pages (richer data)", "type": "boolean", "description": "When ON, open each listing's profile page for full address, GPS, email, website, star rating and reviews. When OFF (Search/URL modes only), output is the lean SERP card (name, profile URL, phone, category). Reviews mode always fetches profile pages.", "default": true }, "fetchReviews": { "title": "Include reviews (Search/URL modes)", "type": "boolean", "description": "When ON, each listing record includes a nested reviews[] array. Has no extra cost (reviews ship with the profile page). Ignored in Reviews mode, which always emits reviews.", "default": true }, "maxReviews": { "title": "Max reviews per listing", "minimum": 0, "type": "integer", "description": "Cap the number of reviews captured per listing. 0 = all available reviews.", "default": 20 }, "maxPages": { "title": "Max pages per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on how many SERP pages to walk per keyword/location (or per pasted search URL). Each page returns up to ~30 listings.", "default": 1 }, "maxListings": { "title": "Max listings (total)", "minimum": 0, "type": "integer", "description": "Stop after this many listings across all searches. In Reviews mode this caps the number of listings whose reviews are emitted. 0 = no cap.", "default": 0 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "TrueLocal accepts clean AU residential IPs reliably. Datacenter IPs are accepted only intermittently (the scraper rotates to recover). For consistent results use Apify residential with country AU." } } }, "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 } } } } } } } } } }