Estadísticas por polígono

curl -X POST "https://client.tukanmx.com/tukan-atlas/polygon-context/" \
  -H "Authorization: Token $API_TUKAN" \
  -H "Content-Type: application/json" \
  -d '{
    "polygon": {
      "type": "Polygon",
      "coordinates": [[
        [-101.21, 19.69], [-101.18, 19.69],
        [-101.18, 19.715], [-101.21, 19.715],
        [-101.21, 19.69]
      ]]
    },
    "indicators": [1528, 3701, 3201]
  }'

import os
import requests

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

# Población, % NSE alto y precio de renta en el centro de Morelia
resp = requests.post(
    "https://client.tukanmx.com/tukan-atlas/polygon-context/",
    headers=headers,
    json={
        "polygon": {
            "type": "Polygon",
            "coordinates": [[
                [-101.21, 19.69], [-101.18, 19.69],
                [-101.18, 19.715], [-101.21, 19.715],
                [-101.21, 19.69],
            ]],
        },
        "indicators": [1528, 3701, 3201],
    },
)
resp.raise_for_status()
for ind_id, r in resp.json()["data"].items():
    print(r["mnemonic"], r["estimate"])

{
  "data": {
    "1528": {
      "mnemonic": "census_population",
      "unit": "PEOPLE",
      "estimate": 83448.5209,
      "zipcode": 133966.622,
      "municipality": 849053.0,
      "state": 4748846.0,
      "national": 126014024.0,
      "vs_context": {
        "method": "share",
        "zipcode": 0.6229,
        "municipality": 0.0983,
        "state": 0.0176,
        "national": 0.0007
      }
    },
    "3701": {
      "mnemonic": "pct_households_nse_high",
      "unit": "PERCENT",
      "estimate": 0.3095,
      "zipcode": 0.3254,
      "municipality": 0.3078,
      "state": 0.1483,
      "national": 0.1875,
      "vs_context": {
        "method": "difference",
        "zipcode": -0.0159,
        "municipality": 0.0017,
        "state": 0.1612,
        "national": 0.122
      }
    }
  },
  "context": {
    "zipcode": [
      {"entity_code": "58030", "f_wp": 0.7202},
      {"entity_code": "58168", "f_wp": 1.0},
      {"entity_code": "58000", "f_wp": 0.9463}
    ],
    "municipality": ["16053"],
    "state": ["16"]
  }
}

POST

polygon-context

curl -X POST "https://client.tukanmx.com/tukan-atlas/polygon-context/" \
  -H "Authorization: Token $API_TUKAN" \
  -H "Content-Type: application/json" \
  -d '{
    "polygon": {
      "type": "Polygon",
      "coordinates": [[
        [-101.21, 19.69], [-101.18, 19.69],
        [-101.18, 19.715], [-101.21, 19.715],
        [-101.21, 19.69]
      ]]
    },
    "indicators": [1528, 3701, 3201]
  }'

import os
import requests

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

# Población, % NSE alto y precio de renta en el centro de Morelia
resp = requests.post(
    "https://client.tukanmx.com/tukan-atlas/polygon-context/",
    headers=headers,
    json={
        "polygon": {
            "type": "Polygon",
            "coordinates": [[
                [-101.21, 19.69], [-101.18, 19.69],
                [-101.18, 19.715], [-101.21, 19.715],
                [-101.21, 19.69],
            ]],
        },
        "indicators": [1528, 3701, 3201],
    },
)
resp.raise_for_status()
for ind_id, r in resp.json()["data"].items():
    print(r["mnemonic"], r["estimate"])

{
  "data": {
    "1528": {
      "mnemonic": "census_population",
      "unit": "PEOPLE",
      "estimate": 83448.5209,
      "zipcode": 133966.622,
      "municipality": 849053.0,
      "state": 4748846.0,
      "national": 126014024.0,
      "vs_context": {
        "method": "share",
        "zipcode": 0.6229,
        "municipality": 0.0983,
        "state": 0.0176,
        "national": 0.0007
      }
    },
    "3701": {
      "mnemonic": "pct_households_nse_high",
      "unit": "PERCENT",
      "estimate": 0.3095,
      "zipcode": 0.3254,
      "municipality": 0.3078,
      "state": 0.1483,
      "national": 0.1875,
      "vs_context": {
        "method": "difference",
        "zipcode": -0.0159,
        "municipality": 0.0017,
        "state": 0.1612,
        "national": 0.122
      }
    }
  },
  "context": {
    "zipcode": [
      {"entity_code": "58030", "f_wp": 0.7202},
      {"entity_code": "58168", "f_wp": 1.0},
      {"entity_code": "58000", "f_wp": 0.9463}
    ],
    "municipality": ["16053"],
    "state": ["16"]
  }
}

Calcula el estimado para una lista de indicadores para un polígono arbitrario. Es la forma más completa de enriquecer la información alrededor de un punto. Para utilizarlo es necesario mandar cualquier polígono GeoJSON junto con una lista de indicadores. A cambio recibes lo siguiente.

Una estimación de cada indicador dentro del polígono. Únicamente disponible para indicadores con observaciones a nivel código postal.
El entorno completo el valor observado del indicador para los códigos postales, municipios, estado y país que el polígono toca, en unidades completas.
vs_context trae la comparación del estimado contra cada nivel, según la naturaleza del indicador.

`method`	Cuándo aplica	Cómo leerlo
`share`	Conteos (población, viviendas)	Qué proporción del total captura tu polígono
`difference`	Tasas y porcentajes	Puntos de diferencia contra el nivel
`ratio`	Promedios (precios)	Cuántas veces el valor del nivel

Un indicador solo aparece en la respuesta si tiene observaciones a nivel código postal. Los que no las tienen se omiten sin error. Si un indicador que pediste no viene en data, esa es la causa.

curl -X POST "https://client.tukanmx.com/tukan-atlas/polygon-context/" \
  -H "Authorization: Token $API_TUKAN" \
  -H "Content-Type: application/json" \
  -d '{
    "polygon": {
      "type": "Polygon",
      "coordinates": [[
        [-101.21, 19.69], [-101.18, 19.69],
        [-101.18, 19.715], [-101.21, 19.715],
        [-101.21, 19.69]
      ]]
    },
    "indicators": [1528, 3701, 3201]
  }'

import os
import requests

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

# Población, % NSE alto y precio de renta en el centro de Morelia
resp = requests.post(
    "https://client.tukanmx.com/tukan-atlas/polygon-context/",
    headers=headers,
    json={
        "polygon": {
            "type": "Polygon",
            "coordinates": [[
                [-101.21, 19.69], [-101.18, 19.69],
                [-101.18, 19.715], [-101.21, 19.715],
                [-101.21, 19.69],
            ]],
        },
        "indicators": [1528, 3701, 3201],
    },
)
resp.raise_for_status()
for ind_id, r in resp.json()["data"].items():
    print(r["mnemonic"], r["estimate"])

{
  "data": {
    "1528": {
      "mnemonic": "census_population",
      "unit": "PEOPLE",
      "estimate": 83448.5209,
      "zipcode": 133966.622,
      "municipality": 849053.0,
      "state": 4748846.0,
      "national": 126014024.0,
      "vs_context": {
        "method": "share",
        "zipcode": 0.6229,
        "municipality": 0.0983,
        "state": 0.0176,
        "national": 0.0007
      }
    },
    "3701": {
      "mnemonic": "pct_households_nse_high",
      "unit": "PERCENT",
      "estimate": 0.3095,
      "zipcode": 0.3254,
      "municipality": 0.3078,
      "state": 0.1483,
      "national": 0.1875,
      "vs_context": {
        "method": "difference",
        "zipcode": -0.0159,
        "municipality": 0.0017,
        "state": 0.1612,
        "national": 0.122
      }
    }
  },
  "context": {
    "zipcode": [
      {"entity_code": "58030", "f_wp": 0.7202},
      {"entity_code": "58168", "f_wp": 1.0},
      {"entity_code": "58000", "f_wp": 0.9463}
    ],
    "municipality": ["16053"],
    "state": ["16"]
  }
}

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.

Cuerpo

application/json

Polígono GeoJSON (Polygon o MultiPolygon) y lista de indicadores a estimar dentro de el.

polygon

object

requerido

Objeto GeoJSON. Acepta Polygon o MultiPolygon, con hoyos si aplica. Puede venir de una isócrona, un radio, un polígono dibujado a mano o la geometría de cualquier entidad de Atlas.

Show child attributes

indicators

integer[]

requerido

IDs de indicadores. Solo se incluyen en la respuesta los indicadores que tienen observaciones a nivel código postal.

Minimum array length: 1

Ejemplo:

[1528, 3701, 3201]

Respuesta

Contexto calculado exitosamente

data

object

Resultados por indicador, con el indicator_id como llave

Show child attributes

context

object

Entidades que el polígono toca en cada nivel

Show child attributes

Estadísticas

Lugares

Pinpoint

Catálogos

Ejemplos y guías

Autorizaciones

Cuerpo

Respuesta