Base URL: http://localhost:3000/api
All endpoints return JSON with the structure:
{ success: boolean, data: T }
| Query Param | Type | Required | Description |
|---|---|---|---|
| ids | string | No* |
Comma-separated list of song IDs (e.g.
3IoDK8qI,4IoDK8qI)
|
| link | string (url) | No* |
Direct JioSaavn song link (e.g.
https://www.jiosaavn.com/song/houdini/OgwhbhtDRwM)
|
* Either ids or link must be provided.
Response:
{ success: boolean, data: Song[] }
| Path Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | ID of the song (e.g. 3IoDK8qI) |
Response:
{ success: boolean, data: Song[] }
| Query Param | Type | Required | Default | Description |
|---|---|---|---|---|
| limit | number | No | 10 |
Number of suggestions to retrieve |
Response:
{ success: boolean, data: Song[] }
| Query Param | Type | Required | Description |
|---|---|---|---|
| id | string | No* | Album ID (e.g. 23241654) |
| link | string (url) | No* |
Direct JioSaavn album link (e.g.
https://www.jiosaavn.com/album/future-nostalgia/ITIyo-GDr7A_)
|
* Either id or link must be provided.
Response:
{ success: boolean, data: Album }
| Query Param | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | No* | — | Artist ID (e.g. 1274170) |
| link | string (url) | No* | — | Direct JioSaavn artist link |
| page | number | No | 0 |
Page number |
| songCount | number | No | 10 |
Number of songs to fetch |
| albumCount | number | No | 10 |
Number of albums to fetch |
| sortBy | enum | No | popularity |
popularity, latest,
alphabetical
|
| sortOrder | enum | No | desc |
asc, desc |
* Either id or link must be provided.
Response:
{ success: boolean, data: Artist }
| Path/Query Param | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | Yes | — | Artist ID (e.g. 1274170) |
| page | number | No | 0 |
Page number |
| songCount | number | No | 10 |
Number of songs to retrieve |
| albumCount | number | No | 10 |
Number of albums to retrieve |
| sortBy | enum | No | popularity |
popularity, latest,
alphabetical
|
| sortOrder | enum | No | desc |
asc, desc |
Response:
{ success: boolean, data: Artist }
| Path/Query Param | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | Yes | — | Artist ID (e.g. 1274170) |
| page | number | No | 0 |
Page number |
| sortBy | enum | No | popularity |
popularity, latest,
alphabetical
|
| sortOrder | enum | No | desc |
asc, desc |
Response:
{ success: boolean, data: ArtistSong[] }
| Path/Query Param | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | Yes | — | Artist ID (e.g. 1274170) |
| page | number | No | 0 |
Page number |
| sortBy | enum | No | popularity |
popularity, latest,
alphabetical
|
| sortOrder | enum | No | desc |
asc, desc |
Response:
{ success: boolean, data: ArtistAlbum[] }
All search endpoints require a query parameter.
| Query Param | Type | Required | Description |
|---|---|---|---|
| query | string | Yes | Search query (e.g. Imagine Dragons) |
Response:
{ success: boolean, data: { songs, albums, artists, playlists }
}
| Query Param | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | Yes | — | Search query (e.g. Believer) |
| page | number | No | 0 |
Page number |
| limit | number | No | 10 |
Results per page |
Response:
{ success: boolean, data: SearchSong[] }
| Query Param | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | Yes | — | Search query (e.g. Evolve) |
| page | number | No | 0 |
Page number |
| limit | number | No | 10 |
Results per page |
Response:
{ success: boolean, data: SearchAlbum[] }
| Query Param | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | Yes | — | Search query (e.g. Adele) |
| page | number | No | 0 |
Page number |
| limit | number | No | 10 |
Results per page |
Response:
{ success: boolean, data: SearchArtist[] }
| Query Param | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | Yes | — | Search query (e.g. Indie) |
| page | number | No | 0 |
Page number |
| limit | number | No | 10 |
Results per page |
Response:
{ success: boolean, data: SearchPlaylist[] }
| Query Param | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | No* | — | Playlist ID (e.g. 82914609) |
| link | string (url) | No* | — | Direct JioSaavn playlist link |
| page | number | No | 0 |
Page number |
| limit | number | No | 10 |
Songs per page |
* Either id or link must be provided.
Response:
{ success: boolean, data: Playlist }
All endpoints may return error responses:
{
"success": false,
"message": "error description"
}