{ "openapi": "3.0.1", "info": { "title": "Poland KRS Company Extractor (Official API)", "description": "Extracts company data from the official Polish KRS business register open API: name, legal form, NIP, REGON, address, share capital, PKD activities and website. Look up KRS numbers or list the companies registered or changed on a given day. No account, no scraping.", "version": "0.1", "x-build-id": "5EsyHEgSpab5tF7Ph" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/uhqxx~krs-poland/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-uhqxx-krs-poland", "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/uhqxx~krs-poland/runs": { "post": { "operationId": "runs-sync-uhqxx-krs-poland", "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/uhqxx~krs-poland/run-sync": { "post": { "operationId": "run-sync-uhqxx-krs-poland", "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": "KRS numbers of the companies to extract, one per line. With or without leading zeros (19193 and 0000019193 are the same). Duplicates are processed once.", "items": { "type": "string" } }, "bulletinDate": { "title": "Bulletin date", "type": "string", "description": "Optional. A day in the format YYYY-MM-DD (after 2021-12-08, not in the future). Adds the companies the register published for that day. The bulletin of the current day may be incomplete." }, "bulletinScope": { "title": "Bulletin scope", "enum": [ "newCompanies", "allChanges" ], "type": "string", "description": "With a bulletin date: newCompanies = companies registered on that day (best effort: the list is read from the newest numbers down and stops after a long series of older companies, so a few new companies can be missed); allChanges = every company that changed that day.", "default": "newCompanies" }, "maxCompanies": { "title": "Maximum number of companies", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety limit for one run. Companies beyond this number are not extracted. A run reads about 2 companies per second by default.", "default": 100 }, "includeBoard": { "title": "Include management board members", "type": "boolean", "description": "Adds the name and role of the members of the management body and of the registered proxies (personal data published in the register). Never includes PESEL numbers or shareholders. Off by default.", "default": false }, "excludedKrs": { "title": "Excluded KRS numbers", "type": "array", "description": "KRS numbers that must NOT be processed. They are skipped, not saved and not counted.", "default": [], "items": { "type": "string" } }, "excludedPeople": { "title": "Excluded people", "type": "array", "description": "Full names (for example Jan Kowalski) to remove from the board members list when 'Include management board members' is on, for example people who objected. Matching ignores case and accents.", "default": [], "items": { "type": "string" } }, "requestsPerSecond": { "title": "Requests per second", "minimum": 1, "maximum": 5, "type": "integer", "description": "How fast the official API is queried, from 1 to 5. The default (2) is deliberately gentle. The run stops if the API keeps failing.", "default": 2 } } }, "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 } } } } } } } } } }