{ "openapi": "3.0.1", "info": { "title": "Czech ARES Scraper: Company Register Data | $1/1K", "description": "Czech companies and sole traders from the ARES business register: IČO, name, legal form, CZ-NACE activities, address, founding date and status. No key. $1 per 1,000 results, platform usage included.", "version": "0.1", "x-build-id": "1e36CiUatRLNodpYK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/one_dollar_store~czech-ares-companies-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-one_dollar_store-czech-ares-companies-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/one_dollar_store~czech-ares-companies-scraper/runs": { "post": { "operationId": "runs-sync-one_dollar_store-czech-ares-companies-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/one_dollar_store~czech-ares-companies-scraper/run-sync": { "post": { "operationId": "run-sync-one_dollar_store-czech-ares-companies-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", "properties": { "legalForms": { "title": "Legal form", "type": "array", "description": "Only subjects with these legal forms. Leave empty for all forms except sole traders. Choosing a sole trader form returns those records with personal data removed (no tax number, street or postal code).", "items": { "type": "string", "enum": [ "112", "121", "111", "113", "205", "301", "331", "325", "141", "145", "117", "118", "161", "706", "736", "722", "421", "501", "641", "661", "811", "932", "933", "961", "100", "101", "105", "107", "424" ], "enumTitles": [ "Limited liability company (s.r.o.)", "Joint-stock company (a.s.)", "General partnership (v.o.s.)", "Limited partnership (k.s.)", "Cooperative", "State enterprise", "Contributory organisation (příspěvková organizace)", "Organisational unit of the state", "Public benefit company (o.p.s.)", "Owners association (SVJ)", "Foundation", "Endowment fund", "Institute (ústav)", "Association (spolek)", "Branch association", "Registered church legal entity", "Branch of a foreign legal entity", "Branch of an enterprise", "School legal entity", "Public research institution", "City district", "European company (SE)", "European cooperative", "Trust fund", "Sole trader (personal data removed)", "Sole trader, trade licence (personal data removed)", "Sole trader, other law (personal data removed)", "Agricultural entrepreneur, individual (personal data removed)", "Foreign individual (personal data removed)" ] } }, "includeSoleTraders": { "title": "Include sole traders", "type": "boolean", "description": "Sole traders are individuals who trade under their own name. They are left out unless you turn this on or choose a sole trader legal form. Their records never include a tax number, street address or postal code.", "default": false }, "activityCodes": { "title": "Activity codes (CZ-NACE 2025)", "maxItems": 200, "type": "array", "description": "Only subjects that list one of these activity codes, one per line, for example 6210 for software or 4711 for retail. Use the 2025 codes: codes from the older 2008 list, such as 62010, do not match. Codes below the one you give are added unless you turn that off.", "items": { "type": "string", "pattern": "^[0-9]{2,5}$" } }, "includeSubCodes": { "title": "Include codes below the ones I give", "type": "boolean", "description": "ARES matches the exact code a company lists. With this on, 62 also matches 621, 6210, 62101 and so on. Turn it off to match only the codes you typed.", "default": true }, "cities": { "title": "Cities or towns", "maxItems": 50, "type": "array", "description": "Only subjects whose registered address is in these places, one per line, for example Brno or Mladá Boleslav. A city district or part of town (Brno-střed, Žabovřesky) works too. Not case or accent sensitive.", "items": { "type": "string", "pattern": "^[^\\n\\r\"\\\\]{2,60}$" } }, "regions": { "title": "Regions", "type": "array", "description": "Only subjects in these regions (kraj). The actor reads the tax office areas of the region and then checks each address, so a few companies that report to an office in another region can be missed.", "items": { "type": "string", "enum": [ "Hlavní město Praha", "Středočeský kraj", "Jihočeský kraj", "Plzeňský kraj", "Karlovarský kraj", "Ústecký kraj", "Liberecký kraj", "Královéhradecký kraj", "Pardubický kraj", "Kraj Vysočina", "Jihomoravský kraj", "Olomoucký kraj", "Moravskoslezský kraj", "Zlínský kraj" ] } }, "nameWords": { "title": "Words in the name", "pattern": "^[^\\n\\r\"\\\\]{2,80}$", "type": "string", "description": "Whole words that must all appear in the name, for example skoda or novak. Not case or accent sensitive. Part of a word does not match." }, "status": { "title": "Status", "enum": [ "active", "ceased", "any" ], "type": "string", "description": "Active subjects are alive in the base register. Ceased ones are closed or historical. ARES returns both, so this is applied to the rows.", "default": "active" }, "foundedFrom": { "title": "Founded from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only subjects founded on or after this date, as 2025-01-31. ARES cannot search by date, so the actor checks the date on each row; combine it with a city, legal form or activity code for fast runs." }, "foundedTo": { "title": "Founded until", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only subjects founded on or before this date, as 2025-12-31." }, "splitByActivity": { "title": "Split broad searches by activity code", "type": "boolean", "description": "ARES refuses any search that matches more than 1,000 subjects. The actor cuts such searches by legal form and tax office, and, if that is not enough, by activity code. The last step can miss companies that list no activity code. Turn it off to skip it.", "default": true }, "maxItems": { "title": "Maximum results", "minimum": 10, "maximum": 100000, "type": "integer", "description": "Stop after this many subjects. Minimum 10, maximum 100,000.", "default": 100 } } }, "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 } } } } } } } } } }