{ "openapi": "3.0.1", "info": { "title": "B2B Company Data Enrichment API", "description": "Enrich company domains with social links, contact pages, and metadata. Supercharge your CRM and B2B sales pipelines.", "version": "1.0", "x-build-id": "S6bZ0DrafdnfccJdW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/andok~company-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-andok-company-enrichment", "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/andok~company-enrichment/runs": { "post": { "operationId": "runs-sync-andok-company-enrichment", "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/andok~company-enrichment/run-sync": { "post": { "operationId": "run-sync-andok-company-enrichment", "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": [ "items" ], "properties": { "items": { "title": "Company inputs", "type": "array", "description": "List of companies to enrich. Provide whatever you have -- name, domain, website URL, VAT number, or a freeform query. The actor will resolve and enrich each one.", "items": { "type": "object", "properties": { "query": { "title": "Query", "type": "string", "description": "Freeform search text (e.g., 'acme tallinn fintech'). Use when you don't have a specific domain or name." }, "name": { "title": "Company name", "type": "string", "description": "The company's official or commonly known name." }, "domain": { "title": "Domain", "type": "string", "description": "The company's domain without protocol (e.g., example.com)." }, "websiteUrl": { "title": "Website URL", "type": "string", "description": "Full website URL including protocol (e.g., https://example.com)." }, "countryCode": { "title": "Country code", "type": "string", "description": "2-letter ISO country code (e.g., EE, DE). Required for VAT validation." }, "vatNumber": { "title": "VAT number", "type": "string", "description": "EU VAT number WITHOUT the country prefix. Requires countryCode to be set." }, "regNumber": { "title": "Registry number", "type": "string", "description": "National business registry number, if available." } } }, "default": [ { "name": "Example GmbH", "domain": "example.com", "countryCode": "DE" } ] }, "fetchWebsite": { "title": "Fetch website", "type": "boolean", "description": "Download the company website and extract metadata, contact info, and technology signals.", "default": true }, "maxWebsiteChars": { "title": "Max website characters", "minimum": 10000, "maximum": 2000000, "type": "integer", "description": "Maximum HTML characters to download per website. Increase for very large pages, decrease to save bandwidth.", "default": 200000 }, "includeWebsiteText": { "title": "Include extracted website text", "type": "boolean", "description": "Include the full extracted text content from the website in the output. This can significantly increase output size.", "default": false }, "includeSocialLinks": { "title": "Extract social links", "type": "boolean", "description": "Extract social media profile links (LinkedIn, Twitter, Facebook, Instagram, YouTube) from the website.", "default": true }, "includeWayback": { "title": "Wayback signals", "type": "boolean", "description": "Fetch Wayback Machine data including earliest/latest snapshots and total snapshot count. Useful for gauging domain age.", "default": true }, "includeSsl": { "title": "SSL certificate signals", "type": "boolean", "description": "Check the SSL certificate for expiry date, issuer, and subject CN. Useful for trust assessment and security audits.", "default": true }, "timeoutSeconds": { "title": "Timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum seconds to wait per HTTP request. Covers website fetches, VIES lookups, and SSL checks.", "default": 25 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of companies to enrich in parallel. Keep low (3-5) to avoid overwhelming external APIs like VIES.", "default": 3 } } }, "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 } } } } } } } } } }