{ "openapi": "3.0.1", "info": { "title": "hipages Australia Scraper", "description": "Scrape hipages.com.au tradie listings by category or URL. Optionally enrich each company with profile details and reviews. Pay-per-event: company, company-details, and company-review.", "version": "1.0", "x-build-id": "qpy7rNOYxpTHrMtwI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~hipages-au-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-hipages-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/rigelbytes~hipages-au-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-hipages-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/rigelbytes~hipages-au-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-hipages-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", "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "hipages category or company URLs. Category pages look like https://hipages.com.au/find/air_conditioning_installation or a suburb page such as https://hipages.com.au/find/air_conditioning_installation/nsw/sydney. Company pages look like https://hipages.com.au/connect/amplifyelectrical. Use this or Categories (or both).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "categories": { "title": "Categories", "type": "array", "description": "Directory categories from the hipages header (Interior, Exterior, Outdoor, Build & Renovate, More). Choosing a group (All Interior, …) includes every subcategory in that group. Combine with Start URLs if you want both.", "items": { "type": "string", "enum": [ "interior", "air_conditioning_installation", "blinds", "carpenters", "carpet_layers", "cladding", "electricians", "floor_sanding", "flyscreens", "insulation", "carpets", "plastering", "plumbers", "shower_screens", "tilers", "waterproofers", "exterior", "asbestos_removal", "concrete_resurfacing", "flyscreen_repairs", "gutter_cleaning", "guttering", "guttering_repairs", "painters", "door_installation", "paver", "roof_repairs", "roofing", "skylights", "verandahs", "windows", "window_repairs", "outdoor", "decking", "fences", "fences_general_contractor", "garden_maintenance_garden_cleanup", "landscaper_gardener", "garden_maintenance", "lawn_mowing", "patios", "pergola", "pool_fencing", "pool_resurfacing", "surveyor", "lawn_turf_synthetic_turf_supply_and_install", "fences_timber", "arborists", "build-renovate", "bathroom_renovations", "bricklayers", "builders", "building_certifiers", "inspection_services", "carports", "concretors", "demolition", "drafters", "home_renovations", "renderer", "builders_renovation", "restumping", "retaining_walls", "structural_engineer", "more", "air_conditioning", "cabinet_makers", "cleaning_services", "dishwasher_appliance_repairs", "doors", "furniture_removal", "gas_fitters", "glass_glazier", "handyman", "ikea_kitchens", "oven_and_range_hood_repairs", "pest_control", "rubbish_remover", "furniture_removal_small_move", "upholstery_repair" ], "enumTitles": [ "All Interior", "Interior › Aircon Installation", "Interior › Blinds & Curtains", "Interior › Carpenters", "Interior › Carpet Repair", "Interior › Cladding", "Interior › Electricians", "Interior › Floor Sanding", "Interior › Fly Screens", "Interior › Insulation", "Interior › New Carpet", "Interior › Plasterers", "Interior › Plumbers", "Interior › Shower Screens", "Interior › Tiling", "Interior › Waterproofing", "All Exterior", "Exterior › Asbestos Removal", "Exterior › Concrete Resurfacing", "Exterior › Flyscreen Repair", "Exterior › Gutter Cleaning", "Exterior › Gutter Installation", "Exterior › Gutter Repair", "Exterior › House Painters", "Exterior › New Doors", "Exterior › Pavers", "Exterior › Roof Repairs", "Exterior › Roofing", "Exterior › Skylights", "Exterior › Verandah Builders", "Exterior › Window Installation", "Exterior › Window Repairs", "All Outdoor", "Outdoor › Deck Builders", "Outdoor › Fence Builders", "Outdoor › Fencing Contractors", "Outdoor › Garden Clean Up", "Outdoor › Garden Landscapers", "Outdoor › Gardeners", "Outdoor › Lawn Mowing", "Outdoor › Patio Builders", "Outdoor › Pergola Builders", "Outdoor › Pool Fence Installers", "Outdoor › Pool Resurfacing", "Outdoor › Surveyors", "Outdoor › Synthetic Grass", "Outdoor › Timber Fencing", "Outdoor › Tree Arborists", "All Build & Renovate", "Build & Renovate › Bathroom", "Build & Renovate › Bricklayers", "Build & Renovate › Builders", "Build & Renovate › Building Certifiers", "Build & Renovate › Building Inspectors", "Build & Renovate › Carports & Garages", "Build & Renovate › Concreters", "Build & Renovate › Demolition", "Build & Renovate › Draftsmen", "Build & Renovate › Home Renovators", "Build & Renovate › Renderers", "Build & Renovate › Renovation Builders", "Build & Renovate › Restumping", "Build & Renovate › Retaining Walls", "Build & Renovate › Structural Engineers", "All More", "More › Air Conditioning", "More › Cabinet Makers", "More › Cleaners", "More › Dishwasher Repair", "More › Door Installers", "More › Furniture Removalists", "More › Gas Fitters", "More › Glass Glaziers", "More › Handymen", "More › IKEA Kitchens", "More › Oven Repair", "More › Pest Control", "More › Rubbish Removal", "More › Removalists", "More › Upholstery Repair" ] } }, "location": { "title": "Location", "type": "string", "description": "Optional suburb, city, or postcode (e.g. Sydney, 2000, Melbourne VIC). When set, listings are paginated for that area. When empty, the actor starts from capital cities and nearby suburbs so it can collect companies beyond the national top-10 cards." }, "includeCompanyDetails": { "title": "Include company details", "type": "boolean", "description": "Visit each company profile for ABN, website, email, address, licenses, and the public phone number. Charged as the company-details event when details are extracted.", "default": false }, "includeReviews": { "title": "Include company reviews", "type": "boolean", "description": "Attach reviews to each company as a list (not separate dataset rows). Charged once per review scraped (company-review event).", "default": false }, "maxReviewsPerCompany": { "title": "Max reviews per company", "minimum": 0, "type": "integer", "description": "Maximum reviews to scrape for each company (0 = all available).", "default": 0 }, "maxItems": { "title": "Max companies", "minimum": 0, "type": "integer", "description": "Maximum number of companies to scrape (0 = unlimited).", "default": 0 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Use Apify Residential proxies on the platform. Local runs can disable this.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }