{ "openapi": "3.0.1", "info": { "title": "Handelsregister Scraper", "description": "Leistungsstarker Actor zur Identifikation von Firmen und Entscheidungsträgern aus dem deutschen Handelsregister. Zugriff auf Geschäftsführer, Vorstände und vertretungsberechtigte Personen per Echtzeit-API — ideal für Lead-Enrichment, Marktanalysen, KYC und Due-Diligence.", "version": "1.2", "x-build-id": "02bbFzBNfY8IRD2Vz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dominic-quaiser~handelsregister-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dominic-quaiser-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/dominic-quaiser~handelsregister-scraper/runs": { "post": { "operationId": "runs-sync-dominic-quaiser-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/dominic-quaiser~handelsregister-scraper/run-sync": { "post": { "operationId": "run-sync-dominic-quaiser-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", "required": [ "registerart" ], "properties": { "firma_schlagwoerter": { "title": "Firma oder Schlagwörter", "type": "string", "description": "Geben Sie einen Firmennamen oder Schlagwörter ein, nach denen gesucht werden soll. Sie können mehrere Begriffe durch Leerzeichen trennen.", "default": "Katjes Fassin GmbH + Co. KG" }, "schlagwoerter_suchoptionen": { "title": "Suche nach Einträgen, die", "enum": [ "alle Schlagwörter enthalten.", "mindestens ein Schlagwort enthalten.", "den genauen Firmennamen enthalten." ], "type": "string", "description": "Wählen Sie aus, wie die eingegebenen Schlagwörter bei der Suche verwendet werden sollen: alle müssen vorkommen, mindestens eines, oder als exakter Firmenname. WICHTIG: Bei Auswahl von 'mindestens ein Schlagwort enthalten' muss zusätzlich eine Registerart, Registergericht oder Registernummer angegeben werden.", "default": "alle Schlagwörter enthalten." }, "aehnlich_lautende_schlagwoerter": { "title": "auch ähnlich lautende Schlagwörter suchen", "type": "boolean", "description": "Wenn aktiviert, werden auch phonetisch ähnliche Begriffe in die Suche einbezogen (z.B. 'Meyer' findet auch 'Meier', 'Mayer').", "default": false }, "niederlassung_sitz": { "title": "Niederlassung / Sitz", "type": "string", "description": "Geben Sie den Ort oder die Stadt ein, in der die Niederlassung oder der Firmensitz liegt (z.B. 'München', 'Hamburg')." }, "zusaetzliche_suchoptionen": { "title": "Zusätzliche Suchoptionen", "enum": [ "Auch geschlossene Registerblätter oder gelöschte Zweigniederlassungen finden.", "Nur nach Zweigniederlassungen neuen Rechts suchen." ], "type": "string", "description": "Erweiterte Suchoptionen: Entweder auch gelöschte/geschlossene Einträge einbeziehen oder die Suche auf Zweigniederlassungen neuen Rechts beschränken." }, "registernummer": { "title": "Registernummer", "type": "string", "description": "Die eindeutige Registernummer des gesuchten Unternehmens (z.B. '12345'). Maximale Länge: 10 Zeichen." }, "registerart": { "title": "Registerart", "enum": [ "alle", "HRA", "HRB", "GnR", "PR", "VR", "GsR" ], "type": "string", "description": "Die Art des Handelsregisters: HRA (Abteilung A - Einzelkaufleute, OHG, KG), HRB (Abteilung B - GmbH, AG, KGaA), GnR (Genossenschaftsregister), PR (Partnerschaftsregister), VR (Vereinsregister), GsR (Gesellschaftsregister).", "default": "alle" }, "registergericht": { "title": "Registergericht", "type": "string", "description": "Stadt oder Ort des Registergerichts (z.B. 'München', 'Chemnitz', 'Berlin (Charlottenburg)') oder 'alle' für alle Gerichte. Das System korrigiert automatisch kleine Rechtschreibfehler.", "default": "alle" }, "xml_im_key_value_store_speichern": { "title": "XML im Key-Value Store speichern", "type": "boolean", "description": "Wenn aktiviert, wird die originale XML-Datei (Strukturierter Registerinhalt) im Key-Value Store gespeichert.", "default": false }, "proxyConfiguration": { "title": "Proxy-Konfiguration", "type": "object", "description": "Legt die Proxy-Server fest, die vom Scraper verwendet werden, um seine Herkunft zu verbergen.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "DE" } } } }, "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 } } } } } } } } } }