{ "openapi": "3.0.1", "info": { "title": "Poland KRZ National Debtor Registry Scraper", "description": "Search Poland’s public KRZ for companies, people, cases, proceedings, announcements, partners, estate assets, and restructuring advisors. Export available identifiers, statuses, dates, court details, and official source links.", "version": "0.1", "x-build-id": "S9ubfEtQRMyaremXZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~poland-krz-debtor-registry-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-poland-krz-debtor-registry-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/maximedupre~poland-krz-debtor-registry-scraper/runs": { "post": { "operationId": "runs-sync-maximedupre-poland-krz-debtor-registry-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/maximedupre~poland-krz-debtor-registry-scraper/run-sync": { "post": { "operationId": "run-sync-maximedupre-poland-krz-debtor-registry-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", "required": [ "target" ], "properties": { "target": { "title": "Target", "enum": [ "companies", "persons", "soleTraders", "courtCases", "proceedings", "announcements", "partners", "estateAssets", "advisors" ], "type": "string", "description": "Choose the KRZ source surface and result family. Run differently configured searches separately.", "default": "companies" }, "companyQueries": { "title": "Companies or identifiers", "type": "array", "description": "Enter one check per line: a full or partial company name of at least 3 characters, or an identifier prefixed with KRS:, NIP:, or REGON:.", "items": { "type": "string" }, "default": [ "ABC" ] }, "personQueries": { "title": "PESEL or NIP identifiers", "type": "array", "description": "Enter one public natural-person check per line as PESEL: followed by 11 digits or NIP: followed by 10 digits. KRZ does not provide public person-name search. Submitted PESEL values are used only for checks and are never exported.", "items": { "type": "string", "pattern": "^(?:PESEL:\\s*[0-9]{11}|NIP:\\s*[0-9]{10})$" } }, "traderQueries": { "title": "Sole traders or identifiers", "type": "array", "description": "Enter one check per line: a full or partial business or person name of at least 3 characters, or an identifier prefixed with NIP:, REGON:, or PESEL:. PESEL is used only for the check and is not exported.", "items": { "type": "string" } }, "caseSignatures": { "title": "Case signatures", "type": "array", "description": "Enter one complete court case signature per line, in the form shown by KRZ.", "items": { "type": "string" } }, "proceedingIds": { "title": "Proceeding identifiers", "type": "array", "description": "Enter one exact KRZ proceeding identifier per line.", "items": { "type": "string" } }, "announcementFrom": { "title": "Announcement date from", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Earliest announcement date to include, in YYYY-MM-DD form." }, "announcementTo": { "title": "Announcement date to", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Latest announcement date to include, in YYYY-MM-DD form." }, "announcementQueries": { "title": "Subjects or announcement identifiers", "type": "array", "description": "Optionally enter one subject name or exact announcement identifier per line. Prefix an identifier with ID:.", "items": { "type": "string" } }, "announcementCaseSignatures": { "title": "Case signatures", "type": "array", "description": "Optionally enter one complete court case signature per line.", "items": { "type": "string" } }, "announcementProceedingIds": { "title": "Proceeding identifiers", "type": "array", "description": "Optionally enter one exact KRZ proceeding identifier per line.", "items": { "type": "string" } }, "partnerCompanies": { "title": "Companies or identifiers", "type": "array", "description": "Enter one check per line: a full or partial personal-company name of at least 3 characters, or an identifier prefixed with KRS:, NIP:, or REGON:.", "items": { "type": "string" } }, "assetSubjects": { "title": "Subjects or identifiers", "type": "array", "description": "Enter one debtor or estate subject per line as a full or partial name of at least 3 characters, or an identifier prefixed with KRS:, NIP:, REGON:, or PESEL:. Submitted PESEL values are never exported. You can instead provide proceeding context below.", "items": { "type": "string" } }, "assetProceedingIds": { "title": "Proceeding identifiers", "type": "array", "description": "Enter one exact KRZ proceeding identifier per line. You can instead provide subjects above or case signatures below.", "items": { "type": "string" } }, "assetCaseSignatures": { "title": "Case signatures", "type": "array", "description": "Enter one complete court case signature per line when a subject or proceeding identifier is unavailable.", "items": { "type": "string" } }, "assetType": { "title": "Asset category or type", "type": "string", "description": "Optionally restrict assets to a registry category or type." }, "advisorQueries": { "title": "Advisors or licence numbers", "type": "array", "description": "Enter one check per line: a full or partial advisor name of at least 3 characters, or a licence number prefixed with LICENCE:.", "items": { "type": "string" } }, "advisorCity": { "title": "City", "type": "string", "description": "Optionally search for advisors in a listed city, either alone or with the checks above." }, "maxResults": { "title": "Maximum results per check", "minimum": 1, "type": "integer", "description": "Stop each submitted check or announcement search after this many matches. If KRZ caps a broader query first, the output reports that the check is incomplete.", "default": 5 } } }, "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 } } }, "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 } } } } } } } } } }