Services
Subscriptions
GET
/v2/codes/search
Premium
Professional
Enterprise
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?query=...&search=...&match=...&fields=...&page[offset]=...&page[limit]=...
GET
query
string
- required
The search term or string to be used for searching.
GET
search
string
- optional
The parameters to search for, separated by commas.
Available parameters: postalCode, placeName, state;
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.