API-Integration leicht gemacht

Gast
Dienstleistungen
Abonnements
GET /v2/codes/search Plus

Suche nach Standortinformationen

Ermöglicht die Suche nach Standortinformationen basierend auf einem Suchbegriff. Diese Funktion ist nützlich für Anwendungen, die Standortdetails anhand eines Suchbegriffs abrufen möchten.

GET https://zip-api.eu/api/v2/codes/search?countryCode=...&query=...&search=...&match=...&fields=...&page[offset]=...&page[limit]=...
GET countryCode string - optional

Zweibuchstabiger Ländercode (Alpha-2-Code), definiert in ISO 3166-1.

GET query string - erforderlich

Der Suchbegriff oder die Zeichenkette, nach der gesucht werden soll.
Zum Beispiel ein vollständiger oder teilweiser Ortsname, eine (Teil-)Postleitzahl oder ein Bundesland. Die Eingabe muss mindestens 3 Zeichen lang sein.

GET search string - optional

Durch Kommas getrennte Liste von Feldnamen, in denen nach dem Suchbegriff gesucht werden soll.
Verfügbare Felder: postalCode, placeName, state;
Wird kein Wert angegeben, erfolgt die Suche standardmäßig in allen verfügbaren Feldern.

GET match string - optional (Standardwert: autocomplete)

Gibt das Suchverhalten für die Übereinstimmung mit dem Begriff in den Feldern an.
Verfügbare Typen:

  • all: Entspricht einem beliebigen Teil des Felds.
  • exact: Entspricht genau dem Feld.
  • autocomplete: Präfixbasierte Übereinstimmung für die Autovervollständigung.
  • leading: Entspricht dem Feldanfang.
  • trailing: Entspricht dem Feldende.
GET fields string - optional

Die Parameter durch Kommas getrennt, nach denen gefiltert werden soll.

GET page[offset] string - optional

Dieser Parameter bestimmt den Startpunkt und die Anzahl der Datensätze, die auf jeder Seite enthalten sein sollen. Verbessert die Suchgeschwindigkeit.

GET page[limit] string - optional

Dieser Parameter bestimmt den Startpunkt und die Anzahl der Datensätze, die auf jeder Seite enthalten sein sollen. Verbessert die Suchgeschwindigkeit.