{ "openapi": "3.0.1", "info": { "title": "Company & Lead Enrichment API — Domain to Company Profile", "description": "Turn a list of domains into complete company records: name, description, logo, tech stack, social profiles, public contacts and WHOIS registration. Built for lead enrichment and CRM cleanup. Domains that return nothing are never charged.", "version": "1.0", "x-build-id": "bqbvAbUG561LhkPpf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ntriqpro~company-enrichment-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ntriqpro-company-enrichment-api", "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/ntriqpro~company-enrichment-api/runs": { "post": { "operationId": "runs-sync-ntriqpro-company-enrichment-api", "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/ntriqpro~company-enrichment-api/run-sync": { "post": { "operationId": "run-sync-ntriqpro-company-enrichment-api", "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": [ "domains" ], "properties": { "domains": { "title": "Domains", "type": "array", "description": "Company domains to enrich. Accepts bare domains (stripe.com) or full URLs (https://stripe.com/pricing) — URLs are reduced to their domain. A 12-domain sample is prefilled so a fresh console run returns a meaningful multi-row report; pass your own list to override it.", "items": { "type": "string" } }, "extractCompany": { "title": "Company profile", "type": "boolean", "description": "Company name, description, logo and language, read from the site's own metadata.", "default": true }, "extractTech": { "title": "Tech stack", "type": "boolean", "description": "Detect frameworks, CMS and e-commerce platforms from the homepage (39 technologies).", "default": true }, "extractSocials": { "title": "Social profiles", "type": "boolean", "description": "LinkedIn, X/Twitter, Facebook, Instagram, YouTube and GitHub profile links published on the site.", "default": true }, "extractContacts": { "title": "Public contacts", "type": "boolean", "description": "Email addresses and phone numbers the company publishes on its own website.", "default": true }, "extractRegistration": { "title": "Domain registration", "type": "boolean", "description": "Registrar, creation and expiry dates, domain age and nameservers from public WHOIS records.", "default": true }, "extractDns": { "title": "Mail & DNS infrastructure", "type": "boolean", "description": "Mail provider (Google Workspace, Microsoft 365, ...), DNS provider, SPF/DMARC status and the SaaS tools the company has verified domain ownership with. Read from public DNS records, so it still comes back for sites that block crawlers. Never counted towards billing.", "default": true }, "chargeOnResultOnly": { "title": "Only charge for results", "type": "boolean", "description": "When on, domains that return no usable data cost nothing. Leave this on unless you need a row for every input domain.", "default": true }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip the website of any company whose robots.txt disallows crawling. Public WHOIS data is still returned for those domains, and skipped websites are never charged.", "default": true }, "includePersonalEmails": { "title": "Include personal email addresses", "type": "boolean", "description": "Off by default: only role addresses (info@, sales@, support@) are returned. Turning this on also returns addresses that name an individual, which count as personal data under GDPR and similar laws — you are responsible for having a lawful basis to process them.", "default": false }, "maxConcurrency": { "title": "Parallel domains", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many domains to enrich at the same time.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy used for fetching company websites. The default works for most sites.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }