{ "openapi": "3.0.1", "info": { "title": "Polish Company Register (KRS) API → Clean JSON", "description": "Company profiles from the official Polish KRS open API (Ministry of Justice, CC0) by KRS number: name, legal form, status, address, NIP/REGON, PKD→NACE, share capital, masked officers. No scraping, no personal identifiers.", "version": "0.1", "x-build-id": "S4QWBHMgJmyHWTJe3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quietpinelabs~pl-krs-company/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quietpinelabs-pl-krs-company", "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~pl-krs-company/runs": { "post": { "operationId": "runs-sync-quietpinelabs-pl-krs-company", "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~pl-krs-company/run-sync": { "post": { "operationId": "run-sync-quietpinelabs-pl-krs-company", "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": { "krsNumbers": { "title": "KRS numbers", "type": "array", "description": "Krajowy Rejestr Sądowy numbers (1–10 digits; zero-padded to 10 automatically). Up to 5,000 per run; duplicates are merged. Unknown numbers (HTTP 404) and struck-off entities (HTTP 204) are reported in the STATS record and are not charged. Default: ORLEN S.A. and PKO BP S.A.", "items": { "type": "string" } }, "register": { "title": "Register", "enum": [ "P", "S" ], "type": "string", "description": "`P` = rejestr przedsiębiorców (companies, partnerships, cooperatives, branches). `S` = rejestr stowarzyszeń, fundacji, innych organizacji społecznych i zawodowych oraz SP ZOZ. A KRS number exists in exactly one of them; a lookup in the wrong one returns 404.", "default": "P" }, "fullExtract": { "title": "Full extract (odpis pełny)", "type": "boolean", "description": "Use `OdpisPelny` instead of `OdpisAktualny`: adds previous names with dates, officer appointment dates, the registration court and the deletion date of struck-off entities (status `dissolved`). ~5–10× larger upstream responses; same price per record.", "default": false }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Return management board, supervisory body members, commercial proxies and liquidators as the Ministry publishes them: names are masked by the source (e.g. `K******** D******`), with role and (full extract) appointment date. PESEL and free-text descriptions are never returned.", "default": true }, "mode": { "title": "Mode", "enum": [ "full", "incremental" ], "type": "string", "description": "`full` returns every extract found. `incremental` stores a content hash per KRS number in the key-value store (key `CURSOR`) and returns only extracts that changed since the previous run with the same input (first run returns everything).", "default": "full" }, "maxRecords": { "title": "Max records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many records (budget guard).", "default": 1000 }, "icos": { "title": "IČO list (ignored)", "type": "array", "description": "Common field of the CEE registry actors; not applicable to Poland and ignored here. Use `krsNumbers`.", "items": { "type": "string" } }, "name": { "title": "Company name (unsupported)", "type": "string", "description": "Not supported — the KRS open API has no name search. Setting it fails the run with an explanation; look the number up at https://wyszukiwarka-krs.ms.gov.pl/ instead." }, "region": { "title": "Region (ignored)", "type": "string", "description": "Not applicable to KRS extracts; ignored." }, "dateFrom": { "title": "Date from (ignored)", "type": "string", "description": "Not applicable to KRS extracts; ignored." }, "dateTo": { "title": "Date to (ignored)", "type": "string", "description": "Not applicable to KRS extracts; ignored." }, "cursorStore": { "title": "Cursor store name", "type": "string", "description": "Named key-value store that keeps the incremental-mode cursor across runs (default `pl-krs-company-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 } } } } } } } } } }