Unofficial Gaana API
A REST API wrapper for Gaana music streaming, built with Hono, Bun, and TypeScript. Provides access to songs, albums, playlists, artists, trending tracks, charts, and new releases metadata.
Educational & Research Purpose Only: This project is created solely for educational and research purposes. It is a learning project to understand API development, web scraping concepts, and TypeScript/Bun ecosystem. This is not an official Gaana API. Use responsibly and respect Gaana's terms of service. The authors are not responsible for any misuse of this project.
Features
- Unified Search - Search across all content types (songs, albums, playlists, artists)
- RESTful Endpoints - Clean, standard REST API design
- Detailed Info - Full metadata for songs, albums, playlists, and artists
- Stream URLs - Get decrypted HLS stream URLs for tracks
- URL Support - Accept both seokeys and full Gaana URLs for detail endpoints
- Trending & Charts - Get trending tracks and top charts
- New Releases - Browse new releases by language
- Type-Safe - Full TypeScript support
- Serverless Ready - Deploy directly to Vercel
Quick Start
Installation
git clone https://github.com/notdeltaxd/Gaana-API.git
cd Gaana-API
# Install dependencies
bun install
# or
npm install
Development
bun run dev
# API will be available at http://localhost:3000/api
Deployment to Vercel
One-click deployment: Click the button above to deploy instantly to Vercel.
Manual deployment:
npm i -g vercel
# Deploy
vercel deploy
Since Gaana is an Indian music streaming platform, it's recommended to host your project in the Mumbai region for better performance:
- Go to your Vercel project dashboard
- Navigate to Settings - Functions
- Under Function Region, select Asia Pacific (Mumbai) - ap-south-1
- Unselect the default region
- Click Save Changes
- Redeploy your project
This ensures faster API response times when accessing Gaana's servers.
API Documentation
Base URL
Development: http://localhost:3000/api
Production: https://your-domain.vercel.app/api
Search Endpoint
GET /api/search
Unified search across all content types (songs, albums, playlists, artists) in parallel.
Query Parameters:
q(required) - Search query stringlimit(optional) - Results per type (default: 10, max: 25)
Example:
Response:
"success": true,
"data": {
"songs": [...],
"albums": [...],
"playlists": [...],
"artists": [...]
},
"timestamp": "..."
}
Type-Specific Search
- GET
/api/search/songs?q=query&limit=10 - GET
/api/search/albums?q=query&limit=10 - GET
/api/search/playlists?q=query&limit=10 - GET
/api/search/artists?q=query&limit=10
Songs
GET /api/songs/:id or GET /api/songs?url=... or GET /api/songs?seokey=...
Get detailed information about a specific song.
Examples:
curl "http://localhost:3000/api/songs/manjha"
# Query parameter with URL
curl "http://localhost:3000/api/songs?url=https://gaana.com/song/manjha"
Response:
"seokey": "...",
"track_id": "...",
"title": "...",
"artists": "...",
"album": "...",
"duration": 0,
"language": "...",
"is_explicit": false,
"artworkUrl": "..."
}
Albums
GET /api/albums/:id or GET /api/albums?url=... or GET /api/albums?seokey=...
Get album information with all tracks.
Response:
"seokey": "...",
"title": "...",
"artists": "...",
"track_count": 0,
"release_date": "...",
"play_count": 0,
"tracks": [...]
}
Playlists
GET /api/playlists/:id or GET /api/playlists?url=... or GET /api/playlists?seokey=...
Get playlist information with all tracks.
Response:
"playlist": {
"title": "...",
"playlist_id": "...",
"track_count": 0,
"tracks": [...]
}
}
Artists
GET /api/artists/:id or GET /api/artists?url=... or GET /api/artists?seokey=...
Get artist information with top tracks.
Response:
"artist_id": "...",
"seokey": "...",
"name": "...",
"artwork": "...",
"artist_url": "...",
"top_tracks": [...]
}
Trending
GET /api/trending?language=hi&limit=20
Get currently trending tracks.
Response:
"success": true,
"data": [...],
"count": 0,
"timestamp": "..."
}
Charts
GET /api/charts?limit=20
Get top charts/playlists.
Response:
"success": true,
"data": [...],
"count": 0,
"timestamp": "..."
}
New Releases
GET /api/new-releases?language=hi
Get new releases (songs and albums).
Response:
"success": true,
"data": {
"tracks": [...],
"albums": [...]
},
"timestamp": "..."
}
Stream URL
GET /api/stream/:trackId or GET /api/stream?track_id=...
Get decrypted HLS stream URL for a track by its track ID.
Query Parameters:
track_id(required if not using path param) - Numeric track IDquality(optional) - Audio quality:low,medium,high(default:high)
Examples:
curl "http://localhost:3000/api/stream/29797868"
# Query parameter
curl "http://localhost:3000/api/stream?track_id=29797868"
# With quality
curl "http://localhost:3000/api/stream/29797868?quality=medium"
Response:
"quality": "high",
"bitRate": "128",
"hlsUrl": "https://vodhlsgaana-ebw.akamaized.net/hls/.../index.m3u8",
"url": "https://vodhlsgaana-ebw.akamaized.net/hls/.../segment-0.m4s",
"initUrl": "https://vodhlsgaana-ebw.akamaized.net/hls/.../init.mp4",
"segments": [
{
"url": "https://vodhlsgaana-ebw.akamaized.net/hls/.../segment-0.m4s",
"durationMs": 6000
},
...
],
"durationMs": 180000,
"format": "m4s"
}
Note: The
track_idcan be obtained from the song details endpoint (/api/songs/:seokey). Song details also include amedia_urlsarray with the decrypted stream URL.
Health
GET /api/health
Check API health status.
Response:
"status": "ok",
"uptime": 0,
"environment": "...",
"timestamp": "..."
}
License
This project is licensed under the MIT License - see the LICENSE file for details.
This project is for educational and research purposes only. It is not affiliated with, endorsed by, or connected to Gaana in any way. This is a learning project created to understand API development, TypeScript, and web technologies. Users are responsible for ensuring their use complies with applicable laws and Gaana's terms of service. The authors assume no liability for misuse of this project.