{ "openapi": "3.0.1", "info": { "title": "Poland CRBR Beneficial Owners Scraper", "description": "oland Beneficial Owners Scraper is an Apify Actor for extracting structured beneficial ownership data from Poland’s Central Register of Beneficial Owners, also known as CRBR or Centralny Rejestr Beneficjentów Rzeczywistych.", "version": "0.0", "x-build-id": "lwcMDWpWy4Cw9tMKt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/skyline_scrapers~poland-crbr-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-skyline_scrapers-poland-crbr-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/skyline_scrapers~poland-crbr-scraper/runs": { "post": { "operationId": "runs-sync-skyline_scrapers-poland-crbr-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/skyline_scrapers~poland-crbr-scraper/run-sync": { "post": { "operationId": "run-sync-skyline_scrapers-poland-crbr-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": { "nip": { "title": "NIP", "type": "string", "description": "Single-company search by Polish tax ID (NIP), 10 digits." }, "krs": { "title": "KRS", "type": "string", "description": "Single-company search by National Court Register number (KRS)." }, "companyName": { "title": "Company name", "type": "string", "description": "Single search by company name. This is a partial/prefix match and can return multiple companies for one query." }, "pesel": { "title": "PESEL", "type": "string", "description": "Reverse lookup: find companies where this person (by PESEL) is a beneficial owner." }, "queries": { "title": "Batch queries", "type": "array", "description": "Run multiple searches in one call. Each item can be a bare string (auto-detected as NIP/KRS/company name by digit pattern) or an object like {\"nip\": \"...\"}, {\"krs\": \"...\"}, {\"companyName\": \"...\"}, or {\"pesel\": \"...\"}. Also accepts the alias 'batchQueries'.", "default": [] }, "dateFrom": { "title": "Date from", "type": "string", "description": "Start of the registry snapshot period (YYYY-MM-DD). Defaults to today (current entry only). CRBR coverage begins 2019-10-13." }, "dateTo": { "title": "Date to", "type": "string", "description": "End of the registry snapshot period (YYYY-MM-DD). Defaults to today." }, "exportXml": { "title": "Export XML", "type": "boolean", "description": "Also fetch the official CRBR XML export for each successful record and store it in the key-value store.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional. Leave disabled to run without a proxy. For reliable CRBR lookups and higher success rates, Apify Residential Proxy (Poland) is recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "PL" } } } }, "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 } } } } } } } } } }