{ "openapi": "3.0.1", "info": { "title": "Company Data Search API - Industry, Size & Location", "description": "Search a global company dataset by industry, employee count, location, founding year and tags, and export structured firmographic records - website, size, industry, location, LinkedIn and social profiles. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "caGE83PZcQbRBsZtP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~company-data-search-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-company-data-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-data-search-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-company-data-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-data-search-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-company-data-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": { "name": { "title": "Company name contains", "type": "string", "description": "Match companies whose name contains this text (matched against the `name` field)." }, "industry": { "title": "Industry", "type": "string", "description": "Exact industry value, e.g. `computer software`, `financial services`, `hospital & health care` (matches the `industry` field, lowercase)." }, "country": { "title": "Country", "type": "string", "description": "Headquarters country, lowercase, e.g. `united states`, `united kingdom` (matches `location.country`)." }, "region": { "title": "Region / state", "type": "string", "description": "Headquarters region or state, lowercase, e.g. `california`, `texas` (matches `location.region`)." }, "locality": { "title": "City / locality", "type": "string", "description": "Headquarters city, lowercase, e.g. `san francisco` (matches `location.locality`)." }, "employeeCountMin": { "title": "Minimum employee count", "minimum": 0, "type": "integer", "description": "Lower bound on `employee_count`." }, "employeeCountMax": { "title": "Maximum employee count", "minimum": 0, "type": "integer", "description": "Upper bound on `employee_count`." }, "foundedAfter": { "title": "Founded on or after (year)", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Lower bound on founding year, e.g. `2010` (matches `founded`)." }, "tags": { "title": "Tags", "type": "array", "description": "Match companies carrying all of these tags, e.g. `saas`, `b2b` (matches the `tags` field).", "items": { "type": "string" } }, "requireWebsite": { "title": "Require a website", "type": "boolean", "description": "Only return companies that have a website on record.", "default": true }, "advancedQuery": { "title": "Advanced query (Elasticsearch DSL)", "type": "object", "description": "Power users: a raw Elasticsearch query object sent as `query`, e.g. `{\"bool\":{\"must\":[{\"term\":{\"industry\":\"computer software\"}}]}}`. When set, it overrides all the simple filters above." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many company records (1-5,000). Collected up to 100 per request via scroll pagination. You are charged per result returned." }, "apiKey": { "title": "API key", "type": "string", "description": "Your company data API key. Required. Sign up free to get a self-serve key. 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 } } } } } } } } } }