{ "openapi": "3.0.1", "info": { "title": "Company Enrichment & Search API - Firmographics, Tech & Socials", "description": "Search and enrich companies from a 16M+ company dataset by industry, size, location and technologies, and export structured firmographics - name, website, HQ, employee count, revenue, tech stack, social profiles and contacts. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "wEc7bqB3OoZQZ0lx9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~company-enrichment-search-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-company-enrichment-search-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/nabeelbaghoor~company-enrichment-search-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-company-enrichment-search-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/nabeelbaghoor~company-enrichment-search-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-company-enrichment-search-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", "properties": { "search": { "title": "Search text", "type": "string", "description": "Optional free-text search across company name and domain, e.g. `analytics` or `acme`. Combined with the structured filters below." }, "industries": { "title": "Industries", "type": "array", "description": "Filter to companies in these industries, using the provider's industry slugs, e.g. `computer-software`, `financial-services`, `hospital-health-care`. Multiple values are combined as OR (matches the `about.industries` attribute).", "items": { "type": "string" } }, "employeeRanges": { "title": "Employee size bands", "type": "array", "description": "Filter by employee headcount band(s). Bands are strings, e.g. `1-10`, `11-50`, `51-200`, `201-500`, `501-1000`, `1001-5000`, `5001-10000`, `10001+` (matches the `about.totalEmployees` attribute). Combined as OR.", "items": { "type": "string" } }, "countryCodes": { "title": "HQ country codes", "type": "array", "description": "Filter to companies headquartered in these two-letter ISO country codes, e.g. `us`, `gb`, `de`, `in` (matches `locations.headquarters.country.code`). Combined as OR.", "items": { "type": "string" } }, "technologies": { "title": "Technologies used", "type": "array", "description": "Filter to companies whose sites use these technologies, using the provider's technology slugs, e.g. `shopify`, `hubspot`, `google-analytics`, `react` (matches `technologies.active`). Combined as OR.", "items": { "type": "string" } }, "rawQuery": { "title": "Advanced query conditions", "type": "array", "description": "Power users: an array of raw condition objects in the form `{ \"attribute\": \"about.totalEmployees\", \"operator\": \"or\", \"sign\": \"equals\", \"values\": [\"51-200\"] }`. When set, these are appended to the conditions built from the fields above. See the provider's search documentation for all supported `attribute` paths and `sign` values." }, "sortKey": { "title": "Sort by", "enum": [ "meta.score", "about.totalEmployees", "analytics.monthlyVisitors" ], "type": "string", "description": "Field to sort results by.", "default": "meta.score" }, "sortOrder": { "title": "Sort order", "enum": [ "desc", "asc" ], "type": "string", "description": "Ascending or descending.", "default": "desc" }, "simplified": { "title": "Simplified records", "type": "boolean", "description": "Return the provider's simplified company records. Simplified results are lighter and are not charged credits against your key by the provider.", "default": false }, "startPage": { "title": "Start page", "minimum": 1, "type": "integer", "description": "1-based page to start from. Increase to skip earlier results.", "default": 1 }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many company records (1-1,000). Paged automatically in batches of up to 100. You are charged per result returned." }, "apiKey": { "title": "API token", "type": "string", "description": "Your company data API token. Required. Sign up self-serve at the provider for a free starter allowance and generate a token in your dashboard. Stored securely and never logged." } } }, "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 } } } } } } } } } }