{ "openapi": "3.0.1", "info": { "title": "Germany Handelsregister Scraper", "description": "Search the official German Handelsregister and export company names, court, HRB/HRA number, seat, status, history, and document metadata.", "version": "0.1", "x-build-id": "JU16cfklbGqsOeJ7m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~germany-handelsregister-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-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/automation-lab~germany-handelsregister-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-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/automation-lab~germany-handelsregister-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-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": { "companyNames": { "title": "🏢 Company names or keywords", "type": "array", "description": "German company names or keywords to search in the normal Handelsregister search form.", "items": { "type": "string" } }, "registerNumbers": { "title": "# Register numbers", "type": "array", "description": "Optional exact register-number lookups. Use when you already know an HRB/HRA/VR/GnR/PR/GsR number.", "items": { "type": "object", "required": [ "registerNumber" ], "properties": { "registerType": { "type": "string", "enum": [ "HRA", "HRB", "GnR", "PR", "VR", "GsR" ], "title": "Register type", "description": "Register category such as HRB or HRA.", "editor": "select" }, "registerNumber": { "type": "string", "title": "Register number", "description": "The numeric register identifier without the register type prefix.", "editor": "textfield" }, "registerCourt": { "type": "string", "title": "Register court", "description": "Court label as displayed on handelsregister.de, e.g. München or Berlin (Charlottenburg).", "editor": "textfield" }, "queryLabel": { "type": "string", "title": "Query label", "description": "Optional label stored in the output query field.", "editor": "textfield" } } } }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum dataset rows to save across all searches.", "default": 20 }, "exactCompanyName": { "title": "Exact company-name mode", "type": "boolean", "description": "Use the portal's exact company-name option instead of all-keywords search.", "default": false }, "searchSeat": { "title": "Seat / location filter", "type": "string", "description": "Optional Niederlassung / Sitz filter." }, "registerCourt": { "title": "Default register court", "type": "string", "description": "Optional court filter applied to company-name searches and register-number entries without their own court." }, "includeDeleted": { "title": "Include closed/deleted register sheets", "type": "boolean", "description": "Enable the portal option for closed register sheets or deleted branch offices.", "default": false }, "resultsPerPage": { "title": "Results per portal page", "minimum": 10, "maximum": 100, "type": "integer", "description": "Requested page size on the Handelsregister result page. The portal may still paginate at its own limit.", "default": 10 }, "navigationDelayMs": { "title": "Navigation delay (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Extra delay after JSF navigation. Increase only if the portal is slow.", "default": 750 } } }, "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 } } } } } } } } } }