{ "openapi": "3.0.1", "info": { "title": "Handelsregister.de [$8💰] German Company Registry", "description": "Scrape the official German company register (handelsregister.de) — register number, court, status, legal form, registered address, officers with roles & birth dates, representation rules, and name history. Precise lookups or keyword search with filters. JSON or CSV out.", "version": "0.0", "x-build-id": "13M7eJcDzQWkDSPRe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~handelsregister-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-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/memo23~handelsregister-scraper/runs": { "post": { "operationId": "runs-sync-memo23-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/memo23~handelsregister-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-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": { "searchQueries": { "title": "Company name keywords (one search per line)", "type": "array", "description": "Company-name keywords, one search per entry, e.g. `Siemens` or `Bäckerei München`. The portal caps each search at 100 results, so split broad terms into narrower queries (by city, register type, or legal form).", "items": { "type": "string" } }, "keywordMatch": { "title": "Keyword matching", "enum": [ "all", "any", "exact" ], "type": "string", "description": "How the words inside one query combine: `all` — every word must appear; `any` — at least one word; `exact` — exact company name.", "default": "all" }, "registerType": { "title": "Register type", "enum": [ "", "HRA", "HRB", "GnR", "PR", "VR", "GsR" ], "type": "string", "description": "Restrict to one register: HRA (partnerships/sole traders), HRB (GmbH/AG), GnR (cooperatives), PR (professional partnerships), VR (associations), GsR (civil-law partnerships). Empty = all.", "default": "" }, "registerNumber": { "title": "Register number", "type": "string", "description": "Exact register number, e.g. `230633`. Combine with register type and court for a precise lookup." }, "registerCourt": { "title": "Register court", "type": "string", "description": "Amtsgericht that keeps the record, by name as on the portal — e.g. `München`, `Charlottenburg (Berlin)`, `Duisburg`." }, "legalForm": { "title": "Legal form", "type": "string", "description": "Filter by legal form label, e.g. `Gesellschaft mit beschränkter Haftung`, `Aktiengesellschaft`, `eingetragener Verein`." }, "postalCode": { "title": "Postal code", "type": "string", "description": "Filter by the company seat's postal code, e.g. `80331`." }, "city": { "title": "City", "type": "string", "description": "Filter by the company seat's city, e.g. `Hamburg`." }, "states": { "title": "Federal states", "type": "array", "description": "Restrict results to specific Bundesländer. Allowed values: Baden-Württemberg, Bayern, Berlin, Brandenburg, Bremen, Hamburg, Hessen, Mecklenburg-Vorpommern, Niedersachsen, Nordrhein-Westfalen, Rheinland-Pfalz, Saarland, Sachsen, Sachsen-Anhalt, Schleswig-Holstein, Thüringen.", "items": { "type": "string" } }, "includeDeleted": { "title": "Include deleted entries", "type": "boolean", "description": "Also return companies whose register entry has been deleted (gelöscht). Useful for due-diligence and history research.", "default": false }, "fetchStructuredData": { "title": "Fetch structured register data (address, officers, representation)", "type": "boolean", "description": "Download and parse the official SI document (structured XJustiz XML) for every company: registered street address, officers with roles and birth dates, representation rules, legal form. One extra request per company.", "default": true }, "includeRawXml": { "title": "Include raw XJustiz XML", "type": "boolean", "description": "Attach the raw SI XML string to each row (large — increases dataset size significantly). For users who need fields beyond the parsed set.", "default": false }, "maxItems": { "title": "Maximum companies to scrape", "minimum": 1, "type": "integer", "description": "Hard cap on company records pushed to the dataset across all queries.", "default": 1000 }, "maxConcurrency": { "title": "Max concurrent searches", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many portal sessions run in parallel (one per search query). Keep low — the portal is a government service and drops connections when hammered.", "default": 3 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "handelsregister.de is a public government portal with no anti-bot wall — datacenter proxies are sufficient.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }