{ "openapi": "3.0.1", "info": { "title": "Czech Companies (ARES) - IČO Lookup, VAT & NACE Search", "description": "Czech companies and other legal entities from ARES, the official register of the Czech Ministry of Finance: IČO lookup (100 per request) or search by name, legal form, CZ-NACE, municipality and region, with VAT status. No sole traders. Unofficial; not affiliated with the Ministry of Finance.", "version": "0.1", "x-build-id": "KR2I50uoV1tK0yuZH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jpopendata~czech-ares-companies/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jpopendata-czech-ares-companies", "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/jpopendata~czech-ares-companies/runs": { "post": { "operationId": "runs-sync-jpopendata-czech-ares-companies", "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/jpopendata~czech-ares-companies/run-sync": { "post": { "operationId": "run-sync-jpopendata-czech-ares-companies", "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": { "icos": { "title": "IČO numbers to look up", "type": "array", "description": "Optional. Czech company IDs (IČO), e.g. \"00177041\" (Škoda Auto), \"27082440\" (Alza.cz), \"45274649\" (ČEZ). Missing leading zeros and a \"CZ\" prefix (DIČ form) are fine. Up to 5,000 per run, 100 per ARES request. When this list is set, the search fields below are ignored, every IČO found is returned (Max results does not apply), and IČOs not returned are listed in the RUN_SUMMARY record (not in ARES, or a sole trader, which this Actor never requests).", "default": [], "items": { "type": "string" } }, "keyword": { "title": "Name keyword", "type": "string", "description": "Optional. Words of the registered name, e.g. \"kofola\", \"skoda auto\", \"stavební\". ARES matches the words in any order and ignores case and accents.", "default": "" }, "legalForms": { "title": "Legal forms", "type": "array", "description": "Optional. Abbreviations, names or 3-digit codes: \"s.r.o.\" (112, limited liability company), \"a.s.\" (121, joint-stock company), \"v.o.s.\" (111), \"k.s.\" (113), \"družstvo\" / \"cooperative\" (205), \"spolek\" / \"z.s.\" (706), \"o.p.s.\" (141), \"z.ú.\" (161), \"nadace\" (117), \"SVJ\" (145), \"SE\" (932), \"branch\" (501). Empty = every legal-entity form. Sole traders (OSVČ) cannot be selected.", "default": [], "items": { "type": "string" } }, "nace": { "title": "CZ-NACE activity codes", "type": "array", "description": "Optional. CZ-NACE 2025 codes (NACE Rev. 2.1): a section letter (\"J\"), a division (\"62\" = computer programming and consultancy), a group or class (\"62.10\" / \"6210\") or a subclass (\"62109\"). Every code below the one you give is included automatically. An entity matches if ANY of its activity codes matches.", "default": [], "items": { "type": "string" } }, "municipalities": { "title": "Municipalities (registered office)", "type": "array", "description": "Optional. Municipality names as written in Czech, e.g. \"Brno\", \"Praha\", \"Ostrava\", \"Plzeň\" (accents optional; \"Praha 5\" or \"Brno-střed\" districts work too), or 6-digit RÚIAN municipality codes (582786 = Brno, 554782 = Praha). For names shared by many villages (Lhota, Nová Ves) use the code. Up to 20; each one is a separate ARES search.", "default": [], "items": { "type": "string" } }, "regions": { "title": "Regions (kraje)", "type": "array", "description": "Optional. Czech or English region names or NUTS 3 codes, e.g. \"Jihomoravský kraj\", \"South Moravian\", \"CZ064\", \"Prague\". ARES has no region search, so regions filter the rows of a search that is already narrowed by a keyword, NACE code or municipality.", "default": [], "items": { "type": "string" } }, "status": { "title": "Status", "enum": [ "any", "active", "ceased" ], "type": "string", "description": "any (default) returns every entity with its status field; active keeps only active entities; ceased keeps only entities ARES marks as ceased (searches rarely return them).", "default": "any" }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stop a search after this many entities (1..20,000). ARES returns at most 1,000 matches per query; broader searches are split by legal form or NACE code when possible. Does not apply to IČO lookups.", "default": 20 }, "maxApiRequests": { "title": "Max ARES requests", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on requests to ARES in this run (1..2,000; requests are sent one at a time, at least 1.2 s apart). The Quick start needs 1; an IČO lookup needs 1-2 per 100 IČOs.", "default": 200 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed: ARES answers Apify datacenter IPs directly. If you add a proxy, the whole run uses one sticky session (one IP, no rotation, as the ARES operating conditions require).", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }