{ "openapi": "3.0.1", "info": { "title": "North Data Scraper", "description": "[💰 $4.0 / 1K] Extract European company data from North Data: profiles, registration numbers, addresses, officers and management, published financials, corporate networks, register events, and news.", "version": "1.0", "x-build-id": "Du7C69Ng9GehhlEr8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~northdata-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-northdata-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/solidcode~northdata-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-northdata-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/solidcode~northdata-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-northdata-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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Company names, manager names, keywords, or registration numbers to search North Data (e.g. \"Volkswagen AG\", \"BMW\", \"Siemens Energy\"). Each query returns its matching companies, fully enriched.", "items": { "type": "string" } }, "startUrls": { "title": "Company or search URLs", "type": "array", "description": "Direct North Data company or search-result URLs to scrape (e.g. https://www.northdata.com/Volkswagen+AG,+Wolfsburg/HRB+100484). Use this to target exact companies you already know.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "country": { "title": "Country", "enum": [ "", "DE", "AT", "CH", "GB", "FR", "NL", "BE", "LU", "IT", "ES", "PL", "CZ", "DK", "SE", "NO", "FI" ], "type": "string", "description": "Restrict search results to companies registered in a single country. Leave as \"Any country\" to search North Data's full European coverage.", "default": "" }, "resultType": { "title": "Result type", "enum": [ "companies", "people", "both" ], "type": "string", "description": "What kind of records to keep from a search. \"Companies only\" returns registered businesses; \"People only\" returns managers and officers; \"Companies and people\" keeps everything that matches.", "default": "companies" }, "includeFinancials": { "title": "Include financial reports", "type": "boolean", "description": "Include published financial figures and balance-sheet history (revenue, equity, balance-sheet total, profit/loss, employees) when available. German companies are legally required to publish these.", "default": true }, "includeOfficers": { "title": "Include officers & management", "type": "boolean", "description": "Include directors, managing directors, and other registered officers of each company, with their roles.", "default": true }, "includeRelatedCompanies": { "title": "Include related companies", "type": "boolean", "description": "Include companies linked through shared officers, ownership, or the corporate network graph (includes up to 25 related companies per record).", "default": false }, "includeEvents": { "title": "Include register events", "type": "boolean", "description": "Include trade-register events such as incorporations, name changes, capital changes, mergers, and insolvencies.", "default": false }, "includeNews": { "title": "Include news & publications", "type": "boolean", "description": "Include news mentions and publication references North Data has indexed for the company.", "default": false }, "maxResults": { "title": "Maximum results per query", "minimum": 1, "type": "integer", "description": "Maximum number of company (or people) records to scrape per search query. Direct company URLs are always scraped in full and do not count toward this limit." } } }, "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 } } } } } } } } } }