{
  "openapi": "3.0.1",
  "info": {
    "title": "North Data Scraper - EU Company Register, Officers & Financials",
    "description": "Scrape North Data company records by name, person, register number, address or URL: register and court, status, address, LEI, officers with roles, yearly financials, history, publications, linked companies. Monitor mode. $0.90 per 1,000 companies, no login.",
    "version": "0.1",
    "x-build-id": "6JcTqTigKSfX4OWc1"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~northdata-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-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/topapi~northdata-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-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/topapi~northdata-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-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": "🔍 Company, person or register number",
            "type": "array",
            "description": "Company names, brands, keywords, person names or register numbers, one per line, e.g. \"Zalando\", \"Siemens Energy\", \"HRB 6684\", \"bäckerei münchen\". North Data URLs pasted here work too.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 North Data URLs",
            "type": "array",
            "description": "North Data company pages (northdata.com/Zalando%20SE,%20Berlin/HRB%20158855), person pages and search URLs (northdata.com/siemens?offset=0), from northdata.com, .de or .fr. A text file of URLs works too.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "addresses": {
            "title": "📍 Street addresses",
            "type": "array",
            "description": "Addresses with the country, one per line, e.g. \"Werner-von-Siemens-Str. 1, 80333 München, Germany\": the companies registered there.",
            "items": {
              "type": "string"
            }
          },
          "resultType": {
            "title": "Record type",
            "enum": [
              "companies",
              "people",
              "both"
            ],
            "type": "string",
            "description": "What to keep from a search: companies, people (officers, managers) or both.",
            "default": "companies"
          },
          "maxItems": {
            "title": "Maximum rows",
            "minimum": 0,
            "type": "integer",
            "description": "Upper limit on rows for the whole run (0 = no limit). Rows are charged only when delivered.",
            "default": 20
          },
          "maxResultsPerQuery": {
            "title": "Maximum rows per search",
            "minimum": 1,
            "maximum": 45,
            "type": "integer",
            "description": "Upper limit per search or address (North Data shows at most 45 matches per search signed out). Empty = no per-search limit."
          },
          "countries": {
            "title": "🌍 Countries",
            "type": "array",
            "description": "Keep only companies in these countries. With a country set, each search also asks North Data's own country-filtered suggestions, so more matches come from that country.",
            "items": {
              "type": "string",
              "enum": [
                "DE",
                "AT",
                "CH",
                "GB",
                "FR",
                "NL",
                "BE",
                "LU",
                "IT",
                "ES",
                "PT",
                "PL",
                "CZ",
                "SK",
                "DK",
                "SE",
                "NO",
                "FI",
                "EE",
                "LT",
                "LV",
                "IE",
                "HR",
                "CY",
                "GR",
                "MT",
                "RO",
                "BG",
                "HU",
                "SI",
                "UA",
                "IL",
                "LI",
                "MC",
                "AL",
                "XK",
                "US"
              ],
              "enumTitles": [
                "Germany",
                "Austria",
                "Switzerland",
                "United Kingdom",
                "France",
                "Netherlands",
                "Belgium",
                "Luxembourg",
                "Italy",
                "Spain",
                "Portugal",
                "Poland",
                "Czech Republic",
                "Slovakia",
                "Denmark",
                "Sweden",
                "Norway",
                "Finland",
                "Estonia",
                "Lithuania",
                "Latvia",
                "Ireland",
                "Croatia",
                "Cyprus",
                "Greece",
                "Malta",
                "Romania",
                "Bulgaria",
                "Hungary",
                "Slovenia",
                "Ukraine",
                "Israel",
                "Liechtenstein",
                "Monaco",
                "Albania",
                "Kosovo",
                "United States"
              ]
            }
          },
          "statuses": {
            "title": "Company status",
            "type": "array",
            "description": "Keep only companies in these states.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "in liquidation",
                "terminated",
                "insolvency"
              ],
              "enumTitles": [
                "Active",
                "In liquidation",
                "Terminated / deleted",
                "Insolvency"
              ]
            }
          },
          "legalForms": {
            "title": "Legal forms",
            "type": "array",
            "description": "Keep only these legal forms, as written in the company name, e.g. \"GmbH\", \"AG\", \"Ltd\", \"SAS\", \"B.V.\", \"sp. z o.o.\".",
            "items": {
              "type": "string"
            }
          },
          "cities": {
            "title": "Cities",
            "type": "array",
            "description": "Keep companies whose city contains one of these words, e.g. \"Berlin\", \"München\".",
            "items": {
              "type": "string"
            }
          },
          "registerCourts": {
            "title": "Register courts",
            "type": "array",
            "description": "Keep companies whose register entry contains one of these words, e.g. \"Munich\", \"Charlottenburg\", \"Companies House\", \"HRB\".",
            "items": {
              "type": "string"
            }
          },
          "nameIncludes": {
            "title": "Name must contain one of",
            "type": "array",
            "description": "Keep companies with at least one of these words in the name or a former name.",
            "items": {
              "type": "string"
            }
          },
          "nameExcludes": {
            "title": "Name must not contain",
            "type": "array",
            "description": "Drop companies with any of these words in the name, e.g. \"Holding\", \"Verwaltungs\".",
            "items": {
              "type": "string"
            }
          },
          "foundedAfter": {
            "title": "Founded on or after",
            "type": "string",
            "description": "Founding date window start (2024-01-01)."
          },
          "foundedBefore": {
            "title": "Founded on or before",
            "type": "string",
            "description": "Founding date window end."
          },
          "foundedWithinDays": {
            "title": "Founded within the last days",
            "minimum": 0,
            "type": "integer",
            "description": "Only companies founded in the last N days (pairs with monitor mode for new-company alerts)."
          },
          "publishedAfter": {
            "title": "Register publication after",
            "type": "string",
            "description": "Only companies with a register publication (filing, officer change, report) on or after this date."
          },
          "minRevenue": {
            "title": "Minimum revenue",
            "minimum": 0,
            "type": "integer",
            "description": "Latest published yearly revenue, in the company's currency. Companies without a published figure are skipped."
          },
          "maxRevenue": {
            "title": "Maximum revenue",
            "minimum": 0,
            "type": "integer",
            "description": "Latest published yearly revenue upper limit."
          },
          "minEmployees": {
            "title": "Minimum employees",
            "minimum": 0,
            "type": "integer",
            "description": "Latest published employee number at least this (companies without a published figure are skipped)."
          },
          "onlyWithFinancials": {
            "title": "Only companies with published figures",
            "type": "boolean",
            "description": "Skip companies with no yearly revenue, earnings, employee or balance figures.",
            "default": false
          },
          "minOfficers": {
            "title": "Minimum officers",
            "minimum": 0,
            "type": "integer",
            "description": "Keep companies with at least this many current officers (managing directors, board members, authorised signatories)."
          },
          "insolvency": {
            "title": "Insolvency events",
            "enum": [
              "any",
              "only",
              "exclude"
            ],
            "type": "string",
            "description": "Filter on insolvency publications.",
            "default": "any"
          },
          "withLeiOnly": {
            "title": "Only companies with an LEI",
            "type": "boolean",
            "description": "Keep only companies with a Legal Entity Identifier.",
            "default": false
          },
          "includeDetails": {
            "title": "Read the full company profile",
            "type": "boolean",
            "description": "Adds address, register details, LEI, purpose, industry, capital, officers, figures, history, publications and linked companies. Off = cheaper list rows from the search page.",
            "default": true
          },
          "includeOfficers": {
            "title": "Officers",
            "type": "boolean",
            "description": "Every officer North Data lists (managing directors, board members, authorised signatories, former ones without a role) with role, city and person link.",
            "default": true
          },
          "includeFinancials": {
            "title": "Financials",
            "type": "boolean",
            "description": "Yearly series (revenue, earnings, employees, total assets, public funding, patents) with the publication each figure came from, and the latest balance sheet.",
            "default": true
          },
          "includeEvents": {
            "title": "History and events",
            "type": "boolean",
            "description": "Register timeline: registration, name, address, capital and statute changes, management changes, funding, mergers and acquisitions.",
            "default": true
          },
          "includePublications": {
            "title": "Publications and mentions",
            "type": "boolean",
            "description": "Dated register publications and mentions with source and linked company.",
            "default": true
          },
          "includeRelatedCompanies": {
            "title": "Linked companies",
            "type": "boolean",
            "description": "Parents, shareholdings, merger partners and other companies named in the publications, with the relation.",
            "default": true
          },
          "maxEvents": {
            "title": "Events per timeline",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "Most recent events kept per timeline (history, management changes, funding, M&A).",
            "default": 50
          },
          "maxPublications": {
            "title": "Publications per company",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "Most recent publications and mentions kept per company (the total count is always in publicationCount).",
            "default": 25
          },
          "language": {
            "title": "Language",
            "enum": [
              "en",
              "de",
              "fr"
            ],
            "type": "string",
            "description": "Language of roles, event texts and register labels. Names, addresses and numbers are always original.",
            "default": "en"
          },
          "compact": {
            "title": "Compact rows",
            "type": "boolean",
            "description": "A short row per company: identity, register, address, headline figures and the first 10 officers.",
            "default": false
          },
          "excludeEmptyFields": {
            "title": "Leave out empty fields",
            "type": "boolean",
            "description": "Drop fields with no value from each row.",
            "default": false
          },
          "monitorMode": {
            "title": "Monitor mode (only new or changed companies)",
            "type": "boolean",
            "description": "Remember companies between runs and return only new or changed ones, with changeType and changedFields.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Named key-value store that holds the monitor memory. Use one name per watch list.",
            "default": "northdata-monitor"
          },
          "monitorEmit": {
            "title": "What to deliver in monitor mode",
            "enum": [
              "newAndChanged",
              "newOnly"
            ],
            "type": "string",
            "description": "New and changed companies, or new ones only.",
            "default": "newAndChanged"
          },
          "emitUnchanged": {
            "title": "Also deliver unchanged companies",
            "type": "boolean",
            "description": "Return every company every run, tagged changeType new / changed / unchanged (each row is charged).",
            "default": false
          },
          "resetMonitor": {
            "title": "Reset monitor memory",
            "type": "boolean",
            "description": "Forget what earlier runs saw and start over.",
            "default": false
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "POST the delivered companies (count + first rows) as JSON to this URL at the end of the run."
          },
          "slackWebhookUrl": {
            "title": "Slack webhook URL",
            "type": "string",
            "description": "Post a summary into a Slack channel."
          },
          "discordWebhookUrl": {
            "title": "Discord webhook URL",
            "type": "string",
            "description": "Post a summary into a Discord channel."
          },
          "telegramBotToken": {
            "title": "Telegram bot token",
            "type": "string",
            "description": "Token of the Telegram bot that sends the summary."
          },
          "telegramChatId": {
            "title": "Telegram chat ID",
            "type": "string",
            "description": "The chat or channel that receives the summary."
          },
          "notificationLimit": {
            "title": "Companies listed per alert",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "How many companies to list in the message before summarising the rest.",
            "default": 10
          },
          "notifyOnlyChanges": {
            "title": "Alert only when something was found",
            "type": "boolean",
            "description": "Stay silent on runs that delivered nothing.",
            "default": true
          },
          "requestDelayMillis": {
            "title": "Delay between requests (ms)",
            "minimum": 0,
            "maximum": 60000,
            "type": "integer",
            "description": "Minimum gap between two requests from the same IP. North Data limits requests per IP; the default (1,200 ms, two at a time) stays fast for small runs. Raise it for gentler runs."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. By default the run uses its own connection, then an Apify datacenter IP, then a residential IP, each paced under North Data's per-IP request limit. Set your own proxy here to spread a large run."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}