{ "openapi": "3.0.1", "info": { "title": "Company Data Enrichment", "description": "Domain in, company profile out. Reads a company's own website for the name, what it does, emails, phones, addresses, social profiles, the technology the site runs on and the registration number in its footer. Legal name, VAT, size and founding year follow where the site states them.", "version": "0.1", "x-build-id": "cgAfCEv78uRMP14W7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spookyweb~company-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spookyweb-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/spookyweb~company-enrichment/runs": { "post": { "operationId": "runs-sync-spookyweb-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/spookyweb~company-enrichment/run-sync": { "post": { "operationId": "run-sync-spookyweb-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": [ "domains" ], "properties": { "domains": { "title": "Company domains", "type": "array", "description": "The companies to enrich, one domain or full URL per line. The protocol and www are optional, so monzo.com and https://www.monzo.com/ are the same company. Each domain is charged once, whatever the outcome.", "items": { "type": "string" } }, "maxPagesPerDomain": { "title": "Pages to read per company", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages of each company website to read, homepage included. Contact, about and legal pages are read first, so a low budget still lands on the pages that carry company facts. The price does not change with this number.", "default": 8 }, "pagePriority": { "title": "Which pages to prefer", "type": "array", "description": "The order to spend the page budget in. Contact and legal pages carry addresses, phone numbers and registration numbers. About and team pages carry the description and size. Careers and pricing are useful for qualifying a prospect.", "items": { "type": "string", "enum": [ "contact", "about", "legal", "team", "careers", "pricing" ], "enumTitles": [ "Contact", "About", "Legal and imprint", "Team and leadership", "Careers", "Pricing" ] }, "default": [ "contact", "about", "legal", "team" ] }, "includeContacts": { "title": "Include contact details", "type": "boolean", "description": "Collect the postal addresses, phone numbers and email addresses the company publishes on its own website. Turn this off if you only want the identity and technology fields.", "default": true }, "includeSocials": { "title": "Include social profiles", "type": "boolean", "description": "Collect the company profile on LinkedIn, X, Facebook, Instagram, YouTube, GitHub, TikTok, Crunchbase, Bluesky and Threads, one link per platform rather than every match on the page.", "default": true }, "includeTechStack": { "title": "Include technology stack", "type": "boolean", "description": "Detect the CMS, framework, ecommerce platform, analytics, CRM, payment, support, hosting and server software the site runs, each returned with the evidence that produced the detection.", "default": 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 } } }, "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 } } } } } } } } } }