Skip to content
HALOWERK

Signalwerk

branch gap map

Takes branches of a brand from the dated OpenStreetMap Germany extract (by brand:wikidata, plus the brand values used with it, the brand tag and exact name; ODbL) or your own list of branch coordinates, and the municipalities of a district (5-digit key), a state (2-digit key) or a radius from the Destatis municipality register (geographic centres and population 31.12.2025, Gebietsstand 30.09.2026). For each municipality the great-circle distance from its centre to the nearest branch is.

POST https://signal.halowerk.com/v1/branch-gap-map

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
brandstringNoBrand or exact business name (case-insensitive), e.g. "dm-drogerie markt".
brand_wikidatastringNoWikidata id of the brand (most precise).
branchesarrayNoAlternatively your own branch locations.
districtstringNoDistrict key (Kreis) as area.
statestringNoState key (Land, 01–16) as area.
latnumberNo
lonnumberNo
radius_kmnumberNoRadius of the area around lat/lon.
max_distance_kmnumberNoA municipality is a gap if its centre is farther than this from every branch.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "brand": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80,
      "description": "Brand or exact business name (case-insensitive), e.g. \"dm-drogerie markt\"."
    },
    "brand_wikidata": {
      "type": "string",
      "pattern": "^Q\\d{1,12}$",
      "description": "Wikidata id of the brand (most precise)."
    },
    "branches": {
      "type": "array",
      "minItems": 1,
      "maxItems": 5000,
      "description": "Alternatively your own branch locations.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "lat",
          "lon"
        ],
        "properties": {
          "lat": {
            "type": "number",
            "minimum": 47,
            "maximum": 55.2
          },
          "lon": {
            "type": "number",
            "minimum": 5.5,
            "maximum": 15.5
          },
          "name": {
            "type": "string",
            "maxLength": 120
          }
        }
      }
    },
    "district": {
      "type": "string",
      "pattern": "^\\d{5}$",
      "description": "District key (Kreis) as area."
    },
    "state": {
      "type": "string",
      "pattern": "^\\d{2}$",
      "description": "State key (Land, 01–16) as area."
    },
    "lat": {
      "type": "number",
      "minimum": 47,
      "maximum": 55.2
    },
    "lon": {
      "type": "number",
      "minimum": 5.5,
      "maximum": 15.5
    },
    "radius_km": {
      "type": "number",
      "minimum": 2,
      "maximum": 80,
      "description": "Radius of the area around lat/lon."
    },
    "max_distance_km": {
      "type": "number",
      "minimum": 0.5,
      "maximum": 50,
      "default": 5,
      "description": "A municipality is a gap if its centre is farther than this from every branch."
    }
  }
}

Open original schema

Published input example

{
  "brand_wikidata": "Q266572",
  "district": "05554",
  "max_distance_km": 5
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub →