Pinpoint masivo

curl -X POST "https://client.tukanmx.com/tukan-atlas/pinpoint/" \
  -H "Authorization: Token $API_TUKAN" \
  -H "Content-Type: application/json" \
  -d '{
    "coordinates": [
      [19.7060, -101.1950],
      [19.4326, -99.1332]
    ]
  }'

import os
import requests

headers = {"Authorization": f"Token {os.environ['API_TUKAN']}"}

resp = requests.post(
    "https://client.tukanmx.com/tukan-atlas/pinpoint/",
    headers=headers,
    json={"coordinates": [[19.7060, -101.1950], [19.4326, -99.1332]]},
)
resp.raise_for_status()
for punto in resp.json()["results"]:
    print(punto["municipality"], punto["zipcode"])

{
  "count": 2,
  "page": 1,
  "page_size": 100,
  "results": [
    {
      "latitude": 19.706,
      "longitude": -101.195,
      "country": "México",
      "country_code": "mex",
      "state": "Michoacán de Ocampo",
      "state_code": "16",
      "municipality": "Morelia",
      "municipality_code": "16053",
      "zipcode": "58000",
      "locality": "Morelia",
      "locality_code": "160530001",
      "ageb": "1605300010293",
      "urban_block": "1605300010293008",
      "neighborhood": "Centro Histórico",
      "neighborhood_code": "1605300010057"
    }
  ]
}

POST

pinpoint

curl -X POST "https://client.tukanmx.com/tukan-atlas/pinpoint/" \
  -H "Authorization: Token $API_TUKAN" \
  -H "Content-Type: application/json" \
  -d '{
    "coordinates": [
      [19.7060, -101.1950],
      [19.4326, -99.1332]
    ]
  }'

import os
import requests

headers = {"Authorization": f"Token {os.environ['API_TUKAN']}"}

resp = requests.post(
    "https://client.tukanmx.com/tukan-atlas/pinpoint/",
    headers=headers,
    json={"coordinates": [[19.7060, -101.1950], [19.4326, -99.1332]]},
)
resp.raise_for_status()
for punto in resp.json()["results"]:
    print(punto["municipality"], punto["zipcode"])

{
  "count": 2,
  "page": 1,
  "page_size": 100,
  "results": [
    {
      "latitude": 19.706,
      "longitude": -101.195,
      "country": "México",
      "country_code": "mex",
      "state": "Michoacán de Ocampo",
      "state_code": "16",
      "municipality": "Morelia",
      "municipality_code": "16053",
      "zipcode": "58000",
      "locality": "Morelia",
      "locality_code": "160530001",
      "ageb": "1605300010293",
      "urban_block": "1605300010293008",
      "neighborhood": "Centro Histórico",
      "neighborhood_code": "1605300010057"
    }
  ]
}

La versión por lotes de pinpoint individual, pensada para georreferenciar bases de datos completas en una sola llamada, como la cartera de sucursales o los domicilios de tus clientes.

coordinates acepta hasta 10,000 pares [latitud, longitud].
addresses acepta hasta 100 direcciones en texto libre, que se resuelven automáticamente a coordenadas.

Los dos campos son mutuamente excluyentes. Cada resultado trae la misma jerarquía completa que el pinpoint individual y en el mismo orden del lote. La respuesta se pagina con page y page_size como parámetros de query. En modo direcciones, las que no se pudieron resolver aparecen en geocode_errors sin abortar el resto. También acepta valid_to en el cuerpo para resolver contra cartografía histórica.

curl -X POST "https://client.tukanmx.com/tukan-atlas/pinpoint/" \
  -H "Authorization: Token $API_TUKAN" \
  -H "Content-Type: application/json" \
  -d '{
    "coordinates": [
      [19.7060, -101.1950],
      [19.4326, -99.1332]
    ]
  }'

import os
import requests

headers = {"Authorization": f"Token {os.environ['API_TUKAN']}"}

resp = requests.post(
    "https://client.tukanmx.com/tukan-atlas/pinpoint/",
    headers=headers,
    json={"coordinates": [[19.7060, -101.1950], [19.4326, -99.1332]]},
)
resp.raise_for_status()
for punto in resp.json()["results"]:
    print(punto["municipality"], punto["zipcode"])

{
  "count": 2,
  "page": 1,
  "page_size": 100,
  "results": [
    {
      "latitude": 19.706,
      "longitude": -101.195,
      "country": "México",
      "country_code": "mex",
      "state": "Michoacán de Ocampo",
      "state_code": "16",
      "municipality": "Morelia",
      "municipality_code": "16053",
      "zipcode": "58000",
      "locality": "Morelia",
      "locality_code": "160530001",
      "ageb": "1605300010293",
      "urban_block": "1605300010293008",
      "neighborhood": "Centro Histórico",
      "neighborhood_code": "1605300010057"
    }
  ]
}

Autorizaciones

Authorization

string

header

requerido

Token de autenticación. Formato requerido: Token tu-token (la palabra Token, un espacio y tu token). Solicita tu token escribiendo a contacto@tukanmx.com.

Parámetros de consulta

page

integer

predeterminado:1

Número de página

page_size

integer

predeterminado:100

Resultados por página

Cuerpo

application/json

coordinates

number[][]

requerido

Lista de pares [latitud, longitud]. Máximo 10,000.

Required array length: 1 - 10000 elements

Required array length: 2 elements

Ejemplo:

[[19.706, -101.195], [19.4326, -99.1332]]

valid_to

string<date>

Fecha para consultar versión histórica de polígonos (YYYY-MM-DD). Omitir para la versión actual.

Ejemplo:

"2022-06-01"

addresses

string[]

Hasta 100 direcciones en texto libre. Se resuelven automáticamente a coordenadas. Mutuamente excluyente con coordinates.

Maximum array length: 100

Ejemplo:

[
  "Av. Madero Poniente 100, Centro, Morelia, Michoacán"
]

Respuesta

Geocodificación masiva completada

count

integer

Ejemplo:

2

page

integer

Ejemplo:

1

page_size

integer

Ejemplo:

100

results

object[]

Show child attributes

geocode_errors

object[]

Direcciones que no se pudieron geocodificar (solo en modo addresses)

Show child attributes

Estadísticas

Lugares

Pinpoint

Catálogos

Ejemplos y guías

Autorizaciones

Parámetros de consulta

Cuerpo

Respuesta