{ "openapi": "3.0.1", "info": { "title": "Lead List Enricher", "description": "🏷️ From $1.80 / 1K | Paste a list of company names or domains and get one row per company with its website, emails, phones, social profiles and firmographics, read from each company's own site. Unresolved and empty companies cost nothing.", "version": "0.1", "x-build-id": "ewRUiQ6Vmt4eW4RYw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spookyweb~lead-list-enricher/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spookyweb-lead-list-enricher", "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~lead-list-enricher/runs": { "post": { "operationId": "runs-sync-spookyweb-lead-list-enricher", "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~lead-list-enricher/run-sync": { "post": { "operationId": "run-sync-spookyweb-lead-list-enricher", "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": { "domains": { "title": "Domains", "type": "array", "description": "Website domains to enrich directly, one per line, protocol and www optional. Use this when you already know each company's website: resolution is skipped and every domain that answers with a readable page is crawled. Supply either domains or companies, not both.", "items": { "type": "string" } }, "companies": { "title": "Companies", "type": "array", "description": "Companies to resolve and enrich, as a JSON list of objects. name is required. Add postcode, companyNumber, town or country wherever you have them. A postcode or company number on the page is strong evidence; a town or country only corroborates the name exactly as you wrote it, and never when a postcode you gave is missing from the page; the full registered name in legal form such as Alfie Marketing Ltd stands alone. Give website (or domain) where you already know it and it is verified and used rather than guessed. Example: [{\"name\": \"Alfie Marketing Ltd\", \"town\": \"High Wycombe\"}]." }, "maxCompanies": { "title": "Maximum companies", "minimum": 1, "maximum": 500, "type": "integer", "description": "The most companies the run will attempt, between 1 and 500. Companies beyond this on the list are reported as not attempted. Only delivered rows are ever charged, so this bounds the run's working time rather than its bill.", "default": 100 }, "includeEmails": { "title": "Include emails", "type": "boolean", "description": "Read email addresses from mailto links and visible page text, each classified as role, personal or unclassified with free provider and on-domain flags. Turn off if your list is for a channel that does not need them.", "default": true }, "includeFirmographics": { "title": "Include firmographics", "type": "boolean", "description": "Read the company's own description, tagline, logo, declared industry, founding year, size band, postal addresses, registration and VAT numbers and languages from its schema.org markup, Open Graph tags and footer legal text.", "default": true }, "maxPagesPerDomain": { "title": "Pages to read per company", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many pages of each website to read, homepage included, from 1 to 8. Contact, about, team and legal pages are read first, so a low budget still lands on the pages that carry contacts and company facts. Each page is capped at 1MB.", "default": 5 }, "requireContact": { "title": "Require an email or phone", "type": "boolean", "description": "When on, a row is delivered and charged only if it carries at least one email address or phone number. When off, a row qualifies when the website resolved and at least one substantive field came back: an email, a phone, a social profile, a description, an address or a registration number.", "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 } } } } } } } } } }