API integration made easy

Guest
Services
Subscriptions
GET /v2/codes/search Plus

Search Location Information

Allows you to search for location information based on a search term. This feature is useful for applications that want to retrieve location details based on a search term.

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

Two-letter country code (Alpha-2 code) defined in ISO 3166-1.

GET query string - required

The search term or character string to be searched for.
For example, a full or partial city name, a (partial) postal code, or a state.
The entry must be at least 3 characters long.

GET search string - optional

Comma-separated list of field names to search for the search term.
Available fields: postalCode, placeName, state;
If no value is specified, the search will default to all available fields.

GET match string - optional (Default value: autocomplete)

Specifies the search behavior for matching the term in the fields.
Available types:

  • all: Matches any part of the field.
  • exact: Matches the field exactly.
  • autocomplete: Prefix-based matching for autocomplete.
  • leading: Matches the beginning of the field.
  • trailing: Matches the end of the field.
GET fields string - optional

The parameters to filter for, separated by commas.

GET page[offset] string - optional

This parameter determines the starting point and number of records to be included on each page. Improves search speed.

GET page[limit] string - optional

This parameter determines the starting point and number of records to be included on each page. Improves search speed.