📘

El endpoint disponible lo encuentras en el apartado Locations de nuestra Referencia API.

Consultar la lista de ubicaciones

Si vas a utilizar la API de EasyBroker para crear tu propio sitio web, lo más probable es que quieras tener una copia de las ubicaciones con la misma estructura que tenemos en EasyBroker.

En este caso puedes usar /locations para obtener la información.

Si no utilizas ningún criterio para tu búsqueda, la API te mostrará el país de tu cuenta y la lista de sus estados o provincias.

Por ejemplo, en el caso de México como criterio de búsqueda verías un resultado similar al siguiente que contiene todos los estados de la República Mexicana:

{
  "name": "México",
  "full_name": "México",
  "type": "Country",
  "localities": [
    {
      "name": "Aguascalientes",
      "full_name": "Aguascalientes",
      "type": "State"
    },
    {
      "name": "Baja California",
      "full_name": "Baja California",
      "type": "State"
    },
    {
      "name": "Baja California Sur",
      "full_name": "Baja California Sur",
      "type": "State"
    }
    ...
  ]
}

Si deseas conocer las ciudades de una provincia o los barrios o colonias de una ciudad sólo tienes que buscar utilizando el texto del campo full_name, que se crea usando el nombre de la ubicación y de sus ubicaciones padres por ejemplo Colonia, Ciudad, Estado.

Así, si buscamos el estado de Aguascalientes, tendremos un resultado parecido a este:

{
  "name": "Aguascalientes",
  "full_name": "Aguascalientes",
  "type": "State",
  "localities": [
    {
      "name": "Pabellón de Arteaga",
      "full_name": "Pabellón de Arteaga, Aguascalientes",
      "type": "City"
    },
    {
      "name": "Calvillo",
      "full_name": "Calvillo, Aguascalientes",
      "type": "City"
    },
    {
      "name": "Asientos",
      "full_name": "Asientos, Aguascalientes",
      "type": "City"
    }
    ...
  ]
}

Y si buscamos la ciudad de Pabellón de Arteaga, del estado Aguascalientes, podremos ver sus colonias:

{
  "name": "Pabellón de Arteaga",
  "full_name": "Pabellón de Arteaga, Aguascalientes",
  "type": "City",
  "localities": [
    {
      "name": "5 de Mayo",
      "full_name": "5 de Mayo, Pabellón de Arteaga, Aguascalientes",
      "type": "Neighborhood"
    },
    {
      "name": "Barrio Industrial",
      "full_name": "Barrio Industrial, Pabellón de Arteaga, Aguascalientes",
      "type": "Neighborhood"
    },
    {
      "name": "Campestre San Carlos",
      "full_name": "Campestre San Carlos, Pabellón de Arteaga, Aguascalientes",
      "type": "Neighborhood"
    }
    ...
  ]
}

Puedes probar este endpoint en nuestra referencia dando clic aquí.

📘

La búsqueda de ubicaciones también te puede servir si deseas hacer una importación de propiedades en EasyBroker ya que te aseguras de que los nombres de tus ubicaciones corresponderán a los que tenemos nosotros.