Location lookup

GET

/location/v1/locations

Resolves a complete location from a country, state, city and postal code, returning the four
normalised entities in a single response. Use it to validate an address without walking the
hierarchy level by level; it answers 404 when the combination does not exist.

Autorizaciones

OAuth2

OAuth2 security scheme

clientCredentials Flow

URL del token"/idp/oauth2/token"

Ámbitos:

• "api"Access to the API

Parámetros

Query Parameters

country*

ISO 3166 alpha-2 country code.

Tipo

string

Requerido

Ejemplo"ES"

postal_code*

Postal code of the city.

Tipo

string

Requerido

Ejemplo"33010"

state_code*

State code, as returned by the state list endpoint.

Tipo

string

Requerido

Ejemplo"ES-AS"

city_code*

City code, as returned by the city list endpoint.

Tipo

string

Requerido

Ejemplo"ES-AS-OV"

Respuestas

Location information

Content-Type

application/json

{

  

"country": {

  

  

"code": "ES",

  

  

"name": "Spain"

  

},

  

"state": {

  

  

"code": "ES-AS",

  

  

"name": "Asturias"

  

},

  

"city": {

  

  

"code": "ES-AS-OV",

  

  

"name": "Oviedo"

  

},

  

"postalCode": {

  

  

"code": "33010"

  

}

}

GET

/location/v1/locations

Playground

Servidor

Autorización

OAuth2

Variables

Key

Value

country*

postal_code*

state_code*

city_code*

Ejemplos