{ "openapi": "3.0.1", "info": { "title": "German Trade Register Scraper - Handelsregister.de", "description": "Extract company data from the official German Trade Register (Handelsregister) — representatives, address, share capital, register number & more.", "version": "1.0", "x-build-id": "DOgiWuId3pS5Sr0rq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/actorpilot~german-trade-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-actorpilot-german-trade-register-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/actorpilot~german-trade-register-scraper/runs": { "post": { "operationId": "runs-sync-actorpilot-german-trade-register-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/actorpilot~german-trade-register-scraper/run-sync": { "post": { "operationId": "run-sync-actorpilot-german-trade-register-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": { "companyNames": { "title": "Company names", "type": "array", "description": "Enter German company names — one per line. Always use the exact registered name including legal form: 'Siemens Aktiengesellschaft' not 'Siemens AG', 'Volkswagen Aktiengesellschaft' not 'VW'. If the name is ambiguous or abbreviated, only basic register data is returned (no address, directors, or business purpose) — the output row will contain a candidate_only error.", "items": { "type": "string", "minLength": 2 }, "default": [ "SAP SE" ] }, "registerLookups": { "title": "Register number lookups", "type": "array", "description": "Direct register number lookups — more reliable than name search. Each entry needs 'registerType', 'registerNumber', and 'court'. Important: enter only the number in 'registerNumber' — not the prefix. Correct: '755'. Wrong: 'HRB 755'. Find the register number on handelsregister.de or in any official company document (Impressum, Geschäftsbericht).", "items": { "type": "object", "properties": { "registerType": { "title": "Register type", "description": "Type of register: HRB (GmbH/AG), HRA (sole traders/partnerships), GnR (cooperatives), VR (associations), PR (partnerships).", "type": "string", "enum": [ "HRB", "HRA", "GnR", "VR", "PR" ] }, "registerNumber": { "title": "Register number", "description": "The numeric part only — no prefix. Example: '755' (not 'HRB 755'), '100484' (not 'HRB 100484').", "type": "string" }, "court": { "title": "Court (Registergericht)", "description": "The Amtsgericht holding the register, e.g. 'Berlin (Charlottenburg)' or 'München'. Leave empty to search all courts.", "type": "string" } }, "required": [ "registerType", "registerNumber" ] } }, "multiMatchStrategy": { "title": "When a name matches multiple companies", "enum": [ "first", "all", "error" ], "type": "string", "description": "Controls what happens when a name search returns more than one result. Example: 'Bauer GmbH' may match dozens of companies. 'Best match only' returns the most likely one. 'All matches' returns every result as a separate dataset row.", "default": "first" }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 1000, "maximum": 10000, "type": "integer", "description": "Minimum wait time between HTTP requests in milliseconds. handelsregister.de allows approximately 60 requests per hour — do not go below 1000 ms or your IP may be blocked.", "default": 1200 }, "maxRetries": { "title": "Max retries on errors", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times to retry a failed request before writing an error to the output. A company that cannot be reached after all retries will appear in the dataset with an error message — the run continues for all other companies.", "default": 3 } } }, "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 } } } } } } } } } }