{
  "openapi": "3.0.1",
  "info": {
    "title": "Unternehmensregister Company and Financial Metadata",
    "description": "Extract German company profiles from Unternehmensregister by company name, EUID, or register number. Get legal forms, registered offices, register details, and optional financial filing metadata. Download selected free register extracts as PDF or XML when available. Returns one company per lookup.",
    "version": "0.1",
    "x-build-id": "g6cYsx1Iq08CA8xh7"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dominic-quaiser~unternehmensregister-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dominic-quaiser-unternehmensregister-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/dominic-quaiser~unternehmensregister-scraper/runs": {
      "post": {
        "operationId": "runs-sync-dominic-quaiser-unternehmensregister-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/dominic-quaiser~unternehmensregister-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-dominic-quaiser-unternehmensregister-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": {
          "company_name": {
            "title": "Company name or keywords",
            "type": "string",
            "description": "Selects the first company in the site's result order. Use an EUID or register filters to disambiguate."
          },
          "euid": {
            "title": "EUID",
            "type": "string",
            "description": "German company EUID, for example DER1304.HRB19107."
          },
          "exact_match": {
            "title": "Exact company name",
            "type": "boolean",
            "description": "Use the site's exact company-name search.",
            "default": false
          },
          "registered_office": {
            "title": "Registered office",
            "type": "string",
            "description": "Filter by the registered-office location."
          },
          "register_number": {
            "title": "Register number",
            "type": "string",
            "description": "Requires register_type and register_court."
          },
          "register_type": {
            "title": "Register type",
            "enum": [
              "alle",
              "HRA",
              "HRB",
              "GnR",
              "PR",
              "GsR"
            ],
            "type": "string",
            "description": "The registers offered by Unternehmensregister.",
            "default": "alle"
          },
          "register_court": {
            "title": "Register court",
            "type": "string",
            "description": "Court name (Kleve, München, Berlin (Charlottenburg)) or its official code. Names are resolved from the live website."
          },
          "legal_form": {
            "title": "Legal form",
            "type": "string",
            "description": "A legal-form name, abbreviation or site ID, such as GmbH, KG or 9."
          },
          "federal_states": {
            "title": "Federal states",
            "type": "array",
            "description": "State names or abbreviations, such as Nordrhein-Westfalen, NRW, NW, BY or BE.",
            "items": {
              "type": "string"
            }
          },
          "postal_code": {
            "title": "Postal code",
            "type": "string",
            "description": "Postal-code filter."
          },
          "city": {
            "title": "Address city",
            "type": "string",
            "description": "Address-city filter."
          },
          "street": {
            "title": "Street",
            "type": "string",
            "description": "Address-street filter."
          },
          "include_deleted": {
            "title": "Include deleted companies",
            "type": "boolean",
            "description": "Include closed register entries and deleted branches.",
            "default": false
          },
          "hide_branches": {
            "title": "Hide branches",
            "type": "boolean",
            "description": "Hide branches in the website search.",
            "default": false
          },
          "include_financial_records": {
            "title": "List financial records",
            "type": "boolean",
            "description": "List public accounting-publication and deposited-account metadata. Does not download content or buy documents.",
            "default": true
          },
          "max_financial_records": {
            "title": "Maximum financial records",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Combined cap for publication and deposit metadata, newest publication/deposit date first.",
            "default": 50
          },
          "max_pages": {
            "title": "Maximum publication pages",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Limits publication pagination. Output reports incomplete scans.",
            "default": 5
          },
          "page_size": {
            "title": "Page size",
            "type": "integer",
            "description": "Results per website page: 5, 10, 20, 30, 50 or 100.",
            "default": 100
          },
          "request_timeout_secs": {
            "title": "HTTP timeout (seconds)",
            "minimum": 5,
            "maximum": 120,
            "type": "integer",
            "description": "Time limit for each HTTP request.",
            "default": 30
          },
          "search_timeout_secs": {
            "title": "Whole search timeout (seconds)",
            "minimum": 10,
            "maximum": 600,
            "type": "integer",
            "description": "Time limit for the complete metadata search, including retries.",
            "default": 120
          },
          "max_retries": {
            "title": "HTTP retries",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Retries for network errors, rate limits, blocking and temporary server failures. With proxyConfiguration, each retry restarts the lookup using a fresh proxy session; direct access and a single proxy_url retry on the same route. Zero disables retries.",
            "default": 2
          },
          "request_interval_secs": {
            "title": "Minimum request interval (seconds)",
            "minimum": 0,
            "maximum": 10,
            "type": "number",
            "description": "Minimum interval between public website requests per search.",
            "default": 2
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify datacenter proxies are enabled by default (automatic group selection). Failed requests restart the lookup with a fresh proxy session. Supply custom proxy URLs or set useApifyProxy to false for direct access.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": []
            }
          },
          "proxy_url": {
            "title": "Direct proxy URL",
            "type": "string",
            "description": "Optional HTTP(S) proxy for standalone usage. Use either this field or an enabled proxyConfiguration."
          },
          "download_register_documents": {
            "title": "Download register extracts (optional surcharge)",
            "type": "boolean",
            "description": "Opt in to downloading selected register extracts that are free at the source. On Apify Free, an extra $0.02 is charged once per result with at least one file successfully saved and linked, regardless of file count ($0.05 including the base fee). Starter/Bronze, Scale/Silver and Business/Gold discounts of 20%, 30% and 40% apply to both fees. If only your plan's base fee fits the run budget, downloads are skipped with a warning. Financial documents are never downloaded.",
            "default": false
          },
          "register_document_types": {
            "title": "Register extracts to download",
            "type": "array",
            "description": "AD (current PDF), CD (chronological PDF), HD (historical PDF) or SI (structured XML). Only used when download_register_documents is true. DK and UT open separate browsing views and are not supported for automatic download.",
            "items": {
              "type": "string"
            },
            "default": [
              "AD"
            ]
          },
          "max_document_size_mb": {
            "title": "Maximum document size (MiB)",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Maximum decoded file size per register extract. Oversized files are rejected without saving them.",
            "default": 20
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}