Jiosaavnpy

https://github.com/zingytomato/jiosaavnpy
Admin
Jiosaavnpy is a Python 3 library for accessing JioSaavn's music catalog through their unofficial...
Tokens:2,499
Snippets:30
Trust Score:7.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install jiosaavnpy Package

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Install the JioSaavnPy library using pip. Ensure you have Python 3.7 or higher.

```bash
pip install jiosaavnpy

```

--------------------------------

### Get Song Details Example

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Retrieves and prints detailed information for a specific song using its track ID. Includes title, artist, album, duration, and release year.

```python
from jiosaavnpy import JioSaavn

def get_song_details():
    """Retrieve detailed information about a specific song."""
    jio = JioSaavn()
    
    # Use track_id from search results
    track_id = "e0kCEwoC"  # Never Gonna Give You Up
    song_info = jio.song_info(track_id)
    
    print(f"Title: {song_info['title']}")
    print(f"Artist: {song_info['primary_artists']}")
    print(f"Album: {song_info['album_name']}")
    print(f"Duration: {song_info['duration']} seconds")
    print(f"Year: {song_info['release_year']}")
    
    return song_info

# Run the example
details = get_song_details()

```

--------------------------------

### Explore Album Example

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Searches for an album by name, retrieves its details including the track list, and prints the album name, artist, and the titles of all its tracks.

```python
from jiosaavnpy import JioSaavn

def explore_album():
    """Search for albums and get detailed information."""
    jio = JioSaavn()
    
    # Search for albums
    albums = jio.search_albums("Whenever You Need Somebody", limit=3)
    
    if albums:
        album_id = albums[0]['album_id']
        album_details = jio.album_info(album_id)
        
        print(f"Album: {album_details['album_name']}")
        print(f"Artist: {album_details['primary_artists']}")
        print(f"Tracks: {len(album_details['tracks'])}")
        
        # List all tracks
        for track in album_details['tracks']:
            print(f"  - {track['title']}")

# Run the example
explore_album()

```

--------------------------------

### Quick Start: Initialize Client and Search Songs

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Initialize the JioSaavn client and perform a basic song search. Displays the title and primary artist of the first result.

```python
from jiosaavnpy import JioSaavn

# Initialize the client
jio = JioSaavn()

# Search for songs
results = jio.search_songs("Never gonna give you up", limit=5)
print(results[0]['title'])  # "Never Gonna Give You Up"
print(results[0]['primary_artists'])  # "Rick Astley"

```

--------------------------------

### Get Album Information

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Retrieves detailed information for a specific album using its unique album ID.

```python
album_info(album_id)
```

--------------------------------

### Search Songs Example

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Prompts the user for a song name, searches for it using the JioSaavn API, and prints a numbered list of matching songs with their primary artists.

```python
from jiosaavnpy import JioSaavn

def search_songs_example():
    """Search for songs and display results."""
    jio = JioSaavn()
    
    query = input("Enter song name: ")
    results = jio.search_songs(query, limit=10)
    
    for i, song in enumerate(results, 1):
        print(f"{i}. {song['title']} - {song['primary_artists']}")
    return results

# Run the example
songs = search_songs_example()

```

--------------------------------

### Get Home Page Data

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Fetches home page content, including trending music and charts, for a specified language. Language is case-sensitive.

```python
get_home(language)
```

--------------------------------

### Get Song Information

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Retrieves detailed information for a specific song using its unique track ID.

```python
song_info(track_id)
```

--------------------------------

### Get Artist Information

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Retrieves detailed information for a specific artist, including top songs and albums. Specify limits for songs and albums.

```python
artist_info(artist_token, song_limit=5, album_limit=5)
```

--------------------------------

### Song Object Structure

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Example JSON structure for a song object, detailing fields like track ID, title, artists, album, duration, and stream URLs.

```json
{
  "track_id": "e0kCEwoC",
  "title": "Never Gonna Give You Up",
  "primary_artists": "Rick Astley",
  "primary_artists_ids": "512102",
  "album_name": "Whenever You Need Somebody",
  "album_id": "26553699",
  "duration": "213",
  "release_year": "1987",
  "track_language": "english",
  "play_count": "199567",
  "is_explicit": false,
  "thumbnails": {
    "quality": {
      "50x50": "https://c.saavncdn.com/",
      "150x150": "https://c.saavncdn.com/",
      "500x500": "https://c.saavncdn.com/"
    }
  },
  "stream_urls": {
    "low_quality": "https://aac.saavncdn.com/...48.mp4",
    "medium_quality": "https://aac.saavncdn.com/...96.mp4",
    "high_quality": "https://aac.saavncdn.com/...160.mp4",
    "very_high_quality": "https://aac.saavncdn.com/...320.mp4"
  }
}
```

--------------------------------

### Get Similar Songs

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Finds songs that are related to a given track based on its track ID.

```python
similar_songs(track_id)
```

--------------------------------

### Get Playlist Information

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Retrieves detailed information for a specific playlist using its unique playlist ID.

```python
playlist_info(playlist_id)
```

--------------------------------

### album_info

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Fetches detailed information about a specific album, including its track list, using the album ID.

```APIDOC
## album_info

### Description
Get detailed information about a specific album.

### Method
Not specified (assumed to be a function call within a library)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **album_id** (str): Unique identifier for the album

### Returns
Dictionary with album information and track list.
```

--------------------------------

### get_home

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Retrieves data for the home page, including trending content, top playlists, albums, and charts, filtered by language.

```APIDOC
## get_home

### Description
Get detailed home page data (new trending, top playlists & albums, charts) based on the `language`.

### Method
Not specified (assumed to be a function call within a library)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **language** (str): The language to return home data in.
    Example: `english`, `tamil` (Case Sensitive!)

### Returns
Dictionary with home page data.
```

--------------------------------

### playlist_info

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Fetches detailed information for a specific playlist, including its track list, using the playlist ID.

```APIDOC
## playlist_info

### Description
Get detailed information about a specific playlist.

### Method
Not specified (assumed to be a function call within a library)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **playlist_id** (str): Unique identifier for the playlist

### Returns
Dictionary with playlist information and track list.
```

--------------------------------

### song_info

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Retrieves detailed information for a specific song using its track ID.

```APIDOC
## song_info

### Description
Get detailed information about a specific song.

### Method
Not specified (assumed to be a function call within a library)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **track_id** (str): Unique identifier for the track

### Returns
Dictionary with comprehensive song information.
```

--------------------------------

### artist_info

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Retrieves comprehensive details about an artist, including their top songs and albums, using their artist token.

```APIDOC
## artist_info

### Description
Get detailed information about a specific artist.

### Method
Not specified (assumed to be a function call within a library)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **artist_token** (str): Unique identifier for the artist
- **song_limit** (int, optional): Number of top songs to include (default: 5)
- **album_limit** (int, optional): Number of top albums to include (default: 5)

### Returns
Dictionary with artist information, top songs, and albums.
```

--------------------------------

### Search Playlists

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Searches for playlists based on a query. Specify the number of results to return.

```python
search_playlists(search_query, limit=5)
```

--------------------------------

### search_playlists

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Searches for playlists based on a query. You can limit the number of results returned.

```APIDOC
## search_playlists

### Description
Search for playlists by name or description.

### Method
Not specified (assumed to be a function call within a library)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **search_query** (str): Playlist name to search for.
- **limit** (int, optional): Number of results to return (default: 5).

### Returns
List of playlist dictionaries.
```

--------------------------------

### similar_songs

Source: https://github.com/zingytomato/jiosaavnpy/blob/main/README.md

Finds songs that are similar to a given track, based on its track ID.

```APIDOC
## similar_songs

### Description
Get related songs based on its `track_id`.

### Method
Not specified (assumed to be a function call within a library)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **track_id** (str): Unique identifier for the track.

### Returns
Related songs.
```
Tokens:
Raw