{ "openapi": "3.0.1", "info": { "title": "B2B Company List Builder: by Industry, City and Country", "description": "Build a list of companies by country, industry code and town from official registers in 14 countries: UK, France, the Nordics, the US and more. Each row has the legal name, registry number, status, industry, town, postcode and the website where we know it. $0.50 per 1,000 companies.", "version": "0.1", "x-build-id": "7bKLogfuP0enwXQAm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/locaihost~company-list-builder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-locaihost-company-list-builder", "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/locaihost~company-list-builder/runs": { "post": { "operationId": "runs-sync-locaihost-company-list-builder", "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/locaihost~company-list-builder/run-sync": { "post": { "operationId": "run-sync-locaihost-company-list-builder", "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": { "country": { "title": "Country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "One ISO country code: GB, FR, NO, SE, FI, EE, CZ, IE, LV, SG, AU, CA, JP or US. Any other code (for example DE) lists that country's companies with an LEI.", "default": "GB" }, "industry": { "title": "Industry code", "pattern": "^([0-9A-Za-z.]{1,12})?$", "type": "string", "description": "Optional. A code or the start of one, in the country's own system; it matches any of a company's codes. The first two digits mean the same in the UK (SIC 2007), France (NAF), Norway, Finland, Czechia, Ireland (NACE-based) and Singapore (SSIC): 62 software and IT, 56 restaurants, cafes and bars, 69 legal and accounting, 43 building trades, 96 hairdressing and personal services. Go deeper for one activity: UK 62012 (software development), France 62.01 (programmation informatique), Norway 62.01. US rows use SEC SIC or Connecticut NAICS codes, which are numbered differently." }, "city": { "title": "Town or city", "type": "string", "description": "Optional. The registered office's town, as the register writes it (case and accents don't matter), for example Manchester, Nantes or Göteborg." }, "segment": { "title": "Which companies", "enum": [ "active-with-website", "active", "all", "with-lei" ], "type": "string", "description": "Active companies with a website we know (the default), every active company, every company we hold in any status, or companies with an LEI in any status.", "default": "active-with-website" }, "maxResults": { "title": "Max companies", "minimum": 1, "maximum": 2000000, "type": "integer", "description": "Stop after this many companies (1 to 2,000,000). Empty = 1,000.", "default": 100 }, "onlyNew": { "title": "Only companies not returned before", "type": "boolean", "description": "Skip companies this account already got from an earlier run of the same list (same country, segment, industry and town). Skipped companies are free. Turn it on to fetch a big list over several runs, or to get only the additions each month.", "default": false }, "incorporatedSince": { "title": "Incorporated since", "type": "string", "description": "Only companies incorporated on or after this date: 2020-01-01, or a span back from today like \"6 months\" or \"2 years\". Australia's and Japan's files state no incorporation date, so leave it empty for AU and JP." }, "incorporatedBefore": { "title": "Incorporated before", "type": "string", "description": "Only companies incorporated before this date (the date itself is left out): 2015-01-01, or a span back from today like \"5 years\"." } } }, "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 } } } } } } } } } }