{ "openapi": "3.0.1", "info": { "title": "Carsales AU Scraper", "description": "Scrape carsales.com.au car listings from any search, make/model page, or listing URL. Get price, odometer, specs, features, seller comments, dealer details, location, and images. Monitor new listings and price changes. Export as JSON, CSV, or Excel.", "version": "1.0", "x-build-id": "zYrVApKujZnbR7yip" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~carsales-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-carsales-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/parsebird~carsales-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-carsales-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/parsebird~carsales-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-carsales-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Add carsales.com.au URLs. Supported: search results with filters (https://www.carsales.com.au/cars/?q=…), make/model/state pages (https://www.carsales.com.au/cars/toyota/hilux/, https://www.carsales.com.au/cars/dealer/volvo/), and single listings (https://www.carsales.com.au/cars/details/…/OAG-AD-12345678/).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max cars", "minimum": 0, "type": "integer", "description": "Maximum number of cars to save across all start URLs. Set 0 for no limit. carsales.com.au shows at most about 440 cars per search; bigger searches are split into price bands automatically to get past that limit.", "default": 100 }, "scrapeDetails": { "title": "Scrape full car details", "type": "boolean", "description": "Open each listing for the full data: seller comments, full specifications and features, colours, registration, build and compliance dates, dealer stock ID, location with suburb and postcode, dealer rating, and all images. Turn off to save only the search result card data (cheaper and faster).", "default": true }, "monitoringMode": { "title": "Save only new listings (monitoring)", "type": "boolean", "description": "Remember every car this Actor has saved for the same Start URLs and, on later runs, save only cars that were not seen before. Ideal for scheduled runs. The list of known cars is kept in your named key-value store 'carsales-monitor', and new cars are also added to your named dataset 'carsales-monitor-'. The first run saves everything it finds.", "default": false }, "trackPriceChanges": { "title": "Also save price changes", "type": "boolean", "description": "With monitoring on, also save known cars whose price changed since the last run. They get priceChanged: true and previousPrice.", "default": false }, "skipPriceSplitting": { "title": "Turn off price splitting", "type": "boolean", "description": "By default, searches with more than ~440 results are split into price bands so every car can be reached. Turn this on to save only the first ~440 cars of each search, in the site's own order (fewer requests).", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 30, "type": "integer", "description": "Maximum number of requests sent at the same time.", "default": 8 }, "minConcurrency": { "title": "Min concurrency", "minimum": 1, "maximum": 30, "type": "integer", "description": "Number of parallel requests at the start. The scraper adds more while requests succeed (up to Max concurrency) and slows down when carsales.com.au blocks requests.", "default": 2 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 30, "type": "integer", "description": "How many times a failed request is retried, with a new proxy IP each time.", "default": 8 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "carsales.com.au only accepts Australian residential IPs, so Apify residential proxy with country Australia is the default. Other proxy settings are switched to it automatically if they get blocked.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }