https://github.com/alejandrorm-dev/api-codigos-postales-mx
API de códigos postales de México
https://github.com/alejandrorm-dev/api-codigos-postales-mx
codigo-postal mexico zipcode
Last synced: 6 months ago
JSON representation
API de códigos postales de México
- Host: GitHub
- URL: https://github.com/alejandrorm-dev/api-codigos-postales-mx
- Owner: AlejandroRM-DEV
- License: gpl-3.0
- Created: 2020-04-18T16:03:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T12:57:56.000Z (about 3 years ago)
- Last Synced: 2025-04-03T04:29:33.767Z (10 months ago)
- Topics: codigo-postal, mexico, zipcode
- Language: JavaScript
- Size: 342 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API de códigos postales de México
[](https://opensource.org/licenses/)
[](https://github.com/AlejandroRM-DEV/API-Codigos-Postales-MX/issues)
## Pruebas
Se ha publicado un versión de pruebas en Heroku, sin embargo, debido a las limitaciones del servicio gratuito sólo se cuenta con los datos de algunos estados.
- Ciudad de México
- México
- Nuevo León
```text
https://codigos-postales-mx.herokuapp.com/api/codigos-postales?filtros[campos]=estado
```
[](https://heroku.com/deploy)
## Rutas
```text
/api/codigos-postales
```
```text
/api/codigos-postales/:cp
```
```text
/api/codigos-postales/estados/:estado
```
```text
/api/codigos-postales/:estado/municipios/:municipio
```
```text
/api/codigos-postales/:estado/municipios/:municipio/ciudades/:ciudad
```
- `:cp` número de código postal (5 dígitos)
- `:estado` nombre del estado
- `:municipio` nombre del municipio
- `:ciudad` nombre de la ciudad
### Filtros
Permite seleccionar solo algunos campos, al estar presente se aplicará también un GROUP BY de los campos.
```text
?filtros[campos]=nombre&filtros[campos]=nombre
```
### Ejemplos
Si quisieras obtener todos los datos dependiendo del estado, municipio y ciudad.
```text
/api/codigos-postales/estados/Baja%20California%20Sur/municipios/Comondu/ciudades/Ciudad%20Constitucion
```
```json
[
{
"codigo_postal": "23600",
"estado": "Baja California Sur",
"municipio": "Comondú",
"ciudad": "Ciudad Constitución",
"asentamiento": "Zona Centro",
"tipo_asentamiento": "Colonia"
},
]
```
Si quisieras obtener la lista de estados del país
```text
/api/codigos-postales?filtros[campos]=estado
```
```json
[
{
"estado": "Aguascalientes"
},
{
"estado": "Baja California"
},
]
```
Si quisieras obtener la lista de municipios de un estado
```text
/api/codigos-postales/estados/Aguascalientes?filtros[campos]=estado&filtros[campos]=municipio
```
```json
[
{
"estado": "Aguascalientes",
"municipio": "Aguascalientes"
},
{
"estado": "Aguascalientes",
"municipio": "Asientos"
},
]
```
## Base de datos
```sql
create table codigos_postales
(
id int auto_increment
primary key,
codigo_postal varchar(5) not null,
estado varchar(35) not null,
municipio varchar(50) not null,
ciudad varchar(50) not null,
asentamiento varchar(80) not null,
tipo_asentamiento varchar(25) not null
);
create index codigos_codigo_index
on codigos_postales (codigo_postal);
```
## Planeación
- Validaciones y codigos de error.
## Contribuciones
Son bienvenidas todas las ideas y mejoras que puedas aportar.
## Licencia
GNU General Public License v3.0