{ "openapi": "3.0.1", "info": { "title": "Hipages Lead Extractor", "description": "Extract public tradie business leads from hipages.com.au by category and postcode", "version": "0.0", "x-build-id": "8Uz7hCx67O1nHIoVP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/powerbox~hipages-lead-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-powerbox-hipages-lead-extractor", "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/powerbox~hipages-lead-extractor/runs": { "post": { "operationId": "runs-sync-powerbox-hipages-lead-extractor", "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/powerbox~hipages-lead-extractor/run-sync": { "post": { "operationId": "run-sync-powerbox-hipages-lead-extractor", "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": { "category": { "title": "Category", "enum": [ "Air Conditioning", "Antenna Services", "Appliance Installation", "Appliance Repairs", "Arborists", "Architects", "Asbestos Removal", "Awning Suppliers", "Balustrades", "Bamboo Flooring", "Bath Resurfacing", "Bathroom Accessories", "Bathroom Renovations", "Blinds", "Bricklayers", "Builders", "Building Certifiers", "Building Consultants", "Building Designers", "Building Inspections", "Building Suppliers", "Building Surveyors", "Cabinet Makers", "Carpenters", "Carpet Cleaning", "Carpet Layers", "Carpets", "Carports", "Ceiling Repair", "Chimney Sweepers", "Cladding", "Cleaning Services", "Commercial Cleaning", "Concrete Kerbs", "Concrete Resurfacing", "Concretors", "Construction Project Management", "Curtains", "Custom Furniture", "Damp Proofing", "Decking", "Demolition", "Door Suppliers", "Doors", "Drafters", "Electricians", "Equipment Hire", "Ev Charger Installation", "Excavation", "Fences", "Floor Coatings", "Floor Sanding", "Fly Screens", "Furniture Removal", "Garages", "Garden Designers", "Gardeners", "Gas Fitters", "Gates", "Gazebos", "Glass Glazier", "Gutter Cleaning", "Guttering", "Handrails", "Handyman", "Heaters", "Heating Systems", "Home Automation", "Home Renovations", "Home Security", "Home Theatre", "Homewares", "Hot Water Systems", "Insulation", "Interior Decorators", "Interior Designers", "Irrigation Systems", "Joiners", "Kitchen Designers", "Kitchen Renovations", "Landscape Architecture", "Landscaper Gardener", "Lawn Mowing", "Lawn Turf", "Lighting", "Locksmiths", "Painters", "Patios", "Paver", "Pergolas", "Pest Control", "Pest Inspections", "Plastering", "Plumbers", "Pool Fencing", "Pool Heating", "Pool Maintenance", "Pressure Cleaner", "Privacy Screens", "Professional Organisers", "Render", "Renderer", "Retaining Walls", "Roller Shutters", "Roof Repairs", "Roofing", "Rubbish Removal", "Scaffolding", "Security Screens Doors", "Shade Sails", "Sheds", "Shopfitters", "Shower Screens", "Skip Truck Hire", "Skylights", "Solar Panel Cleaners", "Solar Power", "Splashbacks", "Stained Glass", "Staircases", "Stonemasons", "Storage", "Structural Engineer", "Surveyor", "Swimming Pool Builders", "Tilers", "Timber Flooring", "Town Planning Consultants", "Tree Fellers", "Underfloor Heating Systems", "Underpinning", "Upholstery Repair", "Ventilation", "Verandahs", "Vinyl Laminate", "Wallpapering", "Wardrobe Makers", "Waterproofing", "Window Cleaning", "Window Repairs", "Window Shutters", "Window Tinting", "Windows" ], "type": "string", "description": "Service category to search (120+ trades).", "default": "Air Conditioning" }, "postcode": { "title": "Postcode", "minimum": 200, "maximum": 9999, "type": "integer", "description": "Australian 4-digit postcode (e.g. 2213 for East Hills NSW).", "default": 2213 }, "sortBy": { "title": "Sort by", "enum": [ "Rating", "Total Hired", "Total Recommendations" ], "type": "string", "description": "Client-side ranking of collected listings.", "default": "Rating" }, "startUrls": { "title": "Find page URLs", "type": "array", "description": "Optional hipages find URLs such as https://hipages.com.au/find/electricians/nsw/parramatta. When set, category/postcode can be omitted.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Max leads", "minimum": 1, "maximum": 110, "type": "integer", "description": "Maximum businesses to return (site soft-cap ~110 per search).", "default": 50 }, "revealPhone": { "title": "Reveal phone numbers", "type": "boolean", "description": "Call the public phone reveal endpoint for listings that advertise a phone.", "default": true }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Polite delay between directory and phone requests.", "default": 300 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxies recommended for production (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 }, "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 } } } } } } } } } }