Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acrogenesis/api-codigos-postales
Un API publico, dado un código postal te regresa colonia, municipio y estado en formato JSON
https://github.com/acrogenesis/api-codigos-postales
api mexico zip-codes
Last synced: 6 days ago
JSON representation
Un API publico, dado un código postal te regresa colonia, municipio y estado en formato JSON
- Host: GitHub
- URL: https://github.com/acrogenesis/api-codigos-postales
- Owner: acrogenesis
- License: mit
- Created: 2015-02-18T20:03:55.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-03-22T16:36:03.000Z (10 months ago)
- Last Synced: 2025-01-02T18:12:09.027Z (13 days ago)
- Topics: api, mexico, zip-codes
- Language: Ruby
- Homepage: https://rapidapi.com/acrogenesis-llc-api/api/mexico-zip-codes
- Size: 4.23 MB
- Stars: 139
- Watchers: 16
- Forks: 69
- Open Issues: 6
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# API para los códigos postales de México
[](https://codeclimate.com/github/Munett/API-Codigos-Postales)
[](https://heroku.com/deploy?template=https://github.com/acrogenesis/API-Codigos-Postales)
Dado un código postal, regresa un arreglo con las colonia, municipio y estado perteneciente al código postal.
Además se pueden realizar búsquedas de códigos postales usando los números iniciales.
## Sube la app a heroku
1) Da click en el botón `Deploy to Heroku` y sigue los pasos.
2) Al terminar corre `heroku run rake sepomex:update`.
3) Agrega el task de `rake sepomex:update` en el addon de Heroku
Scheduler para que se corra cada día.
## Suscripción y documentación de la API
[https://rapidapi.com/acrogenesis-llc-api/api/mexico-zip-codes](https://rapidapi.com/acrogenesis-llc-api/api/mexico-zip-codes)
**Consultar la información de un código postal**
```text
https://mexico-zip-codes.p.rapidapi.com/codigo_postal/66436
```
**Respuesta del servidor**
```json
{
"codigo_postal": "66436",
"municipio": "San Nicolás de los Garza",
"estado": "Nuevo León",
"colonias": [
"Praderas de Santo Domingo",
"Las Nuevas Puente"
]
}
```
---
**Buscar códigos postales**
```text
https://mexico-zip-codes.p.rapidapi.com/buscar
```
_parámetros necesarios_
```text
codigo_postal=# codigo a buscar, parcial o total
```
_Ejemplo de búsqueda para códigos que inicien con **66**, con **664** y con **6641**_
```json
https://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=66
https://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=664
https://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=6641
```
** Para el código postal 6641 el servidor regresa **
```json
{
"codigos_postales": [
"66410",
"66412",
"66413",
"66414",
"66415",
"66417",
"66418"
]
}
```
___
### Rake task
Ejecuta el rake task `rake sepomex:update` para descargar todos los códigos postales de México y actualizar tu base de datos.
### Colabora
Errores y pull requests son bienvenidos en Github: https://github.com/Munett/API-Codigos-Postales.
Para bajar en tu BD todos los códigos postales corre el rake script `rake sepomex:update`.
Los datos se obtuvieron de http://www.correosdemexico.gob.mx/lservicios/servicios/CodigoPostal_Exportar.aspx
### TODO
- [ ] Pruebas automatizadas minitest
### Los datos se actualizan cada domingo.
### Licencia
MIT License