{ "openapi": "3.0.1", "info": { "title": "German Handelsregister Company Lookup (HRB/HRA)", "description": "Lookup German companies on handelsregister.de by keyword or HRB/HRA number. Returns court, seat, status, docs & name history. Pay per company.", "version": "0.1", "x-build-id": "rhWOgwnvdE0WUlJGR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/metsuryu~handelsregister-company-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-metsuryu-handelsregister-company-lookup", "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/metsuryu~handelsregister-company-lookup/runs": { "post": { "operationId": "runs-sync-metsuryu-handelsregister-company-lookup", "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/metsuryu~handelsregister-company-lookup/run-sync": { "post": { "operationId": "run-sync-metsuryu-handelsregister-company-lookup", "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": "Search queries", "type": "array", "description": "Company-name keywords, one portal search per entry (portal caps each search at 100 results). Example: Siemens, Gasag, Bäckerei München.", "default": [ "Gasag" ], "items": { "type": "string" } }, "keywordMatch": { "title": "Keyword match mode", "enum": [ "all", "any", "exact" ], "type": "string", "description": "all = contain every word; 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": "Optional: HRA, HRB, GnR, PR, VR, or GsR. Empty = all.", "default": "" }, "registerNumber": { "title": "Register number", "type": "string", "description": "Exact register number for a precise lookup (combine with register type / court).", "default": "" }, "registerCourt": { "title": "Register court", "type": "string", "description": "Amtsgericht name filter, e.g. München or Berlin (Charlottenburg). Best-effort text filter.", "default": "" }, "legalForm": { "title": "Legal form", "type": "string", "description": "Optional legal-form filter (portal label or abbreviation, e.g. GmbH).", "default": "" }, "postalCode": { "title": "Postal code", "type": "string", "description": "Seat postal code filter, e.g. 80331.", "default": "" }, "city": { "title": "City", "type": "string", "description": "Seat city filter, e.g. Hamburg.", "default": "" }, "street": { "title": "Street", "type": "string", "description": "Optional street filter.", "default": "" }, "states": { "title": "Federal states", "type": "array", "description": "Restrict to Bundesländer. Exact portal labels: Baden-Württemberg, Bayern, Berlin, Brandenburg, Bremen, Hamburg, Hessen, Mecklenburg-Vorpommern, Niedersachsen, Nordrhein-Westfalen, Rheinland-Pfalz, Saarland, Sachsen, Sachsen-Anhalt, Schleswig-Holstein, Thüringen.", "default": [], "items": { "type": "string" } }, "includeDeleted": { "title": "Include deleted entries", "type": "boolean", "description": "Also return gelöscht (deleted) register entries.", "default": false }, "maxItems": { "title": "Max companies", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on dataset rows across all queries (controls PPE cost). Portal also caps each search at 100.", "default": 100 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Polite pacing. Portal rate-limits aggressive clients; 600–1500 ms recommended.", "default": 800 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Datacenter proxies are usually enough (no CAPTCHA wall). Enable Apify Proxy on the platform.", "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 } } } } } } } } } }