{ "openapi": "3.0.1", "info": { "title": "BuildZoom Scraper", "description": "[💰 $3.5 / 1K] Extract US contractor listings from BuildZoom by city and trade, or any BuildZoom URL. Get BZ scores, ratings, reviews, project counts, price ranges, addresses, phones — plus optional license, insurance, and bond details. For lead gen and market research.", "version": "1.0", "x-build-id": "k5egbpjLApO1aqrax" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~buildzoom-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-buildzoom-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/solidcode~buildzoom-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-buildzoom-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/solidcode~buildzoom-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-buildzoom-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": "BuildZoom URLs", "type": "array", "description": "Paste one or more BuildZoom URLs directly — either a contractor directory page (e.g. a 'general contractors in Dallas' page) or an individual contractor profile. Any filters already in the URL are kept as-is, so the Search Filters below are ignored for these URLs.", "items": { "type": "string" } }, "searchLocations": { "title": "Search Locations", "type": "array", "description": "Search contractors by typing a city and state, e.g. 'Dallas, TX' or 'Miami, FL'. Each location is searched separately. The Search Filters below apply to these locations.", "items": { "type": "string" } }, "trade": { "title": "Contractor Type", "enum": [ "general-contractors", "roofers", "electricians", "plumbers", "architects", "home-builders", "kitchen-and-bathroom-remodeling", "home-addition", "solar-contractors", "foundation-contractors" ], "type": "string", "description": "Which kind of contractor to look for. Only applies to Search Locations — ignored when you paste URLs above.", "default": "general-contractors" }, "constructionType": { "title": "Project Type", "enum": [ "all", "residential", "commercial" ], "type": "string", "description": "Limit results to contractors that do residential or commercial work. Choose 'All' for both.", "default": "all" }, "avgProjectValue": { "title": "Typical Project Budget", "enum": [ "any", "10000", "50000", "100000", "100001" ], "type": "string", "description": "Limit results to contractors whose typical project budget is at least this amount. Choose 'Any' for no budget filter.", "default": "any" }, "sortBy": { "title": "Sort Results By", "enum": [ "default", "score", "projects", "ratings", "value" ], "type": "string", "description": "How to order the contractors in each search.", "default": "default" }, "includeProfileDetails": { "title": "Include License & Insurance Details", "type": "boolean", "description": "Visit each contractor's profile to add license numbers and status, insurance, and bond information. This makes runs slower — leave off for a faster, lighter run that returns the contractor card data only.", "default": false }, "maxResults": { "title": "Max Results", "minimum": 0, "type": "integer", "description": "Maximum number of contractors to return across all locations and URLs. Set to 0 for unlimited (an internal safety cap of 50,000 still applies). Tip: start with 10-50 to test, then increase. Note: BuildZoom returns at most 250 contractors per location + contractor-type search. To collect more, add more Search Locations or narrow by contractor type, project type, or budget.", "default": 100 } } }, "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 } } } } } } } } } }