Autocomplete Services

Autocomplete services provide suggestions as the user types — ideal for progressive form filling. All methods accept a partial input and return a ranked list of matching completions.

Method names: postCodeAutocomplete · cityNameAutocomplete · streetAutocomplete · addressAutocomplete · companyAutocomplete

Postal Code Autocomplete

Suggest postal codes matching a prefix, scoped to a country.

Method: postCodeAutocomplete

API KeyNot set

Stored in localStorage — never sent to this site.

Parameters

Country Code *ISO 3166-1 Alpha-2

Postal Code Prefix *

Language

Request Preview

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "postCodeAutocomplete",
  "params": {}
}

Set an API key above to enable live requests.

Parameters

Field	Required	Type	Description
country	Yes	String	ISO 3166-1 Alpha-2 country code (e.g. DE)
postCode	Yes	String	Partial postal code prefix (e.g. 972)
language	No	String	Output language (e.g. de)

Response

{
  "result": {
    "predictions": [
      { "postCode": "97209", "cityName": "Veitshöchheim" },
      { "postCode": "97218", "cityName": "Gerbrunn" },
      { "postCode": "97222", "cityName": "Rimpar" },
      { "postCode": "97232", "cityName": "Giebelstadt" }
    ]
  }
}

Example Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "postCodeAutocomplete",
  "params": {
    "country": "DE",
    "postCode": "972"
  }
}

---

City Name Autocomplete

Suggest city names matching a prefix, scoped to a country.

Method: cityNameAutocomplete

API KeyNot set

Stored in localStorage — never sent to this site.

Parameters

Country Code *ISO 3166-1 Alpha-2

City Name Prefix *

Language

Request Preview

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "cityNameAutocomplete",
  "params": {}
}

Set an API key above to enable live requests.

Parameters

Field	Required	Type	Description
country	Yes	String	ISO 3166-1 Alpha-2 country code (e.g. DE)
cityName	Yes	String	Partial city name (e.g. Würzb)
language	No	String	Output language (e.g. de)

Response

{
  "result": {
    "predictions": [
      { "cityName": "Würzburg", "postCode": "97070" },
      { "cityName": "Würzburg", "postCode": "97072" },
      { "cityName": "Würzburg", "postCode": "97074" }
    ]
  }
}

Example Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "cityNameAutocomplete",
  "params": {
    "country": "DE",
    "cityName": "Würzb"
  }
}

---

Street Autocomplete

Suggest street names within a specific city and postal code. Requires the city context to be known first (e.g. from cityNameAutocomplete).

Method: streetAutocomplete

API KeyNot set

Stored in localStorage — never sent to this site.

Parameters

Country Code *ISO 3166-1 Alpha-2

Postal Code *

City Name *

Street Name Prefix *

Language

Request Preview

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "streetAutocomplete",
  "params": {}
}

Set an API key above to enable live requests.

Parameters

Field	Required	Type	Description
country	Yes	String	ISO 3166-1 Alpha-2 country code (e.g. DE)
postCode	Yes	String	Full postal code of the city
cityName	Yes	String	Full city name
street	Yes	String	Partial street name prefix (e.g. Linden)
language	No	String	Output language (e.g. de)

Response

The response includes both streetName (preferred) and street (deprecated alias, kept for v1 compatibility).

{
  "result": {
    "predictions": [
      { "streetName": "Lindenstraße", "street": "Lindenstraße" },
      { "streetName": "Lindenbühlweg", "street": "Lindenbühlweg" }
    ]
  }
}

Example Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "streetAutocomplete",
  "params": {
    "country": "DE",
    "postCode": "97232",
    "cityName": "Giebelstadt",
    "street": "Linden"
  }
}

---

Address Autocomplete

Suggest complete addresses from a free-text input. This is the most flexible method — it accepts an unstructured string and returns structured address predictions.

Method: addressAutocomplete

API KeyNot set

Stored in localStorage — never sent to this site.

Parameters

Country Code *ISO 3166-1 Alpha-2

Partial Address *

Language

Request Preview

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "addressAutocomplete",
  "params": {}
}

Set an API key above to enable live requests.

Parameters

Field	Required	Type	Description
country	Yes	String	ISO 3166-1 Alpha-2 country code (e.g. DE)
addressFull	Yes	String	Free-text partial address (e.g. Lindenstr 2, Giebelstadt)
language	No	String	Output language (e.g. de)

Response

{
  "result": {
    "predictions": [
      {
        "postCode": "97232",
        "cityName": "Giebelstadt",
        "street": "Lindenstraße",
        "houseNumber": "28",
        "addressFull": "Lindenstraße 28, 97232 Giebelstadt"
      }
    ]
  }
}

Example Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "addressAutocomplete",
  "params": {
    "country": "DE",
    "addressFull": "Lindenstr 2, Giebelstadt"
  }
}

---

Company Autocomplete

Suggest company names matching a partial input. Optionally scoped to a country.

Method: companyAutocomplete

API KeyNot set

Stored in localStorage — never sent to this site.

Parameters

Company Name Prefix *

Country Code ISO 3166-1 Alpha-2, optional filter

Request Preview

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "companyAutocomplete",
  "params": {}
}

Set an API key above to enable live requests.

Parameters

Field	Required	Type	Description
companyName	Yes	String	Partial company name (e.g. Endereco)
countryCode	No	String	ISO 3166-1 Alpha-2 country code to narrow results (e.g. DE)

Response

{
  "result": {
    "predictions": [
      {
        "companyName": "Endereco UG (haftungsbeschränkt)",
        "postCode": "97236",
        "cityName": "Randersacker",
        "street": "Balthasar-Neumann Str.",
        "houseNumber": "4b",
        "countryCode": "DE"
      }
    ]
  }
}

Example Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "companyAutocomplete",
  "params": {
    "companyName": "Endereco",
    "countryCode": "DE"
  }
}

---

Typical Integration Pattern

A typical address form uses the autocomplete services in sequence:

1. User types a postal code → call postCodeAutocomplete → user picks one → city is auto-filled.
2. User types a city name → call cityNameAutocomplete → user picks one → postal code syncs.
3. User types a street → call streetAutocomplete (with confirmed postCode + cityName) → user picks.
4. After all fields are filled → call addressCheck to validate and get the canonical form.

Alternatively, use addressAutocomplete with a single free-text input field for a Google Maps–style UX.