{ "openapi": "3.0.1", "info": { "title": "Company Research", "description": "Domain in, evidence-backed company profile out. Firmographics, HTTP/DNS tech stack, GLEIF/SEC/Companies House, plus hiring, product velocity, and news signals — every field has a source URL.", "version": "1.0", "x-build-id": "5gBzMT1fs7kSpv2N7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rational_opaque~company-research/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rational_opaque-company-research", "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/rational_opaque~company-research/runs": { "post": { "operationId": "runs-sync-rational_opaque-company-research", "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/rational_opaque~company-research/run-sync": { "post": { "operationId": "run-sync-rational_opaque-company-research", "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": "Company domains", "type": "array", "description": "Company website domains or URLs, e.g. stripe.com, https://linear.app. Normalized to the registrable domain (eTLD+1). Required unless fromDatasetId is set.", "items": { "type": "string" } }, "fromDatasetId": { "title": "Import domains from dataset", "type": "string", "description": "Optional Apify dataset ID (e.g. from Hiring Intent Scorer or Event Discovery Feed). Reads domain/companyId fields and merges hiring signals when present." }, "eventsDatasetId": { "title": "Event Discovery dataset", "type": "string", "description": "Optional Event Discovery Feed dataset ID. Companies appearing as organizer, sponsor, exhibitor or speaker company get an events signal." }, "maxCompanies": { "title": "Max companies", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on companies processed in this run.", "default": 100 }, "maxPagesPerCompany": { "title": "Max pages per company", "minimum": 1, "maximum": 40, "type": "integer", "description": "Maximum website pages fetched per company (home, about, team, contact, careers, blog, sitemap).", "default": 12 }, "detectTechStack": { "title": "Detect tech stack", "type": "boolean", "description": "Detect technologies from HTTP headers, scripts and DNS (MX/SPF/TXT). Charged as tech-stack-detected.", "default": true }, "lookupRegistries": { "title": "Look up public registries", "type": "boolean", "description": "Match the company in GLEIF, SEC EDGAR (incl. Form D) and UK Companies House (if key provided). Charged as registry-matched when a match is found.", "default": true }, "companiesHouseKey": { "title": "UK Companies House API key", "type": "string", "description": "Optional free API key from developer.company-information.service.gov.uk. Without it, UK registry lookup is skipped." }, "includeOfficers": { "title": "Include registry officer names", "type": "boolean", "description": "Include officer/director names from public registries. Off by default for GDPR minimization.", "default": false }, "registryMatchThreshold": { "title": "Registry match threshold", "minimum": 0.5, "maximum": 1, "type": "number", "description": "Minimum name-match confidence (0.5–1) to accept a registry record. Below it, up to 3 candidates are returned unmatched.", "default": 0.85 }, "enrichSignals": { "title": "Enrich buying signals", "type": "boolean", "description": "Hiring (Greenhouse/Lever/Ashby), events, product velocity (changelog/blog/GitHub) and newsroom. Charged as signals-enriched.", "default": true }, "githubToken": { "title": "GitHub token", "type": "string", "description": "Optional GitHub token to raise API rate limits for org/repo activity. Public data only." }, "extractTeam": { "title": "Extract public team page", "type": "boolean", "description": "Extract names and titles listed on the company's own public team/leadership page. No emails are collected or guessed.", "default": false }, "generateAccountBrief": { "title": "Generate account brief (LLM)", "type": "boolean", "description": "Write a short sales account brief from the collected fields only. Requires llmApiKey. Charged as account-brief-generated.", "default": false }, "icpDescription": { "title": "Your ICP / offer", "type": "string", "description": "Optional description of what you sell and to whom. Used only for the account brief's fit and talking points." }, "llmApiKey": { "title": "LLM API key", "type": "string", "description": "OpenAI-compatible API key used only when generateAccountBrief is on." }, "llmModel": { "title": "LLM model", "type": "string", "description": "Model name for the OpenAI-compatible endpoint.", "default": "gpt-4o-mini" }, "llmBaseUrl": { "title": "LLM base URL", "type": "string", "description": "OpenAI-compatible base URL.", "default": "https://api.openai.com/v1" }, "stateKey": { "title": "State key", "type": "string", "description": "Key in the named key-value store company-research-state. Use the same key across scheduled runs to track changes.", "default": "default" }, "onlyChanges": { "title": "Only output changes", "type": "boolean", "description": "Push only companies that are new or changed since the last run with this stateKey. Charged as change-detected.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy for website requests. Registry and DNS lookups go direct.", "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 } } } } } } } } } }