{ "openapi": "3.0.1", "info": { "title": "Trade Me Property Scraper", "description": "Collect residential property listings from Trade Me, New Zealand's largest marketplace. Get prices, bedrooms, bathrooms, land area, GPS coordinates, all photos, agent contacts, open homes, adjacent suburbs, and rental details for sales and rentals. Filter by region, suburb, price, and property type.", "version": "0.0", "x-build-id": "sVFSdgIkwuR6BZedO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~trade-me-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-trade-me-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/parseforge~trade-me-property-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-trade-me-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/parseforge~trade-me-property-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-trade-me-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": { "listingType": { "title": "Listing Type", "enum": [ "residential-sale", "residential-rent" ], "type": "string", "description": "Type of property listings to scrape: residential for-sale or rental." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 100. Paid users: Optional, max 1,000,000." }, "region": { "title": "Region", "type": "string", "description": "Filter by NZ region (e.g. auckland, wellington, canterbury). Leave blank for all regions." }, "district": { "title": "District", "type": "string", "description": "Filter by district within the region (e.g. auckland-city, north-shore-city). Requires region to be set." }, "suburb": { "title": "Suburb", "type": "string", "description": "Filter by suburb within the district (e.g. ponsonby, remuera). Requires region and district to be set." }, "minBedrooms": { "title": "Min Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBedrooms": { "title": "Max Bedrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms." }, "minBathrooms": { "title": "Min Bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms." }, "propertyType": { "title": "Property Type", "type": "string", "description": "Filter by property type (e.g. House, Apartment, Townhouse, Unit, Section, Lifestyle)." }, "minPrice": { "title": "Min Price", "minimum": 0, "type": "integer", "description": "Minimum price in NZD (for sales) or minimum weekly rent in NZD (for rentals)." }, "maxPrice": { "title": "Max Price", "minimum": 0, "type": "integer", "description": "Maximum price in NZD (for sales) or maximum weekly rent in NZD (for rentals)." }, "minLandArea": { "title": "Min Land Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum land area in square metres." }, "maxLandArea": { "title": "Max Land Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum land area in square metres." }, "minFloorArea": { "title": "Min Floor Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum floor area in square metres." }, "maxFloorArea": { "title": "Max Floor Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum floor area in square metres." }, "petsOkay": { "title": "Pets Allowed", "type": "boolean", "description": "Filter rental listings that allow pets." }, "keyword": { "title": "Keyword", "type": "string", "description": "Search keyword to filter listings by title or description." } } }, "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 } } } } } } } } } }