{ "openapi": "3.0.1", "info": { "title": "Handelsregister API - German Company Register Scraper", "description": "Handelsregister API for German company register records from handelsregister.de: register court and number, legal form, seat, status, former names, address, share capital, purpose and officers from the structured register content. Search by name, city or register number.", "version": "1.0", "x-build-id": "tfN4s8F2dc17KcA6K" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kamerozkan~handelsregister-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kamerozkan-handelsregister-api", "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/kamerozkan~handelsregister-api/runs": { "post": { "operationId": "runs-sync-kamerozkan-handelsregister-api", "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/kamerozkan~handelsregister-api/run-sync": { "post": { "operationId": "run-sync-kamerozkan-handelsregister-api", "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": { "searchTerms": { "title": "Company names or keywords", "type": "array", "description": "Company names or keywords, one search each, e.g. 'Siemens Energy' or 'Trade Republic Bank'. The official portal returns at most 100 hits per search, so add a court, city or legal form to narrow broad words.", "items": { "type": "string" } }, "registerNumbers": { "title": "Register numbers", "type": "array", "description": "Look up companies by register type, number and court, e.g. 'HRB 252581 München' or 'Berlin (Charlottenburg) HRB 244347 B'. Register types: HRA, HRB, GnR, PR, VR, GsR.", "items": { "type": "string" } }, "keywordMatch": { "title": "Keyword match", "enum": [ "all", "any", "exact" ], "type": "string", "description": "How the portal matches the words: all words, at least one word (needs a court, register type, legal form or state as well) or the exact company name.", "default": "all" }, "registerCourt": { "title": "Register court", "type": "string", "description": "Only companies of this register court, by its city, e.g. München, Hamburg, Frankfurt am Main, Berlin (Charlottenburg), Köln. Leave empty for all of Germany." }, "registerType": { "title": "Register type", "enum": [ "HRA", "HRB", "GnR", "PR", "VR", "GsR" ], "type": "string", "description": "HRB = corporations (GmbH, AG, UG, SE), HRA = sole traders and partnerships (e.K., OHG, KG), GnR = cooperatives, PR = partnerships of professionals, VR = associations, GsR = civil-law partnerships." }, "legalForm": { "title": "Legal form", "enum": [ "8", "1", "6", "10", "12", "11", "2", "3", "55", "56", "13", "51", "16" ], "type": "string", "description": "Only companies with this legal form." }, "states": { "title": "Federal states", "type": "array", "description": "Only companies registered in these German states. Leave empty for all.", "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" ] } }, "city": { "title": "City (seat)", "type": "string", "description": "Only companies with their seat in this city, e.g. Leipzig." }, "postalCode": { "title": "Postal code", "type": "string", "description": "Only companies with this postal code, e.g. 10119." }, "includeDeleted": { "title": "Include deleted companies", "type": "boolean", "description": "Also return closed register sheets (dissolved or merged companies).", "default": false }, "similarSoundingNames": { "title": "Similar-sounding names", "type": "boolean", "description": "Let the portal also match similar-sounding words (phonetic search).", "default": false }, "includeDetails": { "title": "Structured register content (address, capital, officers)", "type": "boolean", "description": "Download the official structured register content (SI) of every company: business address, share capital, business purpose, founding date, representation rule, managing directors, board members, authorised signatories (name and role only) and branches. Adds one portal request per company.", "default": true }, "maxResultsPerSearch": { "title": "Max companies per search", "minimum": 1, "maximum": 100, "type": "integer", "description": "Companies taken from each search (the portal itself stops at 100 hits).", "default": 10 }, "maxItems": { "title": "Max companies", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many companies in total. You are charged per company, so this also caps the cost of the run.", "default": 50 }, "onlyNewCompanies": { "title": "Only companies not seen before (monitor)", "type": "boolean", "description": "Remember every company delivered under the monitor name and skip it in later runs, so a scheduled run returns (and charges) only newly registered or newly matching companies.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Separate memory for each monitor, e.g. 'new-gmbh-leipzig'.", "default": "default" }, "requestDelaySecs": { "title": "Delay between portal requests (seconds)", "minimum": 2, "maximum": 30, "type": "integer", "description": "Pause between requests to the public portal. Minimum 2.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Every search runs in its own portal session. Apify Proxy (datacenter) is recommended: the portal often refuses document downloads from shared cloud IPs.", "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 }, "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 } } } } } } } } } }