{ "openapi": "3.0.1", "info": { "title": "Trade Me Listings", "description": "Returns current Trade Me property-for-sale, property-for-rent and car listings for New Zealand with price, location and property or vehicle details, and no seller or agent identities.", "version": "0.1", "x-build-id": "e7h9AGfqhB24Yj9NB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/subrosa~trademe-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-subrosa-trademe-listings", "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/subrosa~trademe-listings/runs": { "post": { "operationId": "runs-sync-subrosa-trademe-listings", "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/subrosa~trademe-listings/run-sync": { "post": { "operationId": "run-sync-subrosa-trademe-listings", "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": { "categories": { "title": "Categories", "uniqueItems": true, "type": "array", "description": "Which listing types to return. property-sale is residential property for sale, property-rent is residential property to rent, motors is cars. maxItems is shared evenly across the chosen categories.", "items": { "type": "string", "enum": [ "property-sale", "property-rent", "motors" ], "enumTitles": [ "Property for sale", "Property for rent", "Motors (cars)" ] }, "default": [ "property-sale", "property-rent", "motors" ] }, "regions": { "title": "Regions", "uniqueItems": true, "type": "array", "description": "Trade Me region slugs to include. Empty means every region, in order of size (Auckland first). Property pages are fetched per region; car listings are filtered by region after fetching, because Trade Me's region-filtered car search uses URL parameters its robots.txt disallows.", "items": { "type": "string", "enum": [ "auckland", "canterbury", "wellington", "waikato", "bay-of-plenty", "manawatu-whanganui", "otago", "northland", "hawkes-bay", "taranaki", "nelson-tasman", "southland", "gisborne", "marlborough", "west-coast" ], "enumTitles": [ "Auckland", "Canterbury", "Wellington", "Waikato", "Bay of Plenty", "Manawatu / Whanganui", "Otago", "Northland", "Hawke's Bay", "Taranaki", "Nelson / Tasman", "Southland", "Gisborne", "Marlborough", "West Coast" ] }, "default": [] }, "query": { "title": "Text filter", "type": "string", "description": "Keep only listings whose title, address, suburb, district, make, model or body style contains this text (case-insensitive). Applied after fetching; it does not run a site search, because Trade Me's robots.txt disallows search-parameter URLs. Leave empty for no filter.", "default": "" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Stop after this many items, shared evenly across the chosen categories. The default is sized so the default run finishes in well under five minutes. Each fetched page yields up to about 70 property listings or 22 car listings; a run can reach roughly 1,000 property listings per category across all regions and about 460 cars.", "default": 90 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy settings. Datacenter proxies are enough for this source; residential proxies are not needed and cost more.", "default": { "useApifyProxy": true, "apifyProxyGroups": [] } } } }, "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 } } } } } } } } } }