colombia-cities
v1.0.0
Published
API y paquete npm para consultar departamentos, municipios, códigos DANE y provincias de Colombia. Úsalo como servicio web o como librería local en Node.js.
Maintainers
Readme
🇨🇴 Colombia Cities API & Data
API y paquete npm abiertos, profesionales y de uso continuo para toda la comunidad.
Accede a la base de datos oficial de departamentos, municipios, códigos DANE y provincias de Colombia. Ideal para integraciones en sistemas, aplicaciones, bots, análisis de datos y cualquier proyecto que requiera información geográfica confiable y actualizada.
✨ Características principales
- Acceso libre y sin registro
- Datos oficiales y actualizados
- 33 departamentos y 1,119 municipios
- Códigos DANE y provincias organizadas
- API REST robusta y documentada
- Listo para producción y uso masivo
- Colaborativo y open source
📦 Instalación y uso como paquete npm
Instala el paquete:
npm install colombia-citiesEjemplo de uso:
const { getDepartments, getCitiesByDepartment, findCityByCode, searchCities } = require('colombia-cities');
console.log(getDepartments());
console.log(getCitiesByDepartment('Antioquia'));
console.log(findCityByCode('05001'));
console.log(searchCities('medellin'));Esto permite consumir los datos sin depender de la API web, ideal para proyectos offline, scripts, bots o integración directa.
🚀 Instalación y uso local de la API
Clona el repositorio e instala dependencias:
git clone https://github.com/juanvidev1/colombianCities.git
cd colombianCities
npm installEjecuta el servidor:
npm start
# El servidor corre en puerto 5000 por defectoConfigura el puerto (opcional):
# Crea un archivo .env
PORT=3000🌐 API REST
Endpoint base
http://localhost:5000/api/v1/citiesBuscar por nombre de ciudad
GET /api/v1/cities?cityName=medellinBuscar por departamento
GET /api/v1/cities?department=antioquiaBuscar por provincia
GET /api/v1/cities?provincia=orienteEjemplo de respuesta
{
"data": [
{ "department": "Antioquia", "city": "Medellín", "code": "05001", "provincia": "Valle Del Aburra" }
]
}📁 Archivos de datos
colombia_completa.json⭐ (Recomendado): Datos completos con metadata, departamentos, municipios, códigos DANE y provincias.colombia_con_codigos.json: Versión simplificada optimizada para aplicaciones web y móviles.
Consulta la documentación completa en DOCUMENTACION_COMPLETA.md.
📂 Estructura del proyecto
colombianCities/
├── api-docs/ # Documentación de la API
├── routes/ # Rutas de la API REST
├── services/ # Lógica de negocio
├── colombia_completa.json # Datos completos con códigos
├── colombia_con_codigos.json # Versión simplificada
├── DOCUMENTACION_COMPLETA.md # Documentación detallada
├── index.js # Servidor principal
└── package.json # Dependencias🤝 Contribuciones
Este proyecto es open source y agradece cualquier contribución:
- Haz un fork del repositorio
- Crea una rama feature (
git checkout -b feature/nueva-funcionalidad) - Realiza tus cambios y haz commit (
git commit -am 'Agrega nueva funcionalidad') - Haz push a tu rama (
git push origin feature/nueva-funcionalidad) - Abre un Pull Request
📄 Licencia
MIT License - ver archivo LICENSE para más detalles.
API y datos oficiales de Colombia, listos para uso profesional y continuo. Actualizado Octubre 2025. 🇨🇴
Prueba este servicio web y solo envíame un correo a [email protected] si deseas colaborar para agregar más países y ciudades o si tienes algún consejo para mejorar este servicio.
Eso es todo por ahora.
¡Gracias!
