Skip to content

Search cities by name

GET
/reference-data/geo-ip/city/{searchTerm}
curl --request GET \
--url https://api.wink.travel/reference-data/geo-ip/city/Bangkok \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Return all cities whose name matches the given search term, as lightweight geo records with coordinates, geoname identifiers, and timezone information.

searchTerm
required
string
""

Partial city name (case-insensitive substring match)

Example
Bangkok
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Matching cities returned

Media type application/json
Array<object>

Uses MaxMind’s city lite db to persist GeoIpLightweight objects in our own db.

object
geoNameId
required

GeoNameLightweight identifiers taken from https://geonames.org.

string
"" >= 1 characters
localeCode
required

Locale code

string
"" >= 1 characters /^[a-z]{2}(-[A-Z]{2})?$/
continentCode
required

Continent code

string
"" >= 1 characters
continentName
required

Continent name

string
"" >= 1 characters
countryIsoCode
required

Country ISO code

string
"" >= 1 characters /^[A-Z]{2}$/
countryName
required

Country name

string
"" >= 1 characters
cityName
required

City name

string
"" >= 1 characters
timezone
required

Timezone

string
"" >= 1 characters
subDivision1Code

Sub-division 1 code

string
""
subDivision1Name

Sub-division 1 name

string
""
subDivision2Code

Sub-division 2 code

string
""
subDivision2Name

Sub-division 2 name

string
""
Example
[
{
"geoNameId": "1609350",
"localeCode": "en",
"continentCode": "AS",
"continentName": "Asia",
"countryIsoCode": "TH",
"countryName": "Thailand",
"cityName": "Bangkok",
"timezone": "Asia/Bangkok",
"subDivision1Code": "10",
"subDivision1Name": "Bangkok",
"subDivision2Code": "1001",
"subDivision2Name": "Phra Nakhon"
}
]

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example