{ "openapi": "3.0.1", "info": { "title": "🌟B2b Lead Enricher", "description": null, "version": "0.0", "x-build-id": "WOjcDt8dyX3E368fx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/databuddy~b2b-lead-enricher/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-databuddy-b2b-lead-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/databuddy~b2b-lead-enricher/runs": { "post": { "operationId": "runs-sync-databuddy-b2b-lead-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/databuddy~b2b-lead-enricher/run-sync": { "post": { "operationId": "run-sync-databuddy-b2b-lead-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", "required": [ "urls" ], "properties": { "urls": { "title": "Company websites", "type": "array", "description": "One per line: a domain (stripe.com), a URL (https://stripe.com) or an email (jane@stripe.com β€” its domain is used). Optional per-line names for email pattern guesses: \"stripe.com | John | Doe\". Duplicate domains are removed.", "items": { "type": "string" } }, "firstName": { "title": "First name (optional)", "type": "string", "description": "Contact first name used to predict their email at every company (for example John β†’ john.doe@company.com). Per-line names override this.", "default": "" }, "lastName": { "title": "Last name (optional)", "type": "string", "description": "Contact last name for email pattern prediction.", "default": "" }, "maxPagesPerSite": { "title": "Max pages per website", "minimum": 1, "maximum": 20, "type": "integer", "description": "Homepage plus the most useful internal pages (contact, team, about, impressum, support, press). More pages find more emails but take longer.", "default": 6 }, "maxResults": { "title": "Max companies to save", "minimum": 0, "type": "integer", "description": "Stop after this many enriched companies are saved (and charged). 0 = no limit.", "default": 0 }, "includeExecutiveEmails": { "title": "Include role email patterns (CEO, CTO, HR, Sales…)", "type": "boolean", "description": "Adds guessed role addresses such as ceo@company.com. Always marked unverified; roles actually published on the site are listed as confirmed. Never mixed into the found emails.", "default": true }, "checkWhois": { "title": "WHOIS (domain age, registrar)", "type": "boolean", "description": "Looks up registration and expiry dates and the registrar through RDAP, the official successor of WHOIS.", "default": true }, "checkSsl": { "title": "SSL certificate", "type": "boolean", "description": "Checks certificate validity, issuer and days until expiry.", "default": true }, "checkDns": { "title": "DNS (MX, email provider, SPF, DMARC)", "type": "boolean", "description": "Checks whether the domain can receive email, which provider hosts it (Google Workspace, Microsoft 365…) and its SPF/DMARC setup.", "default": true }, "includeFailedSites": { "title": "Show failed websites in the results", "type": "boolean", "description": "Adds a row (status = blocked / unreachable / invalid_input …) with the reason and how to fix it for every website that could not be crawled. These rows are never charged.", "default": true }, "onlyWithEmail": { "title": "Only companies with an email", "type": "boolean", "description": "Skip companies where no public email was found.", "default": false }, "onlyWithContact": { "title": "Only companies with an email or phone", "type": "boolean", "description": "Skip companies with neither a public email nor a phone number.", "default": false }, "minLeadGrade": { "title": "Minimum lead grade", "enum": [ "A", "B", "C", "D" ], "type": "string", "description": "Skip companies below this grade. A = 75–100, B = 50–74, C = 25–49, D = 0–24.", "default": "D" }, "requiredTech": { "title": "Must use one of these technologies", "type": "array", "description": "Keep only sites using at least one of these, e.g. Shopify, WordPress, HubSpot, Stripe, Webflow. Names as shown in the tech_stack column (not case-sensitive). Leave empty to keep all.", "default": [], "items": { "type": "string" } }, "minDomainAgeYears": { "title": "Min domain age (years)", "minimum": 0, "type": "integer", "description": "Skip domains registered more recently than this. 0 = no minimum.", "default": 0 }, "includeUnknownDomainAge": { "title": "Keep domains with unknown age", "type": "boolean", "description": "Some registries (e.g. .de) publish no registration date. When a min domain age is set, keep these if on, skip them if off. The age stays empty β€” never guessed.", "default": true }, "requireMx": { "title": "Only domains that receive email (MX records)", "type": "boolean", "description": "Skip domains without a mail server β€” their emails would bounce.", "default": false }, "companyKeywords": { "title": "Company keywords", "type": "array", "description": "Keep only companies whose name, description or page title matches one of these (e.g. \"payments\", \"real estate\", \"SaaS\"). Capitals, accents, hyphens and plurals are treated as equal.", "default": [], "items": { "type": "string" } }, "keywordMatchMode": { "title": "Keyword match mode", "enum": [ "exact", "all", "any", "off" ], "type": "string", "description": "Exact phrase: words together in order. All words: every word anywhere. Any word: one is enough. Off: ignore keywords.", "default": "exact" }, "skipPreviouslyScraped": { "title": "Skip domains saved in previous runs", "type": "boolean", "description": "Remembers saved domains in a named key-value store and skips them in later runs, so scheduled runs only charge for new companies.", "default": false }, "dedupeStoreName": { "title": "Memory store name", "pattern": "^[a-z0-9-]{1,63}$", "type": "string", "description": "Name of the key-value store that remembers saved domains. Lowercase letters, numbers and hyphens.", "default": "b2b-lead-enricher-seen" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Most company websites work without a proxy (cheapest). If sites come back as \"blocked\", turn on Apify Proxy β€” RESIDENTIAL gets through the most bot protection.", "default": { "useApifyProxy": 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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }