{ "openapi": "3.0.1", "info": { "title": "Czech Company Data — ARES Search, VAT & Directors", "description": "Search Czech companies by name/IČO, or DISCOVER them by industry (NACE) + city + legal form, from the official ARES registry. Returns identity, VAT (DIČ), NACE, address, founding date, plus optional directors & share capital. Open data, no key.", "version": "0.1", "x-build-id": "Iyka0fapVJX6afMMo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/foxlabs~czech-company-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-foxlabs-czech-company-data", "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/foxlabs~czech-company-data/runs": { "post": { "operationId": "runs-sync-foxlabs-czech-company-data", "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/foxlabs~czech-company-data/run-sync": { "post": { "operationId": "run-sync-foxlabs-czech-company-data", "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": { "searchQuery": { "title": "Company name (whole words)", "type": "string", "description": "Find companies whose name has this word. ARES matches whole words: \"servis\" does not find \"autoservis\", and a part of a word (\"serv\") finds nothing; case and accents do not matter (\"skoda\" finds \"Škoda\"). With several words every one of them must be in the name, in any order. Example: \"Škoda\", \"Alza\", \"logistika\". Leave empty to look up by IČO or to DISCOVER by sector/city/form below." }, "icoList": { "title": "IČO numbers", "type": "array", "description": "Exact 8-digit Czech company IDs (IČO) for precise lookup, e.g. [\"00177041\", \"45274649\"]. Overrides the name search and the discovery filters. Leading zeros may be left out (177041), and one entry may hold several numbers separated by commas. A number ARES does not know, and an entry that cannot be an IČO, are named in the run's status message; with more numbers than Max results only the first ones are looked up, and under a maximum charge only as many as the charge covers — the numbers left are listed in the run's NOT_DELIVERED record. While this list holds a number, the name, sector, form and city fields are not used — empty it to search.", "items": { "type": "string" } }, "naceActivity": { "title": "Industry / sector (CZ-NACE)", "type": "string", "description": "DISCOVER companies by economic activity — a CZ-NACE 2025 code. A shorter code covers every code below it: \"62\" is the whole division 62, computer programming and consultancy (11 codes), \"47\" all of retail (82 codes), \"62200\" one class. A code of the older 2008 classification (e.g. 6201) and a section letter (J) are not searched; the run says so. Combine with City + Legal form. No name needed." }, "legalForm": { "title": "Legal form", "enum": [ "", "112", "121", "111", "113", "205", "100", "421", "141", "301", "706" ], "type": "string", "description": "Filter to a single legal form. Also works as a standalone discovery criterion (e.g. all joint-stock companies in a city).", "default": "" }, "city": { "title": "City / municipality", "type": "string", "description": "DISCOVER or filter by city, e.g. \"Praha\", \"Brno\", \"Olomouc\". ARES matches the text against its own address record, with or without accents (\"Plzen\" finds \"Plzeň\"), so a few rows whose address does not show the word can come along; a district, city part or street makes the search smaller (\"Praha 4\" is a part of \"Praha\", \"Praha Chodov\" a smaller one). Must be combined with a name, a sector or a legal form: a city alone is not offered as a search and fails the run (see the section text above)." }, "addressQuery": { "title": "Address contains (fine filter)", "type": "string", "description": "Extra client-side filter — keep only companies whose full registered address contains this text (a street or district); case and accents do not matter. Applied after the search. Leave empty for none." }, "onlyActive": { "title": "Only active companies", "type": "boolean", "description": "Leave out entities that have ended, are in liquidation (\"v likvidaci\" in the name) or have a live entry in the insolvency register (ISIR) or in the older register of bankrupts (CEÚ). Each row says which applies in isActive, inLiquidation and insolvencyRecord.", "default": false }, "includeDirectors": { "title": "Include directors & capital", "type": "boolean", "description": "Attach the statutory body / board (names, roles and start dates), supervisory board and registered share capital from the public register (Veřejný rejstřík) — one more lookup per company. Ticked in this form; off by default in the API. A company the register does not answer for (asked twice) is delivered with directors null and counted in the status message, as long as the register still returns the record of a company known to have one. When it does not, the register is taken as down: the run stops and writes no row without directors. It also stops once 25 companies have been left without an answer and they are more than half of those asked.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of companies to return (1–100000). ARES lists at most 1,000 per search; a larger search is read in smaller searches (by legal form, tax office, NACE code and city part) and the run's status message says how many of ARES's total were delivered and how many could not be listed. A run with a maximum charge stops reading at the number of companies that charge covers.", "default": 1000 } } }, "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 } } } } } } } } } }