Skip to main content

Copomex

copomex-py-client

Cliente Python para la API de Copomex — consulta de códigos postales, colonias, municipios, estados, localidades, vialidades y geocoding de México.

  • Python 3.10+
  • Sin dependencias externas más allá de requests
  • Cubre los 24 endpoints disponibles

Instalación

pip install copomex-py-client

Inicio rápido

from copomex import Copomex

client = Copomex("TU_TOKEN")

info = client.info_cp("06600")
print(info)

Puedes usar token=pruebas para hacer pruebas sin costo ni registro. Los datos devueltos son aleatorios pero la estructura es real.


Manejo de errores

from copomex import Copomex, CopomexAPIError, CopomexHTTPError

client = Copomex("TU_TOKEN")

try:
    result = client.info_cp("99999")
except CopomexAPIError as e:
    print(f"Error de API [{e.code}]: {e.message}")
except CopomexHTTPError as e:
    print(f"Error HTTP: {e.status_code}")
Excepción Cuándo se lanza
CopomexAPIError La API devuelve error: true. Tiene .code y .message.
CopomexHTTPError Respuesta HTTP no exitosa (4xx, 5xx). Tiene .status_code.
CopomexError Clase base de las dos anteriores.

Referencia de métodos

Constructor

Copomex(token: str, timeout: int = 10)
Parámetro Descripción
token Tu token de acceso. Usa "pruebas" para desarrollo.
timeout Timeout de la petición HTTP en segundos (default: 10).

Códigos postales

info_cp(cp, *, simplified=False)

Información completa de un código postal.

Sin simplified, devuelve una lista (un elemento por colonia del CP). Con simplified=True, devuelve un dict con datos agregados.

colonias = client.info_cp("06600")       # list[dict]
info     = client.info_cp("06600", simplified=True)  # dict

search_cp(texto, *, limit=None)

Búsqueda por coincidencia parcial de código postal.

client.search_cp("066")
client.search_cp("066", limit=10)

get_colonia_por_cp(cp)

Colonias asociadas a un código postal.

client.get_colonia_por_cp("06600")

get_cp_por_estado(estado)

Todos los códigos postales de un estado.

client.get_cp_por_estado("Jalisco")

get_cp_por_municipio(municipio)

Códigos postales de un municipio.

client.get_cp_por_municipio("Guadalajara")

search_cp_advanced(estado, *, limit=None, municipio=None, colonia=None)

Búsqueda avanzada de CPs con filtros opcionales (coincidencia parcial).

client.search_cp_advanced("Jalisco", municipio="Guadalajara", limit=20)
client.search_cp_advanced("CDMX", colonia="Condesa")

get_cp_advanced(estado, *, limit=None, municipio=None, colonia=None)

Búsqueda exacta de CPs con filtros (coincidencias exactas, no parciales).

client.get_cp_advanced("Jalisco", municipio="Guadalajara")

Estados

get_estados()

Lista de todos los estados de México.

client.get_estados()

get_estado_clave()

Estados con su clave oficial INEGI.

client.get_estado_clave()

Municipios

get_municipio_por_estado(estado)

Municipios de un estado.

client.get_municipio_por_estado("Jalisco")

get_municipio_clave_por_estado(estado)

Municipios con clave INEGI, filtrados por nombre de estado.

client.get_municipio_clave_por_estado("Jalisco")

get_municipio_clave_por_clave_estado(clave)

Municipios con clave INEGI, filtrados por clave de estado.

client.get_municipio_clave_por_clave_estado("14")

Colonias

get_colonia_por_municipio(municipio)

Colonias de un municipio.

client.get_colonia_por_municipio("Guadalajara")

get_colonia_por_estado_municipio(estado, municipio)

Colonias con CP filtradas por estado y municipio.

client.get_colonia_por_estado_municipio("Jalisco", "Guadalajara")

Ciudades

get_cities_by_state_code(clave_estado)

Ciudades de un estado por su clave INEGI.

client.get_cities_by_state_code("14")

Localidades

get_localidad_por_estado_municipio(estado, municipio)

Catálogo de localidades filtrado por nombre de estado y municipio.

client.get_localidad_por_estado_municipio("Jalisco", "Guadalajara")

get_localidad_por_clave_estado_municipio(clave_estado, clave_municipio)

Localidades filtradas por claves INEGI de estado y municipio.

client.get_localidad_por_clave_estado_municipio("14", "039")

info_localidad(clave_estado, clave_municipio, clave_localidad)

Información detallada de una localidad (incluye coordenadas y altitud).

client.info_localidad("14", "039", "0001")

Vialidades

get_vialidad(clave_estado, clave_municipio, busqueda, limit, *, clave_localidad=None)

Búsqueda en el catálogo de más de 3 millones de calles y vialidades.

client.get_vialidad("14", "039", "juarez", 10)
client.get_vialidad("14", "039", "reforma", 5, clave_localidad="0001")

get_tipo_vialidad()

Catálogo de los 22 tipos de vialidad (calle, avenida, boulevard, etc.).

client.get_tipo_vialidad()

Geocoding

Estos métodos consumen 2 créditos por consulta.

info_cp_geocoding(cp, *, type=None, calle=None, numero=None)

Convierte un código postal (con calle y número opcionales) a coordenadas lat/lng.

client.info_cp_geocoding("06600")
client.info_cp_geocoding("06600", calle="Insurgentes", numero="123")

info_cp_geocoding_reverse(lat, lng)

Convierte coordenadas lat/lng a dirección postal completa.

client.info_cp_geocoding_reverse(19.4326, -99.1332)

Cuenta

consultas_disponibles()

Saldo de créditos disponibles del token.

client.consultas_disponibles()

ultima_actualizacion_db()

Fecha y hora de la última actualización de la base de datos.

client.ultima_actualizacion_db()

Créditos

Consulta Créditos
Todos los endpoints excepto geocoding 1
info_cp_geocoding 2
info_cp_geocoding_reverse 2

Licencia

Multiservicios Web - Copomex

Release files for copomex-py-client 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for copomex-py-client 0.1.0
File Size Uploaded
copomex_py_client-0.1.0.tar.gz 7.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for copomex-py-client 0.1.0
File Interpreter ABI Platform
copomex_py_client-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 13.2 kB

Release files / copomex_py_client-0.1.0.tar.gz

Download URL copomex_py_client-0.1.0.tar.gz
Size 7.4 kB
Tags Source
SHA-256 checksum
How to use checksums
6ea5fc92b2ed9001b93ff62ef1f6845ca5f267a32d72c0271b26dc14b414fc15
BLAKE2b-256 checksum
How to use checksums
be2ed6687d4312336e539f412dd115a6aabbcfe8b7ff5ac3eb4e30d1edd9b353
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / copomex_py_client-0.1.0-py3-none-any.whl

Download URL copomex_py_client-0.1.0-py3-none-any.whl
Size 5.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9c5887515fea883a9cb721fa322fe31050cf0ae9c00408035dee07a2c21d67b8
BLAKE2b-256 checksum
How to use checksums
659149f1c111905efc8a8343d1e1109a116e47d5f13f8bc346ff0078ef7eb58b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page