{ "openapi": "3.0.1", "info": { "title": "Germany Company Registry & Financials Scraper (Handelsregister)", "description": "Scrape German companies from the Handelsregister: register court and number (HRB/HRA), legal form, status, registered office, share capital, business purpose, former names, published document availability including annual financial statements, and officers (managing directors /...", "version": "0.1", "x-build-id": "Vt7YfVwhdR6P1aPbw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~germany-company-financials-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-germany-company-financials-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/scrapers_lat~germany-company-financials-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-germany-company-financials-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/scrapers_lat~germany-company-financials-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-germany-company-financials-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": "One or more company names or keywords to search the German company register (Handelsregister). One run searches every term, for example [\"Siemens Energy\", \"BSH Hausgeräte\", \"BioNTech\"].", "items": { "type": "string" } }, "matchMode": { "title": "Match mode", "enum": [ "all", "any", "exact" ], "type": "string", "description": "How the keywords are matched against company names.", "default": "all" }, "registerType": { "title": "Register type", "enum": [ "", "HRB", "HRA", "GnR", "PR", "VR", "GsR" ], "type": "string", "description": "Optional. Restrict to one register: HRB (corporations, e.g. GmbH/AG), HRA (partnerships/sole traders), GnR (cooperatives), PR (partnerships of professionals), VR (associations), GsR. Leave empty for all.", "default": "" }, "states": { "title": "Federal states (Bundesländer)", "type": "array", "description": "Optional. Limit the search to one or more German federal states, for example [\"Bayern\", \"Berlin\"]. Leave empty to search all of Germany.", "items": { "type": "string" } }, "city": { "title": "City / registered office", "type": "string", "description": "Optional. Limit results to companies whose registered office (Sitz) is in this city." }, "includeDeleted": { "title": "Include deleted companies", "type": "boolean", "description": "Also return companies that have been struck off the register (gelöscht).", "default": false }, "enrichOfficers": { "title": "Enrich with officers, capital and address", "type": "boolean", "description": "Fetch each company's structured register extract to add legal form, share capital, registered address, business purpose and its officers (managing directors / Geschäftsführer, board members, authorised signatories). Recommended.", "default": true }, "maxCompanies": { "title": "Max companies to scrape", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of companies to return across all search terms." } } }, "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 } } } } } } } } } }