{"id":16487962,"url":"https://github.com/acrogenesis/api-codigos-postales","last_synced_at":"2025-04-04T11:09:52.931Z","repository":{"id":27503583,"uuid":"30983992","full_name":"acrogenesis/API-Codigos-Postales","owner":"acrogenesis","description":"Un API publico, dado un código postal te regresa colonia, municipio y estado en formato JSON","archived":false,"fork":false,"pushed_at":"2025-03-12T15:48:50.000Z","size":4462,"stargazers_count":139,"open_issues_count":5,"forks_count":68,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-03-28T10:04:07.219Z","etag":null,"topics":["api","mexico","zip-codes"],"latest_commit_sha":null,"homepage":"https://rapidapi.com/acrogenesis-llc-api/api/mexico-zip-codes","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acrogenesis.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-02-18T20:03:55.000Z","updated_at":"2025-02-25T15:59:14.000Z","dependencies_parsed_at":"2025-01-09T19:40:54.703Z","dependency_job_id":"536e3136-1708-4bab-8ba9-1179fa0820e4","html_url":"https://github.com/acrogenesis/API-Codigos-Postales","commit_stats":{"total_commits":67,"total_committers":6,"mean_commits":"11.166666666666666","dds":"0.10447761194029848","last_synced_commit":"77fed721233d982bdd1fc1bd70d93fa54c776489"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrogenesis%2FAPI-Codigos-Postales","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrogenesis%2FAPI-Codigos-Postales/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrogenesis%2FAPI-Codigos-Postales/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrogenesis%2FAPI-Codigos-Postales/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acrogenesis","download_url":"https://codeload.github.com/acrogenesis/API-Codigos-Postales/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247166157,"owners_count":20894652,"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":["api","mexico","zip-codes"],"created_at":"2024-10-11T13:36:23.105Z","updated_at":"2025-04-04T11:09:52.909Z","avatar_url":"https://github.com/acrogenesis.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API para los códigos postales de México\n[![Code Climate](https://codeclimate.com/github/Munett/API-Codigos-Postales/badges/gpa.svg)](https://codeclimate.com/github/Munett/API-Codigos-Postales)\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/acrogenesis/API-Codigos-Postales)\n\nDado un código postal, regresa un arreglo con las colonia, municipio y estado perteneciente al código postal.\nAdemás se pueden realizar búsquedas de códigos postales usando los números iniciales.\n\n## Sube la app a heroku\n1) Da click en el botón `Deploy to Heroku` y sigue los pasos.\n2) Al terminar corre `heroku run rake sepomex:update`.\n3) Agrega el task de `rake sepomex:update` en el addon de Heroku\nScheduler para que se corra cada día.\n\n## Suscripción y documentación de la API\n\n[https://rapidapi.com/acrogenesis-llc-api/api/mexico-zip-codes](https://rapidapi.com/acrogenesis-llc-api/api/mexico-zip-codes)\n\n\n**Consultar la información de un código postal**\n\n```text\nhttps://mexico-zip-codes.p.rapidapi.com/codigo_postal/66436\n```\n\n**Respuesta del servidor**\n```json\n{\n  \"codigo_postal\": \"66436\",\n  \"municipio\": \"San Nicolás de los Garza\",\n  \"estado\": \"Nuevo León\",\n  \"colonias\": [\n    \"Praderas de Santo Domingo\",\n    \"Las Nuevas Puente\"\n  ]\n}\n```\n\n---\n\n**Buscar códigos postales**\n\n```text\nhttps://mexico-zip-codes.p.rapidapi.com/buscar\n```\n\n_parámetros necesarios_\n```text\n  codigo_postal=# codigo a buscar, parcial o total\n```\n\n_parámetros opcionales_\n```text\n  limit=# número máximo de resultados a devolver\n```\n\n_Ejemplo de búsqueda para códigos que inicien con **66**, con **664** y con **6641**_\n```json\nhttps://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=66\nhttps://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=664\nhttps://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=6641\n```\n\n_Ejemplo de búsqueda limitada a 3 resultados_\n```json\nhttps://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=66\u0026limit=3\n```\n\n** Para el código postal 6641 el servidor regresa **\n```json\n{\n  \"codigos_postales\": [\n    \"66410\",\n    \"66412\",\n    \"66413\",\n    \"66414\",\n    \"66415\",\n    \"66417\",\n    \"66418\"\n  ]\n}\n```\n\n---\n\n**Buscar códigos postales por ubicación**\n\n```text\nhttps://mexico-zip-codes.p.rapidapi.com/v2/buscar_por_ubicacion\n```\n\n_parámetros necesarios_\n```text\n  estado=# nombre del estado\n  municipio=# nombre del municipio\n```\n\n_parámetros opcionales_\n```text\n  colonia=# nombre de la colonia (opcional)\n  limit=# número máximo de resultados a devolver\n```\n\n_Ejemplo de búsqueda para códigos postales en Nuevo León, San Nicolás de los Garza_\n```text\nhttps://mexico-zip-codes.p.rapidapi.com/v2/buscar_por_ubicacion?estado=Nuevo%20León\u0026municipio=San%20Nicolás%20de%20los%20Garza\n```\n\n_Ejemplo de búsqueda para códigos postales en Nuevo León, San Nicolás de los Garza, colonia Praderas de Santo Domingo_\n```text\nhttps://mexico-zip-codes.p.rapidapi.com/v2/buscar_por_ubicacion?estado=Nuevo%20León\u0026municipio=San%20Nicolás%20de%20los%20Garza\u0026colonia=Praderas%20de%20Santo%20Domingo\n```\n\n_Ejemplo de búsqueda limitada a 5 resultados_\n```text\nhttps://mexico-zip-codes.p.rapidapi.com/v2/buscar_por_ubicacion?estado=Nuevo%20León\u0026municipio=San%20Nicolás%20de%20los%20Garza\u0026limit=5\n```\n\n**Respuesta del servidor**\n```json\n{\n  \"codigos_postales\": [\n    \"66436\"\n  ]\n}\n```\n\n___\n\n### Rake task\nEjecuta el rake task `rake sepomex:update` para descargar todos los códigos postales de México y actualizar tu base de datos.\n\n### Colabora\nErrores y pull requests son bienvenidos en Github: https://github.com/Munett/API-Codigos-Postales.\nPara bajar en tu BD todos los códigos postales corre el rake script `rake sepomex:update`.\n\nLos datos se obtuvieron de http://www.correosdemexico.gob.mx/lservicios/servicios/CodigoPostal_Exportar.aspx\n\n### Los datos se actualizan cada domingo.\n\n### Licencia\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facrogenesis%2Fapi-codigos-postales","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facrogenesis%2Fapi-codigos-postales","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facrogenesis%2Fapi-codigos-postales/lists"}