{ "openapi": "3.0.1", "info": { "title": "BuildZoom Contractor Scraper", "description": "BuildZoom Contractor Scraper is an Apify Actor that extracts contractor listings from BuildZoom search pages by location and keyword, returning structured data including contractor names, profile URLs, BuildZoom scores, and review counts with automatic deduplication.", "version": "0.0", "x-build-id": "U2rsRMQDdkbsmxEQh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moving_beacon-owner1~buildzoom-contractor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moving_beacon-owner1-buildzoom-contractor-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/moving_beacon-owner1~buildzoom-contractor-scraper/runs": { "post": { "operationId": "runs-sync-moving_beacon-owner1-buildzoom-contractor-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/moving_beacon-owner1~buildzoom-contractor-scraper/run-sync": { "post": { "operationId": "run-sync-moving_beacon-owner1-buildzoom-contractor-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": { "locationSlug": { "title": "Location slug", "type": "string", "description": "BuildZoom location slug from the URL, e.g. 'phoenix-az', 'los-angeles-ca', 'chicago-il'." }, "locationSlugs": { "title": "Multiple location slugs (optional)", "type": "array", "description": "Scrape several locations in one run. Overrides the single slug above if provided.", "default": [], "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "string", "description": "Search keywords, e.g. 'General Contractors', 'Roofing', 'Electricians'." }, "maxPages": { "title": "Max pages per location", "minimum": 1, "maximum": 50, "type": "integer", "description": "Result pages to walk per location (25 contractors per page).", "default": 2 }, "maxRecords": { "title": "Max records total", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after collecting this many contractors across all locations.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "BuildZoom sits behind Cloudflare, which blocks datacenter IPs. RESIDENTIAL proxies are required in practice (default). Note: residential traffic is billed per GB on Apify.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxProxyRotations": { "title": "Max proxy rotations on block", "minimum": 1, "maximum": 10, "type": "integer", "description": "If a proxy session gets blocked before any data is extracted, retry with a fresh proxy IP up to this many times.", "default": 3 }, "impersonate": { "title": "Browser TLS profile", "enum": [ "chrome", "chrome124", "chrome131", "safari", "firefox" ], "type": "string", "description": "curl_cffi impersonation target. 'chrome' tracks the latest supported Chrome.", "default": "chrome" }, "cookies": { "title": "Extra cookies (JSON)", "type": "object", "description": "Optional cookies, e.g. {\"cf_clearance\": \"...\"} harvested from a real browser session if Cloudflare still challenges.", "default": {} }, "requestDelaySecs": { "title": "Delay between requests (seconds)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Polite pause between page fetches.", "default": 2 } } }, "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 } } } } } } } } } }