v1

latestOpenAPI 3.0.02026-07-26155147.1 KB
Locations

Retrieve a location

Retrieve a location name and the childs of a given location <neighborhood, city, state>. If no parameter provided, the states from the country registered in your account will be returned.

get/locations

Query parameters

querystring

Location to find

Response

Successful location list request

namestring
full_namestring
typestring

Example response

{
  "name": "Monterrey",
  "full_name": "Monterrey, Nuevo León",
  "type": "City",
  "localities": [
    {
      "name": "Alamos Corregidora",
      "full_name": "Alamos Corregidora, Monterrey, Nuevo León",
      "type": "Neighborhood"
    }
  ]
}