{
  "openapi": "3.0.1",
  "info": {
    "title": "Handelsregister Scraper & API: German Company Register | $7/1K",
    "description": "Search the German Handelsregister by name, HRB number or filters and get the official register data: managing directors with birth date, Prokura, shareholders, share capital, address, business purpose, founding date and name history. No 100-result cap. From $5 per 1,000 companies.",
    "version": "0.0",
    "x-build-id": "Fdp7AQmgAn9vOnon0"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/epicscrapers~handelsregister-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-epicscrapers-handelsregister-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/epicscrapers~handelsregister-scraper/runs": {
      "post": {
        "operationId": "runs-sync-epicscrapers-handelsregister-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/epicscrapers~handelsregister-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-epicscrapers-handelsregister-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": {
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Company names or keywords, register numbers (\"HRB 215511\", optionally with the court: \"HRB 215511 Berlin\", \"Amtsgericht München HRB 12345\") or EUIDs (\"DEF1103R.HRB215511B\"). Each term is one search. Leave empty to search by the filters below only.",
            "items": {
              "type": "string"
            }
          },
          "keywordMode": {
            "title": "Keyword matching",
            "enum": [
              "all",
              "any",
              "exact"
            ],
            "type": "string",
            "description": "How keywords in a search term are matched against company names. Not used for register numbers.",
            "default": "all"
          },
          "similarSounding": {
            "title": "Include similar-sounding names",
            "type": "boolean",
            "description": "Also match names that sound like the keywords (e.g. Meier / Mayer).",
            "default": false
          },
          "maxResults": {
            "title": "Max companies per search",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "The register returns at most 100 companies per search. Above 100, a search that hits that limit is split automatically into narrower searches (by state, court, register type and street) until all companies are found or this number is reached.",
            "default": 100
          },
          "states": {
            "title": "Federal states",
            "type": "array",
            "description": "Only companies registered in these states. Empty = all of Germany.",
            "items": {
              "type": "string",
              "enum": [
                "Baden-Württemberg",
                "Bayern",
                "Berlin",
                "Brandenburg",
                "Bremen",
                "Hamburg",
                "Hessen",
                "Mecklenburg-Vorpommern",
                "Niedersachsen",
                "Nordrhein-Westfalen",
                "Rheinland-Pfalz",
                "Saarland",
                "Sachsen",
                "Sachsen-Anhalt",
                "Schleswig-Holstein",
                "Thüringen"
              ],
              "enumTitles": [
                "Baden-Württemberg",
                "Bavaria (Bayern)",
                "Berlin",
                "Brandenburg",
                "Bremen",
                "Hamburg",
                "Hesse (Hessen)",
                "Mecklenburg-Western Pomerania",
                "Lower Saxony (Niedersachsen)",
                "North Rhine-Westphalia (NRW)",
                "Rhineland-Palatinate",
                "Saarland",
                "Saxony (Sachsen)",
                "Saxony-Anhalt",
                "Schleswig-Holstein",
                "Thuringia (Thüringen)"
              ]
            }
          },
          "city": {
            "title": "City",
            "type": "string",
            "description": "City of the business address (Ort), e.g. \"Hamburg\"."
          },
          "postalCode": {
            "title": "Postal code",
            "type": "string",
            "description": "Postal code of the business address, e.g. \"10115\". Note: as of November 2026 the register itself fails on postal-code searches (internal error 500); use city or register court instead."
          },
          "street": {
            "title": "Street",
            "type": "string",
            "description": "Street of the business address."
          },
          "legalForm": {
            "title": "Legal form",
            "enum": [
              "1",
              "2",
              "3",
              "4",
              "5",
              "6",
              "7",
              "8",
              "9",
              "10",
              "11",
              "12",
              "13",
              "14",
              "15",
              "16",
              "17",
              "18",
              "19",
              "40",
              "46",
              "48",
              "49",
              "51",
              "52",
              "53",
              "54",
              "55",
              "56",
              "57",
              "58"
            ],
            "type": "string",
            "description": "Only companies of this legal form. The register needs at least one more criterion (a search term, city, court…). Via the API you can also pass an abbreviation such as \"GmbH\", \"AG\", \"KG\" or \"e.V.\"."
          },
          "registerType": {
            "title": "Register type",
            "enum": [
              "HRA",
              "HRB",
              "GnR",
              "PR",
              "VR",
              "GsR"
            ],
            "type": "string",
            "description": "Only entries of this register."
          },
          "registerCourt": {
            "title": "Register court",
            "enum": [
              "R3101",
              "Y1201",
              "D3101",
              "D3201",
              "Y1101",
              "R1901",
              "Y1102",
              "Y1303",
              "D4102",
              "D2102",
              "P3101",
              "M1305",
              "M1202",
              "T2101",
              "R2108",
              "Y1301",
              "D4201",
              "D4301",
              "F1103",
              "R2101",
              "R2201",
              "R3201",
              "P1103",
              "H1101",
              "U1206",
              "D4401",
              "R2707",
              "G1103",
              "M1103",
              "D2201",
              "R2402",
              "U1104",
              "R1202",
              "R3103",
              "R1101",
              "Y1105",
              "Y1106",
              "M1602",
              "R2503",
              "X1112",
              "G1207",
              "M1201",
              "B1204",
              "M1405",
              "M1603",
              "M1301",
              "D3304",
              "R2507",
              "Y1203",
              "M1406",
              "Y1108",
              "P2204",
              "Y1205",
              "R2103",
              "R2602",
              "K1101",
              "R2404",
              "M1502",
              "P2305",
              "Y1109",
              "Y1302",
              "P2408",
              "D4501",
              "V1102",
              "D5701",
              "R2604",
              "Y1206",
              "T3201",
              "M1607",
              "D2304",
              "X1517",
              "R1304",
              "T2210",
              "R3306",
              "M1203",
              "M1608",
              "R1402",
              "T3304",
              "D2404",
              "R1105",
              "V1103",
              "U1308",
              "R2307",
              "M1706",
              "X1721",
              "T3104",
              "P2507",
              "T2304",
              "B1601",
              "M1809",
              "Y1304",
              "D2505",
              "V1104",
              "R1504",
              "T2214",
              "Y1110",
              "D2601",
              "R2713",
              "N1105",
              "V1105",
              "G1309",
              "R1102",
              "Y1111",
              "D3310",
              "M1114",
              "P3210",
              "P3313",
              "V1107",
              "R2809",
              "D2803",
              "X1321",
              "Y1209",
              "Y1208",
              "G1312",
              "R2204",
              "D3410",
              "N1206",
              "Y1210",
              "V1109",
              "V1110",
              "D4608",
              "N1308",
              "R3208",
              "R2909",
              "Y1112",
              "Y1113",
              "Y1307",
              "V1111",
              "V1112",
              "P2106",
              "Y1214",
              "R2706",
              "W1215",
              "N1209",
              "D3413",
              "B2609",
              "Y1308",
              "P2613",
              "D2910",
              "B2805",
              "V1115",
              "P2716",
              "D3508",
              "Y1114",
              "M1710",
              "M1906",
              "T2408",
              "R1608",
              "D4708",
              "T3403"
            ],
            "type": "string",
            "description": "Only entries of this local court (Amtsgericht)."
          },
          "includeDeleted": {
            "title": "Include closed register entries",
            "type": "boolean",
            "description": "Also return companies whose register sheet is closed (deleted, merged or moved). The register offers no structured details for them, so these rows only have name, register number, court, seat and status.",
            "default": false
          },
          "fetchStructuredData": {
            "title": "Fetch register details",
            "type": "boolean",
            "description": "Download the structured register content (SI) for every company: address, managing directors and other officers with birth dates, share capital, business purpose, founding date, representation rules. Turn off for a fast, cheaper list with name, register number, court, seat, status and name history only.",
            "default": true
          },
          "includeRawXml": {
            "title": "Include raw XML",
            "type": "boolean",
            "description": "Add the original XJustiz XML of the register content to each company (field siXml). Large; only for fields beyond the parsed ones.",
            "default": false
          },
          "maxItems": {
            "title": "Max companies in total",
            "minimum": 0,
            "type": "integer",
            "description": "Stop the run after this many companies across all searches. Empty or 0 = no limit."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "German residential proxies are the default: they dropped fewer connections in testing. Traffic is small (about 2 MB per 100 companies).",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "DE"
            }
          },
          "maxConcurrency": {
            "title": "Parallel sessions",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Companies fetched at the same time. The register takes about 7 seconds per structured extract and slows down or refuses requests when overloaded, so more sessions mostly add errors.",
            "default": 3
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}