{ "openapi": "3.0.1", "info": { "title": "Handelsregister API", "description": "Access valuable key company data from the German Commercial Register in realtime from Handelsregister.de: shareholders, executives, addresses, court details, and official documents. Ideal for LegalTech, compliance, and due diligence workflows.", "version": "0.0", "x-build-id": "QrAHophTCpulpOatb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/radeance~handelsregister-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-radeance-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/radeance~handelsregister-api/runs": { "post": { "operationId": "runs-sync-radeance-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/radeance~handelsregister-api/run-sync": { "post": { "operationId": "run-sync-radeance-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": { "identifier": { "title": "Company EU-ID or Register Identifier", "pattern": "^(DE[A-Z0-9]{4,6}\\.(HRA|HRB|GnR|PR|VR|GsR)\\d{4,6}[A-Z]?|DE\\-(HRA|HRB|GnR|PR|VR|GsR)\\-[A-Z0-9]{5,6}\\-\\d{4,6})$", "type": "string", "description": "Supports EU-ID identifer like `DEF1234R.HRB123456B` or register identifier like `DE-HRB-F1234R-123456`" }, "keyword": { "title": "Company Name or Company Keyword", "type": "string", "description": "Supports company name or keyword to search for the company" }, "register_type": { "title": "Register Type", "enum": [ "HRA", "HRB", "GnR", "PR", "VR", "GsR" ], "type": "string", "description": "Select the type of register to search in", "default": "HRB" }, "register_number": { "title": "Register Number", "pattern": "^[0-9-]+$", "type": "string", "description": "Enter the register number if known, otherwise leave empty to search by identifier or keyword" }, "register_court": { "title": "Register Court", "enum": [ "all", "aachen", "altenburg", "amberg", "ansbach", "apolda", "arnsberg", "arnstadt", "arnstadt zweigstelle ilmenau", "aschaffenburg", "augsburg", "aurich", "bad hersfeld", "bad homburg v.d.h.", "bad kreuznach", "bad oeynhausen", "bad salzungen", "bamberg", "bayreuth", "berlin (charlottenburg)", "bielefeld", "bochum", "bonn", "braunschweig", "bremen", "chemnitz", "coburg", "coesfeld", "cottbus", "darmstadt", "deggendorf", "dortmund", "dresden", "duisburg", "düren", "düsseldorf", "eisenach", "erfurt", "eschwege", "essen", "flensburg", "frankfurt am main", "frankfurt/oder", "freiburg", "friedberg", "fritzlar", "fulda", "fürth", "gelsenkirchen", "gera", "gießen", "gotha", "göttingen", "greiz", "gütersloh", "hagen", "hamburg", "hamm", "hanau", "hannover", "heilbad heiligenstadt", "hildburghausen", "hildesheim", "hof", "homburg", "ingolstadt", "iserlohn", "jena", "kaiserslautern", "kassel", "kempten (allgäu)", "kiel", "kleve", "koblenz", "köln", "königstein", "korbach", "krefeld", "landau", "landshut", "langenfeld", "lebach", "leipzig", "lemgo", "limburg", "lübeck", "ludwigshafen a.rhein (ludwigshafen)", "lüneburg", "mainz", "mannheim", "marburg", "meiningen", "memmingen", "merzig", "mönchengladbach", "montabaur", "mühlhausen", "münchen", "münster", "neubrandenburg", "neunkirchen", "neuruppin", "neuss", "nordhausen", "nürnberg", "offenbach am main", "oldenburg (oldenburg)", "osnabrück", "ottweiler", "paderborn", "passau", "pinneberg", "pößneck", "pößneck zweigstelle bad lobenstein", "potsdam", "recklinghausen", "regensburg", "rostock", "rudolstadt", "saarbrücken", "saarlouis", "schweinfurt", "schwerin", "siegburg", "siegen", "sömmerda", "sondershausen", "sonneberg", "stadthagen", "stadtroda", "steinfurt", "stendal", "st. ingbert (st ingbert)", "stralsund", "straubing", "stuttgart", "st. wendel (st wendel)", "suhl", "tostedt", "traunstein", "ulm", "völklingen", "walsrode", "weiden i. d. opf.", "weimar", "wetzlar", "wiesbaden", "wittlich", "wuppertal", "würzburg", "zweibrücken" ], "type": "string", "description": "Select a register court if known, otherwise leave on all to search by identifier or keyword", "default": "all" }, "deep_search": { "title": "Include Company Deep Search (Legal Form, Business Purpose,Share Capital, Headquarters ..)", "type": "boolean", "description": "Whether to include in-depth company information like `business_purpose`, `founding_date`, `share_capital`, `headquarters`..", "default": true }, "include_representatives": { "title": "Include Company Representatives (Company Deep Search Add-On)", "type": "boolean", "description": "Whether to include company representatives like `managing_directors`, `shareholders`, `board_members`. This only works if `deep_search` is set to true.", "default": true }, "include_address": { "title": "Include Business Address (Company Deep Search Add-On)", "type": "boolean", "description": "Whether to include company headquarter address information like `street`, `postal_code`, `city`, `country`. This only works if `deep_search` is set to true.", "default": true }, "include_documents": { "title": "Include Register Court Documents (Company Deep Search Add-On)", "type": "boolean", "description": "Whether to include and store company documents information like `current_printout`, `chronological_printout`, `historical_printout` `structured_content` etc. to the Apify Key-Value Storage. This only works if `deep_search` is set to true.", "default": false }, "document_types": { "title": "Select document types to store", "uniqueItems": true, "type": "array", "description": "Select the types of documents you need and to store in the Apify Key-Value Storage. Defaults to `current_printout`", "items": { "type": "string", "enum": [ "current_printout", "chronological_printout", "historical_printout", "shareholders_list", "partnership_agreement", "supervisory_board_list", "structured_content" ], "enumTitles": [ "AD - Current Printout", "CD - Chronological Printout", "HD - Historical Printout", "SL - Shareholders List", "PA - Partnership Agreement", "SB - Supervisory Board Members List", "SI - Structured Content" ] } }, "storage_name": { "title": "Name of the Storage for company documents", "pattern": "^[a-zA-Z0-9-]+$", "minLength": 3, "maxLength": 32, "type": "string", "description": "Store documents to a specified storage name. It is recommended to use a unique name for longer storage retention. If not provided, your documents will be available for 7 days." } } }, "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 } } } } } } } } } }