{ "openapi": "3.0.1", "info": { "title": "Poland KRS Company Lookup - Polish Company Register API", "description": "Look up Polish companies in the official KRS API (Krajowy Rejestr Sądowy) by KRS number: name, NIP, REGON, address, share capital, PKD and the board as published. $0.008 per company; not found is free.", "version": "0.1", "x-build-id": "UPJr69pf6nWg7vfdS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lukehunter~poland-krs-company-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lukehunter-poland-krs-company-lookup", "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/lukehunter~poland-krs-company-lookup/runs": { "post": { "operationId": "runs-sync-lukehunter-poland-krs-company-lookup", "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/lukehunter~poland-krs-company-lookup/run-sync": { "post": { "operationId": "run-sync-lukehunter-poland-krs-company-lookup", "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 to look up, up to 10 digits each, e.g. [\"0000028860\", \"0000009831\"] (PKN Orlen, PZU). Unpadded numbers such as 28860 are padded to 10 digits. A malformed entry stops the run with an error. Not-found numbers are free. Max 5,000 per run.", "items": { "type": "string" } }, "registers": { "title": "Registers", "type": "array", "description": "Register to search: P = entrepreneurs (companies), S = associations, foundations and public institutions, e.g. [\"P\"]. Leave empty to try P first and then S for each number (an unknown number then costs two requests).", "items": { "type": "string", "enum": [ "P", "S" ] } }, "odpis": { "title": "Extract type", "enum": [ "current", "full" ], "type": "string", "description": "current = OdpisAktualny, the extract in force today (default, e.g. for supplier checks). full = OdpisPelny, the full extract including history; the Actor still returns only the values in force today, from the full extract.", "default": "current" }, "includeVatStatus": { "title": "Add VAT status (optional)", "type": "boolean", "description": "Also ask the Ministry of Finance VAT white list about each company's NIP and add the VAT status and the number of bank accounts listed (never the account numbers), e.g. true. Free, best effort: if the service fails the company is still delivered.", "default": false }, "maxItems": { "title": "Maximum companies", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on delivered (charged) companies, 1 to 5000, e.g. 100. At $0.008 per company 100 companies cost $0.80. Numbers not read because the cap was reached are listed as not_processed rows, free.", "default": 100 }, "nips": { "title": "NIP numbers (not resolvable)", "type": "array", "description": "Optional, e.g. [\"7740001454\"]. The KRS API cannot look up a NIP, and this Actor does not scrape other sites to resolve it, so each NIP gets a free unsupported_identifier row, and a run with only NIPs fails with a clear message. Give KRS numbers instead.", "items": { "type": "string" } }, "regons": { "title": "REGON numbers (not resolvable)", "type": "array", "description": "Optional, e.g. [\"610188201\"]. The KRS API cannot look up a REGON, so each one gets a free unsupported_identifier row, and a run with only REGONs fails with a clear message. NIP and REGON are returned for every company found by KRS number.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }