{ "openapi": "3.0.1", "info": { "title": "UK B2B Lead Finder", "description": "🏷️ From $0.60 / 1K | Type an industry and a UK town and get businesses in that market with contact details: proven website, emails, phones and socials, built from Companies House and the open web. You pay only for leads that carry a contact.", "version": "0.1", "x-build-id": "x3xBJtRixOqpIgn1D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spookyweb~uk-b2b-lead-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spookyweb-uk-b2b-lead-finder", "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/spookyweb~uk-b2b-lead-finder/runs": { "post": { "operationId": "runs-sync-spookyweb-uk-b2b-lead-finder", "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/spookyweb~uk-b2b-lead-finder/run-sync": { "post": { "operationId": "run-sync-spookyweb-uk-b2b-lead-finder", "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", "required": [ "location" ], "properties": { "industry": { "title": "Industry", "type": "string", "description": "The kind of business you are looking for, in plain words: marketing agencies, dentists, builders, accountants, restaurants. Around 65 industries are mapped to their official SIC codes, and an industry outside the mapping is rejected with the nearest supported ones named, so a typo never silently searches the whole register." }, "location": { "title": "Location", "type": "string", "description": "A UK town, city or postcode area, for example Manchester, Leeds or M1. Matched against each company's registered office address, which is how Companies House itself filters." }, "maxLeads": { "title": "Maximum leads", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many contactable leads to deliver, between 1 and 100. Only delivered leads are charged, so this is also the most a run can cost. Larger asks take longer: raise the run timeout above the 300 second default for more than about 20.", "default": 10 }, "maxCompaniesScanned": { "title": "Maximum companies scanned", "minimum": 10, "maximum": 2000, "type": "integer", "description": "The hard cap on how many discovered companies the run may work through looking for contactable leads. The run stops here even if maxLeads has not been reached, and the status message reports leads found per companies scanned. Left unset it defaults to 10 times maxLeads. Only delivered leads are ever charged; this bounds the run's own working time." }, "sicCodes": { "title": "SIC codes (advanced)", "type": "array", "description": "Exact 5 digit SIC 2007 codes to search instead of, or as well as, the industry keywords. Use the condensed list at resources.companieshouse.gov.uk/sic. For example 73110 for advertising agencies.", "items": { "type": "string" } }, "audienceType": { "title": "Audience type", "enum": [ "b2b", "local-consumer" ], "type": "string", "description": "Whether you sell to businesses or to local consumer trades. Both draw on the same Companies House register; this only changes which industries are suggested when your keywords need disambiguating.", "default": "b2b" }, "requireEmail": { "title": "Require an email address", "type": "boolean", "description": "When on, a lead must carry at least one email address. When off, an email or a phone number qualifies. Companies without either are never delivered and never charged either way.", "default": false }, "useSearchFallback": { "title": "Use search fallback", "type": "boolean", "description": "Try one polite web search for companies whose website cannot be guessed from their name. Off by default: measured on 18 August it slowed runs heavily and resolved nothing that survived the evidence gate. Turn it on for small, patient runs only.", "default": false } } }, "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 } } } } } } } } } }