{ "openapi": "3.0.1", "info": { "title": "German Company KYB, Handelsregister & Insolvency Scraper", "description": "Official German Handelsregister (XJustiz 3.5.1) & Insolvency API Scraper. Extract managing directors (Geschäftsführer), share capital, HRB & live insolvency status.", "version": "0.1", "x-build-id": "Kdcdkxn55s4qllulj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/agrunert~german-company-kyb-insolvency-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-agrunert-german-company-kyb-insolvency-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/agrunert~german-company-kyb-insolvency-scraper/runs": { "post": { "operationId": "runs-sync-agrunert-german-company-kyb-insolvency-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/agrunert~german-company-kyb-insolvency-scraper/run-sync": { "post": { "operationId": "run-sync-agrunert-german-company-kyb-insolvency-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": { "company_name": { "title": "Company Name", "type": "string", "description": "Full or partial legal name of a single German company (e.g. 'BioNTech SE', 'Siemens AG'). Leave empty if using 'companies' bulk list." }, "companies": { "title": "Bulk Company List (Batch Mode)", "type": "array", "description": "Optional list of German companies to check in bulk. Each item can be a company name (e.g. 'SAP SE'), a pipe-separated string ('BioNTech SE | Mainz | HRB 48720'), or a JSON object with company_name, city, and register_number.", "items": { "type": "string" } }, "city": { "title": "City / Seat (Optional)", "type": "string", "description": "City where the company is headquartered to narrow down search results (e.g. 'Mainz', 'München')." }, "register_number": { "title": "Register Number (Optional)", "type": "string", "description": "Commercial register number with or without prefix (e.g. 'HRB 48720' or '48720')." }, "register_type": { "title": "Register Type (Optional)", "enum": [ "ALL", "HRB", "HRA", "GnR", "PR", "VR" ], "type": "string", "description": "Type of register (HRB for GmbH/AG/SE, HRA for OHG/KG/e.K., GnR for Genossenschaften, PR for Partnerschaften, VR for Vereine).", "default": "ALL" }, "include_insolvency_check": { "title": "Include Insolvency Register Check", "type": "boolean", "description": "Query official insolvenzbekanntmachungen.de to check if active or past insolvency proceedings exist for this debtor.", "default": true }, "include_financial_details": { "title": "Include Financial & Officer Deep Details", "type": "boolean", "description": "Download and parse official structured register data (SI / XJustiz XML) for share capital, business purpose, and officers/board members.", "default": true }, "request_delay_seconds": { "title": "Delay between companies (seconds)", "minimum": 0, "maximum": 10, "type": "integer", "description": "Polite delay between sequential company checks to respect portal rate limits.", "default": 1 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Select proxies to be used by the Actor. Official German portals benefit from residential or German datacenter proxies during high-volume scraping." } } }, "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 } } } } } } } } } }