Skip to content
HALOWERK

Datenwerk

commuter flows

Pinned official BA social-insurance employment matrix, reference 30 June 2025, published 15 January 2026. Returns incoming/outgoing relationships between German federal states, optional exact partner, ranked counts and explicitly marked own domestic sums. Original residence/workplace axes independently checked against OOXML. State-level annual snapshot, not travel tracking or district data.

POST https://daten.halowerk.com/v1/commuter-flows

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
statestringYesGerman federal-state code 01–16, e.g.01 Schleswig-Holstein,02 Hamburg,05 NRW,11 Berlin.
directionstringNoOutgoing: state is main residence. Incoming: state is workplace.
partner_statestringNoOptional exact other federal-state code. Same-state pairs are rejected.
limitintegerNoMaximum ranked partner rows; summary totals still cover all 15 other states.
yearintegerNoPinned reference year2025 only; cutoff 30 June 2025, state-level data.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "state"
  ],
  "properties": {
    "state": {
      "type": "string",
      "pattern": "^[0-9]{2}$",
      "description": "German federal-state code 01–16, e.g.01 Schleswig-Holstein,02 Hamburg,05 NRW,11 Berlin."
    },
    "direction": {
      "type": "string",
      "enum": [
        "outgoing",
        "incoming"
      ],
      "default": "outgoing",
      "description": "Outgoing: state is main residence. Incoming: state is workplace."
    },
    "partner_state": {
      "type": "string",
      "pattern": "^[0-9]{2}$",
      "description": "Optional exact other federal-state code. Same-state pairs are rejected."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 15,
      "default": 15,
      "description": "Maximum ranked partner rows; summary totals still cover all 15 other states."
    },
    "year": {
      "type": "integer",
      "enum": [
        2025
      ],
      "default": 2025,
      "description": "Pinned reference year2025 only; cutoff 30 June 2025, state-level data."
    }
  }
}

Open original schema

Published input example

{
  "state": "01",
  "direction": "outgoing",
  "partner_state": "02"
}

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 →