{
  "openapi": "3.0.1",
  "info": {
    "title": "North Data Scraper ($0.95/1K): German & EU Company Data",
    "description": "Scrape North Data (northdata.com / .de): German and European company register data with register number, address, purpose, revenue, earnings, history, officers, network and publications; risk signals, monitoring with alerts.",
    "version": "0.0",
    "x-build-id": "LIhafnhyNJ5Sz3ccT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tsutseisoftware~northdata-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tsutseisoftware-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/tsutseisoftware~northdata-scraper/runs": {
      "post": {
        "operationId": "runs-sync-tsutseisoftware-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/tsutseisoftware~northdata-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-tsutseisoftware-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": "What to look up, as you would type it on North Data: a company name (Zalando SE, Bosch), a keyword (Bäckerei, software), a register number (HRB 6684) or the name of a person. Each query is a separate search with up to 45 results (what North Data shows); use \"Max results per search\" 1 for the best match of each name in a list.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max results",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of rows saved in the run (all searches and URLs together). You pay per saved row. 0 = no limit.",
            "default": 50
          },
          "maxResultsPerQuery": {
            "title": "Max results per search",
            "minimum": 1,
            "maximum": 45,
            "type": "integer",
            "description": "How many companies each search query returns, best matches first (1–45; North Data shows at most 45 per search). 1 = only the best match of each name.",
            "default": 10
          },
          "aroundPoints": {
            "title": "Companies around a point",
            "type": "array",
            "description": "Every company registered within a radius of a map point: latitude, longitude and radius in km (e.g. 52.5219, 13.4132, 0.3 around Alexanderplatz, Berlin). Up to 10,000 companies per point, with North Data's own risk rating; ideal for local lead lists. Combine with the filters (legal form, status, ...).",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerPoint": {
            "title": "Max results per point",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "How many companies each point returns (1–10,000).",
            "default": 100
          },
          "startUrls": {
            "title": "North Data URLs",
            "type": "array",
            "description": "Company profiles (https://www.northdata.com/Siemens%20AG,%20M%C3%BCnchen/HRB%206684, also from northdata.de or northdata.fr), search pages (https://www.northdata.com/search?query=siemens) and, with personal data on, person profiles. A company URL is always read, whatever \"Max results per search\" is.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "language": {
            "title": "Language",
            "enum": [
              "en",
              "de",
              "fr"
            ],
            "type": "string",
            "description": "Language of the labels, register events, roles and the translated corporate purpose. Names, addresses and register numbers stay as registered.",
            "default": "en"
          },
          "resultType": {
            "title": "Result type",
            "enum": [
              "companies",
              "people",
              "both"
            ],
            "type": "string",
            "description": "What a search keeps. People are directors and owners with the companies they are linked to; they need \"Include officers and people (personal data)\".",
            "default": "companies"
          },
          "readCompanyProfiles": {
            "title": "Read company profiles",
            "type": "boolean",
            "description": "Open every company's profile for the register details, address, purpose, published figures, register history and legal structure (charged as \"Company profile\"). Off = only what the search shows (name, city, country, register, status, map point): faster and cheaper.",
            "default": true
          },
          "includeFinancials": {
            "title": "Published figures",
            "type": "boolean",
            "description": "Revenue, earnings, employees, total assets, equity, public funding and patents per year with the publication they come from, and the balance sheet of listed companies. Only what the registers publish: many small companies have none, and some figures North Data shows only to its subscribers (premiumOnlyMetrics names them).",
            "default": true
          },
          "includeEvents": {
            "title": "Register history",
            "type": "boolean",
            "description": "Dated register events: registration, name, legal form and register changes, capital, address moves, mergers, liquidation, insolvency, trademarks, patents and public funding. Changes of directors only with personal data on.",
            "default": true
          },
          "maxEvents": {
            "title": "Max events per company",
            "minimum": 0,
            "type": "integer",
            "description": "Newest register events kept per company (0 = all).",
            "default": 30
          },
          "includePublications": {
            "title": "Publications",
            "type": "boolean",
            "description": "Register announcements and other publications about the company (date, source, summary, link).",
            "default": false
          },
          "includeMentions": {
            "title": "Mentions",
            "type": "boolean",
            "description": "Publications that mention the company (e.g. of its parent or subsidiaries).",
            "default": false
          },
          "maxPublications": {
            "title": "Max publications per company",
            "minimum": 0,
            "type": "integer",
            "description": "Newest publications and mentions kept per company (0 = all).",
            "default": 20
          },
          "includeNetwork": {
            "title": "Add company network (paid)",
            "type": "boolean",
            "description": "Parent companies, subsidiaries and companies linked by address or control, with the relationship (e.g. \"Direct parent company\", \"100 % limited partnership capital\"). One more page per company, charged as \"Company network\". Connected people only with personal data on.",
            "default": false
          },
          "networkMaxNodes": {
            "title": "Max network nodes",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "With \"Add company network\": at most this many linked companies (and people), the directly linked ones first. Empty or 0 = all North Data shows."
          },
          "includeRiskRating": {
            "title": "Add North Data risk rating (paid)",
            "type": "boolean",
            "description": "North Data's own risk rating (green, yellow, red: sanctions lists, legal proceedings) for every company, charged as \"Risk rating\" only where it was found. Companies around a point have it at no extra cost.",
            "default": false
          },
          "includeContactDetails": {
            "title": "Add contact details (paid)",
            "type": "boolean",
            "description": "Website, phone numbers and e-mail addresses that the company itself published (e.g. in the EU Transparency Register), where North Data has such a publication; charged as \"Contact details\" only for companies with at least one found. Not for sole traders unless personal data is on.",
            "default": false
          },
          "includePersonalData": {
            "title": "Include officers and people (personal data)",
            "type": "boolean",
            "description": "Names of directors, board members and authorised signatories with their roles, cities and dates, the changes of directors in the register history, connected people in the network, people in search results and person profiles. This is personal data: you are responsible for processing it lawfully (GDPR). Off = only the number of officers per role.",
            "default": false
          },
          "countries": {
            "title": "Countries",
            "type": "array",
            "description": "Keep only companies registered in these countries: ISO codes or English names, e.g. DE, AT, CH, Germany, France, United Kingdom.",
            "items": {
              "type": "string"
            }
          },
          "statuses": {
            "title": "Company status",
            "type": "array",
            "description": "Keep only companies with these statuses.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "liquidation",
                "insolvency",
                "terminated"
              ],
              "enumTitles": [
                "Active",
                "In liquidation",
                "Insolvency (entry in the last 3 years)",
                "Terminated (dissolved)"
              ]
            }
          },
          "legalForms": {
            "title": "Legal forms",
            "type": "array",
            "description": "Keep only these legal forms, e.g. GmbH, AG, SE, UG (haftungsbeschränkt), GmbH & Co. KG, KG, e. K., Ltd., SAS, B.V., s.r.o., sp. z o.o.",
            "items": {
              "type": "string"
            }
          },
          "naceCodes": {
            "title": "NACE codes",
            "type": "array",
            "description": "Keep only companies in these industries: NACE codes or their beginnings (62 = IT services, 62.1, 47.91). From the industry North Data shows; companies without a known code are left out.",
            "items": {
              "type": "string"
            }
          },
          "includeKeywords": {
            "title": "Must contain",
            "type": "array",
            "description": "Keep only companies whose name, city, industry or corporate purpose contains all of these words.",
            "items": {
              "type": "string"
            }
          },
          "excludeKeywords": {
            "title": "Must not contain",
            "type": "array",
            "description": "Leave out companies whose name, city, industry or corporate purpose contains any of these words.",
            "items": {
              "type": "string"
            }
          },
          "onlyMatchingNames": {
            "title": "Only names that match the query",
            "type": "boolean",
            "description": "Keep only companies whose name (or former name) contains every word of the query, or whose register number is the number in the query. North Data also returns companies linked to the query in other ways (shareholders, publications).",
            "default": false
          },
          "onlyWithFinancials": {
            "title": "Only with published figures",
            "type": "boolean",
            "description": "Leave out companies without any published figure.",
            "default": false
          },
          "minEmployees": {
            "title": "Min employees",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only companies whose latest published employee number is at least this."
          },
          "minRevenue": {
            "title": "Min revenue",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only companies whose latest published revenue is at least this (in the company's currency, e.g. 1000000 = €1M)."
          },
          "riskLevels": {
            "title": "Risk level",
            "type": "array",
            "description": "Keep only companies with these risk levels (riskLevel: high = terminated, in liquidation, insolvency in the last 3 years or flagged by North Data; medium = losses, frequent changes of directors or address, a young company or an older insolvency).",
            "items": {
              "type": "string",
              "enum": [
                "low",
                "medium",
                "high"
              ],
              "enumTitles": [
                "Low",
                "Medium",
                "High"
              ]
            }
          },
          "compactOutput": {
            "title": "Compact rows",
            "type": "boolean",
            "description": "A short row per company: identity, register, address, headline figures, contacts and risk, without the lists (figures per year, history, publications, network).",
            "default": false
          },
          "omitEmptyFields": {
            "title": "Leave out empty fields",
            "type": "boolean",
            "description": "Drop fields without a value from each row, for a slimmer export.",
            "default": false
          },
          "onlyNewOrChanged": {
            "title": "Monitoring: only new or changed companies",
            "type": "boolean",
            "description": "Return new companies and companies whose name, status, legal form, register, address, capital, headline figures, number of officers, insolvency, register history or publications changed, with the changed fields, the previous values and the new register events and publications. For a watch list, give the companies as URLs; with search queries, \"new\" means newly among the first results.",
            "default": false
          },
          "monitoringKey": {
            "title": "Monitoring key",
            "type": "string",
            "description": "Name of the remembered state; use a different key for every watch list. Empty = \"default\"."
          },
          "includeUnchanged": {
            "title": "Monitoring: also return unchanged companies",
            "type": "boolean",
            "description": "Return the unchanged companies too, with changeType unchanged (charged like any row).",
            "default": false
          },
          "includeRemoved": {
            "title": "Monitoring: report companies gone",
            "type": "boolean",
            "description": "A company you gave as a URL whose profile is no longer on North Data is returned once with changeType removed.",
            "default": false
          },
          "telegramBotToken": {
            "title": "Telegram bot token",
            "type": "string",
            "description": "Token of your bot from @BotFather."
          },
          "telegramChatId": {
            "title": "Telegram chat ID",
            "type": "string",
            "description": "Chat, group or channel to send to (e.g. 123456789 or -1001234567890)."
          },
          "slackWebhookUrl": {
            "title": "Slack webhook URL",
            "type": "string",
            "description": "Incoming webhook (https://hooks.slack.com/...)."
          },
          "discordWebhookUrl": {
            "title": "Discord webhook URL",
            "type": "string",
            "description": "Webhook of your Discord channel (https://discord.com/api/webhooks/...). In Discord: channel settings → Integrations → Webhooks → Copy Webhook URL. Stored encrypted."
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "Any HTTPS URL (Zapier, Make, n8n, your server): receives the companies as JSON."
          },
          "whatsappAccessToken": {
            "title": "WhatsApp access token",
            "type": "string",
            "description": "Access token of the WhatsApp Cloud API of your Meta business account, used with \"WhatsApp phone number ID\" and \"WhatsApp recipient number\" (step by step in the README, section \"WhatsApp notifications: setup\"). For scheduled runs use a permanent token of a system user: Business settings → System users → Generate token, with the permissions whatsapp_business_messaging and whatsapp_business_management; the token of WhatsApp → API Setup expires within hours. Stored encrypted."
          },
          "whatsappPhoneNumberId": {
            "title": "WhatsApp phone number ID",
            "type": "string",
            "description": "ID of your WhatsApp business number that sends the message (not the number itself), e.g. 106540352242922. In your Meta app: WhatsApp → API Setup → Phone number ID."
          },
          "whatsappTo": {
            "title": "WhatsApp recipient number",
            "type": "string",
            "description": "Phone number that gets the message, in international format with the country code (e.g. +420601234567); up to 5 numbers separated by commas or new lines, each gets its own message and the notification is charged once per run. A test number of Meta sends only to numbers you added and confirmed under API Setup → To. Stored encrypted."
          },
          "whatsappTemplateName": {
            "title": "WhatsApp template name",
            "type": "string",
            "description": "Name of your approved message template (WhatsApp Manager → Message templates, e.g. apify_results), recommended: WhatsApp delivers a template message at any time. Its body gets the run summary with the first results in {{1}} and the dataset link in {{2}} (a template with only {{1}} gets both in {{1}}). Empty: a plain text message, which WhatsApp delivers only when the recipient wrote to your business number in the last 24 hours, so a scheduled run usually needs a template. Meta charges your business account for template messages (step by step in the README, section \"WhatsApp notifications: setup\")."
          },
          "whatsappTemplateLanguage": {
            "title": "WhatsApp template language",
            "type": "string",
            "description": "Language code of the template exactly as WhatsApp Manager → Message templates shows it next to the template, e.g. en_US, en_GB, cs, sk, pl or de. Used only with \"WhatsApp template name\".",
            "default": "en_US"
          },
          "webhookHeaders": {
            "title": "Webhook headers",
            "type": "object",
            "description": "HTTP headers sent with the webhook, e.g. {\"Authorization\": \"Bearer <your token>\"} for a server that needs a key. Header values are hidden in error reports."
          },
          "notificationLimit": {
            "title": "Max companies per notification",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many companies the message lists.",
            "default": 10
          },
          "notifyOnlyChanges": {
            "title": "Notify only when something was found",
            "type": "boolean",
            "description": "No message after a run that saved nothing.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "North Data accepts only a few requests a minute from one address: Apify Proxy (automatic, no extra cost) keeps bigger runs fast and reliable. Without a proxy the run reads about 13 pages a minute.",
            "default": {
              "useApifyProxy": true
            }
          },
          "maxConcurrency": {
            "title": "Parallel connections",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Pages read at the same time, each at North Data's pace (1–10; about 13 pages a minute each). Without a proxy always 1.",
            "default": 6
          },
          "exportFormats": {
            "title": "Extra export formats",
            "type": "array",
            "description": "Off by default. Printable HTML report: the results as a clean, branded table with the main columns, made for printing, saving as PDF or sending to someone; for working with the data use Excel or CSV, which have every field. Markdown table: the same columns as text for AI tools, docs or GitHub. The Output tab links the files. Each file has the overview columns of every saved row and nothing is left out, so a run with tens of thousands of rows makes a file of tens of MB that can be slow to open; for big runs use the dataset or its Excel export. Excel (XLSX), CSV and JSON are always in the Output tab and under Export, at no extra cost.",
            "items": {
              "type": "string",
              "enum": [
                "html",
                "markdown"
              ],
              "enumTitles": [
                "Printable HTML report",
                "Markdown table"
              ]
            },
            "default": []
          },
          "sendErrorReports": {
            "title": "Send error reports",
            "type": "boolean",
            "description": "When a run fails, send the developer a short error report: the error and your input with secrets left out (tokens, webhooks and e-mails are hidden). Your results are never sent. Reports are deleted after at most 120 hours. Turn off to send nothing.",
            "default": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}