ConnectCloud Developers

Suggest the streets of a postal code (tenant:masterdata:read)

GET /api/masterdata/postal-lookup/streets

Module: Master data · operationId: listPostalStreets · Tag: Postal addresses · Auth: access token (Authorization: Bearer <accessToken>)

Street names of a postal code from OpenPLZ that start with q (case-insensitive, ß = ss, str. = straße), at most 50. Countries and errors as in listPostalLocalities.

Parameters

Name In Type Required Description
country query string ISO 3166-1 alpha-2: DE, AT, CH or LI (default "DE")
postalCode query string yes (max length 32)
q query string Beginning of the street name; empty lists all (max length 128)

Responses

  • 200 Street names (application/json)
  • 400 Malformed body or query parameter (application/json)
  • 401 Missing, invalid or expired token (empty body)
  • 403 The token lacks the permission or carries no tenant (application/json)
  • 503 The postal code lookup is switched off or OpenPLZ is unreachable; enter the place by hand (application/json)

Fields of the 200 answer:

  • items (array of string, required)

Example 200 answer:

{
  "items": [
    "Marienplatz",
    "Marienstr."
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/masterdata/postal-lookup/streets?postalCode=80331' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI