{"id":16401705,"url":"https://github.com/alejandrorm-dev/api-codigos-postales-mx","last_synced_at":"2026-02-02T20:04:26.142Z","repository":{"id":42278078,"uuid":"256795338","full_name":"AlejandroRM-DEV/API-Codigos-Postales-MX","owner":"AlejandroRM-DEV","description":"API de códigos postales de México","archived":false,"fork":false,"pushed_at":"2022-12-12T12:57:56.000Z","size":350,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-03T04:29:33.767Z","etag":null,"topics":["codigo-postal","mexico","zipcode"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlejandroRM-DEV.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-18T16:03:54.000Z","updated_at":"2020-04-19T22:53:47.000Z","dependencies_parsed_at":"2023-01-27T19:46:19.223Z","dependency_job_id":null,"html_url":"https://github.com/AlejandroRM-DEV/API-Codigos-Postales-MX","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AlejandroRM-DEV/API-Codigos-Postales-MX","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlejandroRM-DEV%2FAPI-Codigos-Postales-MX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlejandroRM-DEV%2FAPI-Codigos-Postales-MX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlejandroRM-DEV%2FAPI-Codigos-Postales-MX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlejandroRM-DEV%2FAPI-Codigos-Postales-MX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlejandroRM-DEV","download_url":"https://codeload.github.com/AlejandroRM-DEV/API-Codigos-Postales-MX/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlejandroRM-DEV%2FAPI-Codigos-Postales-MX/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263604025,"owners_count":23487224,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["codigo-postal","mexico","zipcode"],"created_at":"2024-10-11T05:43:56.840Z","updated_at":"2026-02-02T20:04:26.095Z","avatar_url":"https://github.com/AlejandroRM-DEV.png","language":"JavaScript","readme":"# API de códigos postales de México\n[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)\n[![GitHub issues](https://img.shields.io/github/issues/AlejandroRM-DEV/API-Codigos-Postales-MX)](https://github.com/AlejandroRM-DEV/API-Codigos-Postales-MX/issues)\n\n## Pruebas\nSe 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.\n- Ciudad de México\n- México\n- Nuevo León\n```text\nhttps://codigos-postales-mx.herokuapp.com/api/codigos-postales?filtros[campos]=estado\n```\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n\n## Rutas\n```text\n/api/codigos-postales\n```\n```text\n/api/codigos-postales/:cp\n```\n```text\n/api/codigos-postales/estados/:estado\n```\n```text\n/api/codigos-postales/:estado/municipios/:municipio\n```\n```text\n/api/codigos-postales/:estado/municipios/:municipio/ciudades/:ciudad\n```\n- `:cp` número de código postal (5 dígitos)\n- `:estado` nombre del estado\n- `:municipio` nombre del municipio\n- `:ciudad` nombre de la ciudad\n\n### Filtros\nPermite seleccionar solo algunos campos, al estar presente se aplicará también un GROUP BY de los campos.\n```text\n?filtros[campos]=nombre\u0026filtros[campos]=nombre\n```\n\n### Ejemplos\nSi quisieras obtener todos los datos dependiendo del estado, municipio y ciudad.\n```text\n/api/codigos-postales/estados/Baja%20California%20Sur/municipios/Comondu/ciudades/Ciudad%20Constitucion\n```\n```json\n[\n    {\n        \"codigo_postal\": \"23600\",\n        \"estado\": \"Baja California Sur\",\n        \"municipio\": \"Comondú\",\n        \"ciudad\": \"Ciudad Constitución\",\n        \"asentamiento\": \"Zona Centro\",\n        \"tipo_asentamiento\": \"Colonia\"\n    },\n]\n```\nSi quisieras obtener la lista de estados del país\n```text\n/api/codigos-postales?filtros[campos]=estado\n```\n```json\n[\n    {\n        \"estado\": \"Aguascalientes\"\n    },\n    {\n        \"estado\": \"Baja California\"\n    },\n]\n```\nSi quisieras obtener la lista de municipios de un estado\n```text\n/api/codigos-postales/estados/Aguascalientes?filtros[campos]=estado\u0026filtros[campos]=municipio\n```\n```json\n[\n    {\n        \"estado\": \"Aguascalientes\",\n        \"municipio\": \"Aguascalientes\"\n    },\n    {\n        \"estado\": \"Aguascalientes\",\n        \"municipio\": \"Asientos\"\n    },\n]\n```\n\n## Base de datos\n```sql\ncreate table codigos_postales\n(\n    id                int auto_increment\n        primary key,\n    codigo_postal     varchar(5)  not null,\n    estado            varchar(35) not null,\n    municipio         varchar(50) not null,\n    ciudad            varchar(50) not null,\n    asentamiento      varchar(80) not null,\n    tipo_asentamiento varchar(25) not null\n);\n\ncreate index codigos_codigo_index\n    on codigos_postales (codigo_postal);\n```\n\n## Planeación\n- Validaciones y codigos de error.\n\n## Contribuciones\nSon bienvenidas todas las ideas y mejoras que puedas aportar.\n\n## Licencia\nGNU General Public License v3.0\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falejandrorm-dev%2Fapi-codigos-postales-mx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falejandrorm-dev%2Fapi-codigos-postales-mx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falejandrorm-dev%2Fapi-codigos-postales-mx/lists"}