{ "openapi": "3.0.1", "info": { "title": "LinkedIn Company Search Scraper", "description": "The most efficient way to search and extract company data from LinkedIn.\nScrape thousands of companies in seconds.", "version": "1.2", "x-build-id": "4ggzZANpumtJgUBWf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/flood~linkedin-company-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-flood-linkedin-company-search-scraper", "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/flood~linkedin-company-search-scraper/runs": { "post": { "operationId": "runs-sync-flood-linkedin-company-search-scraper", "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/flood~linkedin-company-search-scraper/run-sync": { "post": { "operationId": "run-sync-flood-linkedin-company-search-scraper", "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": [ "authToken" ], "properties": { "authToken": { "title": "Authentication Token", "type": "string", "description": "LinkedIn authentication Token. Set to the value of the li_at cookie from a Web browser after a successful authentication on linkedin.com. The token expires after 1 year or after a logout from LinkedIn." }, "language": { "title": "Preferred Language", "enum": [ "en-US", "ar-AE", "in-ID", "zh-CN", "zh-TW", "cs-CZ", "da-DK", "nl-NL", "fr-FR", "de-DE", "hi-IN", "it-IT", "ja-JP", "ko-KR", "ms-MY", "no-NO", "pl-PL", "pt-BR", "ro-RO", "ru-RU", "es-ES", "sv-SE", "tl-PH", "th-TH", "tr-TR", "uk-UA" ], "type": "string", "description": "Preferred language to autocomplete filters and localize results." }, "keywords": { "title": "Search Keywords", "type": "string", "description": "Company search keywords, as on LinkedIn." }, "location": { "title": "Location Filter", "type": "array", "description": "Filter companies by location, as on LinkedIn. LinkedIn autocompletion is applied to location strings.", "items": { "type": "string" } }, "industry": { "title": "Industry Filter", "type": "array", "description": "Filter companies by industry, as on LinkedIn. LinkedIn autocompletion is applied to industry strings.", "items": { "type": "string" } }, "size": { "title": "Size Filter", "type": "array", "description": "Filter companies by size, as on LinkedIn. Accepted values are: \"1-10\", \"11-50\", \"51-200\", \"201-500\", \"501-1000\", \"1001-5000\", \"5001-10000\" and \"10000+\".", "items": { "type": "string" } }, "hasJobs": { "title": "Has Jobs Filter", "type": "boolean", "description": "Filter companies with active job offers only, as on LinkedIn." }, "networkDepth": { "title": "Network Depth Filter", "enum": [ "1" ], "type": "string", "description": "Filter companies based on connections working there, as on LinkedIn." }, "limit": { "title": "Limit", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum number of companies to be scraped. From 0 to 1000. Default to 50.", "default": 50 }, "offset": { "title": "Offset", "minimum": 0, "maximum": 999, "type": "integer", "description": "Skip the first [offset] results. From 0 to 999. Default to 0.", "default": 0 }, "locationId": { "title": "Location Id Filter", "type": "array", "description": "Filter companies by location id. Provided for compatibility purpose, use Location Filter when possible.", "items": { "type": "string" } }, "industryId": { "title": "Industry Id Filter", "type": "array", "description": "Filter companies by industry id. Provided for compatibility purpose, use Industry Filter when possible.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify Proxy Configuration", "default": { "useApifyProxy": false } }, "datasetName": { "title": "Dataset Name", "type": "string", "description": "Name or id of the dataset that will be used for storing results. If left empty, the default dataset of the actor will be used." } } }, "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 } } } } } } } } } }