{ "openapi": "3.0.1", "info": { "title": "Germany Handelsregister · Search, Profile & KYB", "description": "Search by company name or paste court + HRB — legal form, capital, address and directors. No API key. Official German company register.", "version": "1.0", "x-build-id": "YHwqFhs0S1rt8oelT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/corent1robert~germany-handelsregister-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-corent1robert-germany-handelsregister-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/corent1robert~germany-handelsregister-scraper/runs": { "post": { "operationId": "runs-sync-corent1robert-germany-handelsregister-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/corent1robert~germany-handelsregister-scraper/run-sync": { "post": { "operationId": "run-sync-corent1robert-germany-handelsregister-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": { "mode": { "title": "Mode", "enum": [ "keyword", "registerIds" ], "type": "string", "description": "**Company name** — keywords as on handelsregister.de extended search.\n\n**Register ids** — paste court + number (e.g. `Mannheim HRB 719915`).", "default": "keyword" }, "keywords": { "title": "Company name or keywords", "type": "string", "description": "Name as published in the register. **Ignored** in Register ids mode." }, "keywordMatch": { "title": "Keyword match", "enum": [ "all", "min", "exact" ], "type": "string", "description": "How keywords must match the company name. **Ignored** in Register ids mode.", "default": "all" }, "federalStates": { "title": "Federal states (optional, max 2)", "type": "array", "description": "Leave empty for all of Germany. The portal allows **at most two** states. **Ignored** in Register ids mode.", "items": { "type": "string", "enum": [ "Baden-Württemberg", "Bayern", "Berlin", "Brandenburg", "Bremen", "Hamburg", "Hessen", "Mecklenburg-Vorpommern", "Niedersachsen", "Nordrhein-Westfalen", "Rheinland-Pfalz", "Saarland", "Sachsen", "Sachsen-Anhalt", "Schleswig-Holstein", "Thüringen" ] } }, "registerArt": { "title": "Register type (optional)", "enum": [ "all", "HRB", "HRA", "GnR", "PR", "VR", "GsR" ], "type": "string", "description": "Limit to HRB (GmbH/AG), HRA, etc. **Ignored** in Register ids mode unless you also set it there via the pasted id.", "default": "all" }, "registerIds": { "title": "Court + register number", "type": "array", "description": "One company per line: `Mannheim HRB 719915` or `Amtsgericht München HRB 12345`. Duplicates are skipped. **Required** in Register ids mode; **ignored** in Company name mode.", "items": { "type": "string" } }, "enrichmentLevel": { "title": "Enrichment level", "enum": [ "basic", "profile", "kyb" ], "type": "string", "description": "**Basic** — court, HRB/HRA, name, city, status.\n\n**Profile** — adds legal form, capital, registration date and registered address.\n\n**KYB** — also extracts directors / legal representatives (name, role, date of birth when published).", "default": "profile" }, "officersScope": { "title": "Which officers (KYB)", "enum": [ "directors", "all" ], "type": "string", "description": "**Directors only** — Vorstand / Geschäftsführer (CRM-ready). **All representatives** also includes Prokuristen. **Ignored** on Basic and Profile.", "default": "directors" }, "maxResults": { "title": "Max companies — set 0 for all", "minimum": 0, "type": "integer", "description": "Cap how many companies to save. Default **25** = quick preview. Set **0** for every match (large lists take longer — raise the run timeout).", "default": 25 } } }, "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 } } } } } } } } } }