Skip to content

Bharat API v1.0.0 - Initial Release

Latest

Choose a tag to compare

@paragrudani1 paragrudani1 released this 08 Jun 07:21

πŸŽ‰ Bharat API v1.0.0 - Initial Release

πŸš€ What's New

This is the initial stable release of Bharat API - a free and open-source Indian pincode and location API.

✨ Features

  • πŸ” Pincode Lookup API - Get location details for any Indian pincode
  • πŸ™οΈ City & State Search - Find all pincodes for cities and states
  • ⚑ High Performance - Built with Express.js and SQLite for fast responses
  • 🐳 Docker Ready - Complete containerization for easy deployment
  • πŸ“Š Comprehensive Data - 19,000+ locations across all Indian states
  • πŸ‘¨β€πŸ’» Developer Friendly - Clean REST API with JSON responses

πŸ› οΈ Tech Stack

  • Backend: Node.js + Express.js + TypeScript
  • Database: SQLite with Knex.js ORM
  • Development: Hot reload with Nodemon
  • Containerization: Docker & Docker Compose
  • Data: Complete Indian pincode dataset included

πŸ“‘ API Endpoints

  • GET /api/pincode/{pincode} - Lookup by pincode
  • GET /api/search?city={city} - Search by city
  • GET /api/search?state={state} - Search by state
  • GET /health - Health check

πŸš€ Quick Start

# Using Docker (Recommended)
git clone https://github.com/your-username/bharat-api.git
cd bharat-api
cp .env.example .env
docker-compose up -d

# Local Development
npm install
npm run setup
npm run dev

πŸ“¦ What's Included

  • Complete source code with TypeScript
  • Docker configuration for development and production
  • Database migrations and CSV import scripts
  • Comprehensive documentation
  • Indian pincode dataset (19,000+ entries)

🀝 Contributing

Contributions are welcome! Please read our contributing guidelines and feel free to submit pull requests.

πŸ“„ License

MIT License - free for commercial and personal use.


Made with ❀️ for the Indian developer community

For support, please open an issue on GitHub.