{
  "openapi": "3.0.1",
  "info": {
    "title": "Northdata Company Monitor: Register Notices & Changes",
    "description": "Know the day a supplier, customer or borrower changes. Watch European companies on Northdata and get only the new register notices plus officer, address, status and name changes since your last run. Built for KYB, supplier-risk and credit teams.",
    "version": "0.1",
    "x-build-id": "KgsnaOI1K6bmcIlVH"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/automatic~northdata-company-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-automatic-northdata-company-monitor",
        "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/automatic~northdata-company-monitor/runs": {
      "post": {
        "operationId": "runs-sync-automatic-northdata-company-monitor",
        "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/automatic~northdata-company-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-automatic-northdata-company-monitor",
        "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": {
          "companyUrls": {
            "title": "Northdata company URLs",
            "maxItems": 500,
            "type": "array",
            "description": "Company pages on northdata.com (or .de/.fr), for example https://www.northdata.com/BASF SE, Ludwigshafen a. Rhein/Amtsgericht Ludwigshafen a.Rhein HRB 6000. Up to 500 companies per run across all three lists. Leave all three lists empty for a quick two-company sample.",
            "items": {
              "type": "string"
            }
          },
          "companyNames": {
            "title": "Company names",
            "maxItems": 500,
            "type": "array",
            "description": "Registered name, ideally with the city, for example 'SAP SE, Walldorf'. A name that matches more than one company is not guessed: the run lists possible matches in OUTPUT so you can pick the right URL.",
            "items": {
              "type": "string"
            }
          },
          "registerIds": {
            "title": "Register numbers",
            "maxItems": 500,
            "type": "array",
            "description": "Court and register number as Northdata shows it, for example 'Amtsgericht Mannheim HRB 719915' (Germany), 'FN 93363 z' (Austria), 'CHE-101.602.521' (Switzerland), 'CVR 24256790' (Denmark), 'BR 923609016' (Norway) or 'PRH 0112038-9' (Finland). Ambiguous numbers, and numbers that lead to a different company, are reported, never guessed.",
            "items": {
              "type": "string"
            }
          },
          "onlyNewSinceLastRun": {
            "title": "Only new since last run (monitor)",
            "type": "boolean",
            "description": "Turn on for scheduled watchlists. Each run returns only new or changed publications and company changes since the previous run with the same ledger name. The first run returns each company once plus its last 7 days of publications (see bootstrap)."
          },
          "ledgerName": {
            "title": "Ledger name",
            "maxLength": 64,
            "type": "string",
            "description": "Name of the saved watchlist state, for example 'suppliers-de'. Use one ledger per schedule; two runs with the same ledger must not overlap. Monitor mode only (default: 'default')."
          },
          "bootstrapMode": {
            "title": "First run of a new ledger",
            "enum": [
              "emit",
              "baseline"
            ],
            "type": "string",
            "description": "What the first monitor run does for a company it has not seen before. Monitor mode only (default: emit)."
          },
          "overlapHours": {
            "title": "Late-notice overlap (hours)",
            "minimum": 0,
            "maximum": 720,
            "type": "integer",
            "description": "Publications that appear late are still reported if they are dated within this many hours before the newest one already seen. Monitor mode only (default: 48)."
          },
          "resetLedger": {
            "title": "Reset ledger",
            "type": "boolean",
            "description": "Forget the saved state of this ledger and start a new baseline. Monitor mode only."
          },
          "includePublications": {
            "title": "Include publications",
            "type": "boolean",
            "description": "Register notices, filings and other public events listed on the company page (default: on). Off returns company records only."
          },
          "includeIpFilings": {
            "title": "Include patent and trademark filings",
            "type": "boolean",
            "description": "Patent, trademark and design filings are skipped by default because large companies have hundreds. Turn on to include them (default: off)."
          },
          "maxPublicationsPerCompany": {
            "title": "Publication records per company (full mode)",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "In a one-off run, also return this many of each company's newest publications as separate records (default: 0; every company record already lists its 5 newest). Monitor mode returns every new publication instead."
          },
          "publicationSince": {
            "title": "Publications since",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "Only publications dated on or after this day (YYYY-MM-DD). In monitor mode this sets the first-run window instead of the default 7 days."
          },
          "maxItems": {
            "title": "Maximum records",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Stop after this many records (company plus publication records; default 25). In monitor mode anything left over is kept and delivered first next run."
          },
          "requestIntervalSecs": {
            "title": "Seconds between page requests",
            "minimum": 3,
            "maximum": 30,
            "type": "number",
            "description": "Polite pacing between Northdata page requests (default 4). Northdata pages are large; expect roughly 6–10 companies per minute."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}