Skip to navigation
API ReferenceCoverage

Get City Information by City Name

View as Markdown
Retrieve city information including province, postal code, and other details by city name.

Query parameters

citystringRequired
The city name to search for

Response

City information retrieved successfully.
citystring
The name of the city
provincestring
The province abbreviation
provinceCompletestring
The complete province name
zipcodestring
The postal code
phonePrefixstring
The telephone prefix for the city
regionstring
The region name
egonCodestring
The EGON code identifier
idCitystring
The unique city identifier

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error