{ "openapi": "3.0.1", "info": { "title": "Czech Company Registry (ARES) API → Clean JSON", "description": "Czech company data from the official ARES registry as clean, normalised JSON: profile by IČO (100 per request) or name, legal form, status, address, NACE, VAT ID, court registration, officers (opt-in), daily change feed. Pay per company returned.", "version": "0.1", "x-build-id": "4QOXbFZcelAWZ5lRK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quietpinelabs~ares-company-profile/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quietpinelabs-ares-company-profile", "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/quietpinelabs~ares-company-profile/runs": { "post": { "operationId": "runs-sync-quietpinelabs-ares-company-profile", "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/quietpinelabs~ares-company-profile/run-sync": { "post": { "operationId": "run-sync-quietpinelabs-ares-company-profile", "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 list", "type": "array", "description": "Czech company identifiers (IČO, 1–8 digits; zero-padded automatically). Up to 5,000 per run, looked up 100 per ARES request. IČO with an invalid checksum or not found in ARES are listed in the STATS record and never charged.", "items": { "type": "string" } }, "name": { "title": "Company name", "type": "string", "description": "Search by (part of) the business name (ARES `obchodniJmeno` full-text). Returns legal persons only — natural-person entrepreneurs are never returned by name. ARES rejects searches matching more than 1,000 entities; use a more specific name or add `region`." }, "region": { "title": "Region / municipality", "type": "string", "description": "Optional filter for name searches: substring of the kraj, okres or obec name of the registered seat (e.g. \"Praha\", \"Jihomoravský\", \"Brno\"). Diacritics-insensitive. Ignored for IČO lookups." }, "dateFrom": { "title": "Date from", "type": "string", "description": "ISO date (YYYY-MM-DD) or DD.MM.YYYY. Name search: only companies established on/after this date. Incremental mode: only notification batches released on/after this date (also used to bootstrap a run without a cursor)." }, "dateTo": { "title": "Date to", "type": "string", "description": "ISO date (YYYY-MM-DD) or DD.MM.YYYY. Name search: only companies established on/before this date. Incremental mode: only notification batches released on/before this date." }, "includeRegisters": { "title": "Additional registers", "type": "array", "description": "Opt-in per-source extracts merged into the profile (one extra ARES request per register and company). `vr` = public (court) register: court registration, share capital, previous names, officers; `rzp` = trade register: active trade licences; `res` = statistical register: prevailing NACE; `ros` = basic register of persons: data-box ID; `ceu` = central register of insolvent debtors: insolvency flag and case numbers.", "items": { "type": "string", "enum": [ "vr", "rzp", "res", "ros", "ceu" ], "enumTitles": [ "VR – public (court) register", "RŽP – trade register", "RES – statistical register", "ROS – basic register of persons", "CEÚ – insolvent debtors" ] }, "default": [] }, "includeOfficers": { "title": "Include officers (VR)", "type": "boolean", "description": "When `vr` is in `includeRegisters` and the company was looked up by its IČO, include current statutory-body and other-organ members (name, role, dates only — never birth dates or addresses). Name searches and incremental changes of IČO you did not supply never include officers.", "default": true }, "mode": { "title": "Mode", "enum": [ "full", "incremental" ], "type": "string", "description": "`full` returns the current profile of every matching company. `incremental` reads ARES daily change batches (VR, plus RES/RŽP when selected in `includeRegisters`) released since the previous run and returns only changed companies — restricted to `icos` when given. The cursor is stored in the run's key-value store under `CURSOR`.", "default": "full" }, "maxRecords": { "title": "Max records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many company profiles (also protects your budget).", "default": 1000 }, "cursorStore": { "title": "Cursor store name", "type": "string", "description": "Named key-value store that keeps the incremental-mode cursor across runs (default `ares-company-profile-cursor`). Use a different name per watch-list." } } }, "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 } } } } } } } } } }