{ "openapi": "3.0.1", "info": { "title": "North Data Scraper - German Company Financials & Officers", "description": "North Data scraper for German company financials and register data: search companies by name or keyword, get register court and ID, legal form, address, founding date, officers with roles, register events and yearly financial KPIs. Monitor mode returns only new register events. No login.", "version": "1.0", "x-build-id": "p7C2CR7UkWmDVzbtB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kamerozkan~northdata-german-company-financials/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kamerozkan-northdata-german-company-financials", "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/kamerozkan~northdata-german-company-financials/runs": { "post": { "operationId": "runs-sync-kamerozkan-northdata-german-company-financials", "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/kamerozkan~northdata-german-company-financials/run-sync": { "post": { "operationId": "run-sync-kamerozkan-northdata-german-company-financials", "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": [ "queries" ], "properties": { "queries": { "title": "Company names, keywords or North Data URLs", "type": "array", "description": "One entry per line: a company name (Siemens AG München), a keyword (Solar Berlin) or a North Data company page URL (https://www.northdata.com/Siemens+AG,+München/HRB+6684). Names and keywords run a North Data search; URLs are read directly.", "default": [ "Siemens AG München" ], "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max companies per search", "minimum": 1, "maximum": 300, "type": "integer", "description": "Search results to read per name or keyword (15 per result page). Direct URLs ignore this.", "default": 15 }, "maxItems": { "title": "Max companies in total", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many company records. You are charged per company record, so this also caps the cost of the run.", "default": 50 }, "countryCodes": { "title": "Only these countries", "type": "array", "description": "ISO country codes (DE, AT, CH, GB, FR, NL ...). Search results from other countries are skipped and not charged. Empty means all countries. Pasted company URLs are always read.", "default": [ "DE" ], "items": { "type": "string" } }, "includeFinancials": { "title": "Include financial KPIs", "type": "boolean", "description": "Yearly revenue, earnings, equity, employees, public funding and patents as North Data shows them for free (financials object plus latestRevenue, latestEarnings fields).", "default": true }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Current officers with their role (managing director, board member, authorized signatory) and the officer appointment history. Business role only, no private data.", "default": true }, "includeEvents": { "title": "Include register events", "type": "boolean", "description": "Register history (registration, name, capital, address, statute, merger, insolvency), M&A and public funding events with dates and source links.", "default": true }, "onlyNewEvents": { "title": "Monitor mode: only companies with new register events", "type": "boolean", "description": "Remembers the register events seen for each company in the named key-value store northdata-company-monitor. Later runs return and charge only companies that have new events (field newEvents). The first run of a watchlist returns every company.", "default": false }, "watchlistName": { "title": "Watchlist name", "type": "string", "description": "Separates independent monitor watchlists (for example one per client). Used only in monitor mode.", "default": "default" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is recommended. Datacenter proxies are used first; if North Data blocks them the run switches to residential proxies automatically.", "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }