{ "openapi": "3.0.1", "info": { "title": "North Data Scraper | 2$/1k", "description": "Company registry data for 26 European countries: register number and court, LEI, EU ID, status, address, industry codes, officers with roles, published financials, register events and corporate network. Includes change monitoring for scheduled runs.", "version": "1.0", "x-build-id": "BQzeXGc8tjTOa94Aw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/trev0n~northdata-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-trev0n-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/trev0n~northdata-scraper/runs": { "post": { "operationId": "runs-sync-trev0n-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/trev0n~northdata-scraper/run-sync": { "post": { "operationId": "run-sync-trev0n-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": { "queries": { "title": "Company names or keywords", "type": "array", "description": "One entry per company or search term, e.g. Siemens AG, Tesco plc, Zalando SE. Each entry is searched separately, so you can look up a whole list of companies in one run. Works with plain names, brand names and register numbers.", "items": { "type": "string" } }, "startUrls": { "title": "Company URLs", "type": "array", "description": "Paste North Data company page addresses directly — one row comes back for each. Use this when you already know exactly which companies you want. Search result addresses work too and are expanded into a search.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "countries": { "title": "Countries", "type": "array", "description": "Restrict results to these countries. All 26 were verified individually against the live site. Leave empty to search everywhere.", "items": { "type": "string", "enum": [ "AT", "BE", "HR", "CY", "CZ", "DK", "EE", "FI", "FR", "DE", "GR", "IE", "IL", "LT", "LU", "MT", "NL", "NO", "PL", "PT", "RO", "SK", "ES", "SE", "CH", "GB" ], "enumTitles": [ "Austria", "Belgium", "Croatia", "Cyprus", "Czech Republic", "Denmark", "Estonia", "Finland", "France", "Germany", "Greece", "Ireland", "Israel", "Lithuania", "Luxembourg", "Malta", "Netherlands", "Norway", "Poland", "Portugal", "Romania", "Slovakia", "Spain", "Sweden", "Switzerland", "United Kingdom" ] } }, "statuses": { "title": "Company status", "type": "array", "description": "Keep only companies in these states. Leave empty to include every company, whatever its state.", "items": { "type": "string", "enum": [ "active", "liquidation", "terminated" ], "enumTitles": [ "Active", "In liquidation", "Terminated / dissolved" ] } }, "legalForms": { "title": "Legal forms", "type": "array", "description": "Keep only these legal forms, written exactly as they appear on the company page — for example GmbH, AG, Ltd., SA, B.V., sp. z o.o.", "items": { "type": "string" } }, "language": { "title": "Output language", "enum": [ "en", "de", "fr" ], "type": "string", "description": "The language of labels and descriptions in the results. Company names, addresses and register numbers always come back in their original form.", "default": "en" }, "maxResults": { "title": "Max companies", "minimum": 0, "type": "integer", "description": "Stop after this many companies. Set to 0 for no limit.", "default": 25 }, "includeFinancials": { "title": "Include published financials", "type": "boolean", "description": "Revenue, earnings, equity, total assets, employee numbers and more, per financial year, with the publication each figure came from. Only what the registers actually publish — North Data keeps its deepest financial analysis behind its own paywall.", "default": true }, "includeEvents": { "title": "Include register events", "type": "boolean", "description": "The company's timeline: registration, name and address changes, capital changes, management changes, mergers, insolvency filings, public funding and patents — each with its date and source register.", "default": true }, "includeOfficers": { "title": "Include officers and directors", "type": "boolean", "description": "The full list of people on record with their roles (CEO, managing director, board member, authorised signatory) and their home cities. This is the slowest option — one heavier page load per company.", "default": true }, "includeNetwork": { "title": "Include corporate network", "type": "boolean", "description": "Parent companies, subsidiaries and associated people, with the ownership relationship and share where the register states it.", "default": false }, "networkMaxNodes": { "title": "Corporate network size", "minimum": 3, "maximum": 200, "type": "integer", "description": "How far to expand the corporate network. Small numbers give the immediate parents and subsidiaries; large numbers walk the whole group and take noticeably longer.", "default": 25 }, "includeKeywords": { "title": "Must contain", "type": "array", "description": "Keep only companies whose name, city, website or corporate purpose contains all of these words.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Must not contain", "type": "array", "description": "Drop companies whose name, city, website or corporate purpose contains any of these words.", "items": { "type": "string" } }, "onlyWithFinancials": { "title": "Only companies with published financials", "type": "boolean", "description": "Drop companies that have never filed figures. Needs \"Include published financials\" switched on.", "default": false }, "minEmployees": { "title": "Minimum employees", "minimum": 0, "type": "integer", "description": "Keep only companies whose latest published employee number is at least this. Set to 0 to ignore. Needs \"Include published financials\" switched on.", "default": 0 }, "incrementalMode": { "title": "Only new or changed companies", "type": "boolean", "description": "Remembers what it saw last time and returns only companies that are new or whose register data actually changed. On a scheduled watch list this typically cuts the output by 80-95%.", "default": false }, "stateKey": { "title": "Watch list name", "type": "string", "description": "A name for this watch list, so several schedules can track different portfolios independently. Leave empty and one is derived from your search settings." }, "emitUnchanged": { "title": "Also return unchanged companies", "type": "boolean", "description": "Return every company every run, tagged with whether it changed. Useful for a full snapshot with change flags.", "default": false }, "emitExpired": { "title": "Also report disappearances", "type": "boolean", "description": "Add a row for each company that was on the list before and is no longer found.", "default": false }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Send the new and changed companies to this address as JSON at the end of each run." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Token of the Telegram bot that should send you the summary." }, "telegramChatId": { "title": "Telegram chat ID", "type": "string", "description": "The chat or channel that receives the summary." }, "discordWebhookUrl": { "title": "Discord webhook URL", "type": "string", "description": "Post the summary into a Discord channel." }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Post the summary into a Slack channel." }, "notificationLimit": { "title": "Companies per notification", "minimum": 1, "type": "integer", "description": "How many companies to list in the message before summarising the rest.", "default": 10 }, "notifyOnlyChanges": { "title": "Only notify when something changed", "type": "boolean", "description": "Stay silent on runs that found nothing new.", "default": true }, "includeRunSummary": { "title": "Include run statistics in the webhook", "type": "boolean", "description": "Add the counts of new, changed and disappeared companies to the webhook payload.", "default": true }, "compact": { "title": "Compact output", "type": "boolean", "description": "Return a short row per company — identity, register, address, contact details and the headline financials — instead of every field.", "default": false }, "excludeEmptyFields": { "title": "Drop empty fields", "type": "boolean", "description": "Leave out fields that have no value for a given company, for a slimmer export.", "default": false }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 16, "type": "integer", "description": "How many companies to look up at the same time. North Data starts refusing requests above roughly 16 from one address, so 8 is the safe default and 16 the hard ceiling.", "default": 8 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "North Data limits requests per address. A proxy spreads a run across several addresses and lets a refused request retry from a different one, which is what keeps larger runs and several simultaneous runs working.", "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 } } } } } } } } } }