{
  "openapi": "3.0.1",
  "info": {
    "title": "Northdata Scraper - Company Register, Officers & Financials",
    "description": "Northdata scraper for company register data from Germany, the Netherlands, Austria, Switzerland and France. Search by company name, North Data URL or register ID and get status, address, LEI, officers, register filings and public financials in one row per company.",
    "version": "0.1",
    "x-build-id": "AThNBiuTG9VSFzOxg"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/s-r~northdata-company/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-s-r-northdata-company",
        "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/s-r~northdata-company/runs": {
      "post": {
        "operationId": "runs-sync-s-r-northdata-company",
        "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/s-r~northdata-company/run-sync": {
      "post": {
        "operationId": "run-sync-s-r-northdata-company",
        "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": "Queries",
            "type": "array",
            "description": "Company names, Northdata company URLs or register IDs. German HRA/HRB/GnR/VR/PR/GsR IDs require the court city; register codes are case-insensitive.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country",
            "enum": [
              "",
              "DE",
              "NL",
              "AT",
              "CH",
              "FR"
            ],
            "type": "string",
            "description": "Restrict companies to this jurisdiction. Empty selects all five supported countries."
          },
          "max_results": {
            "title": "Max results",
            "minimum": 1,
            "maximum": 15,
            "type": "integer",
            "description": "Companies per name query, in Northdata relevance order. URL and register-ID queries return at most one."
          },
          "include_officers": {
            "title": "Include officers",
            "type": "boolean",
            "description": "Include publicly visible officers and dated mandate changes. Dutch companies may have no public officers."
          },
          "include_filings": {
            "title": "Include filings",
            "type": "boolean",
            "description": "Include public register publication summaries and Northdata document references."
          },
          "max_filings": {
            "title": "Max filings",
            "minimum": 0,
            "maximum": 200,
            "type": "integer",
            "description": "Newest publications per company, including year bundles. Zero returns no publication rows."
          },
          "include_financials": {
            "title": "Include financials",
            "type": "boolean",
            "description": "Include public numeric series and balance sheets. Locked Premium values are never collected."
          },
          "cursor": {
            "title": "Cursor",
            "maxLength": 500000,
            "type": "string",
            "description": "Continuation token from next_cursor. Send it with the original input unchanged."
          },
          "searchQueries": {
            "title": "Searchqueries",
            "type": "array",
            "description": "Alternative input name for queries; combines with other supplied query lists.",
            "items": {
              "type": "string"
            }
          },
          "search": {
            "title": "Search",
            "type": "array",
            "description": "Alternative input name for queries; combines with other supplied query lists.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Starturls",
            "type": "array",
            "description": "Northdata company URLs as strings or objects with a url property; combines with query lists."
          },
          "maxResults": {
            "title": "Maxresults",
            "minimum": 1,
            "maximum": 15,
            "type": "integer",
            "description": "Alternative input name for max_results. The snake_case field takes precedence when both are supplied."
          },
          "maxItems": {
            "title": "Maxitems",
            "minimum": 1,
            "maximum": 15,
            "type": "integer",
            "description": "Alternative input name for max_results. The snake_case field takes precedence when both are supplied."
          },
          "includeOfficers": {
            "title": "Includeofficers",
            "type": "boolean",
            "description": "Alternative input name for include_officers. The snake_case field takes precedence when both are supplied."
          },
          "includeFinancials": {
            "title": "Includefinancials",
            "type": "boolean",
            "description": "Alternative input name for include_financials. The snake_case field takes precedence when both are supplied."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}