Reference

Reference for the YTMusic class.

class ytmusicapi.YTMusic(auth: str = None, user: str = None, requests_session=True, proxies: dict = None, language: str = 'en')

Allows automated interactions with YouTube Music by emulating the YouTube web client’s requests. Permits both authenticated and non-authenticated requests. Authentication header data must be provided on initialization.

YTMusic.__init__(auth: str = None, user: str = None, requests_session=True, proxies: dict = None, language: str = 'en')

Create a new instance to interact with YouTube Music.

Parameters:
  • auth – Optional. Provide a string or path to file. Authentication credentials are needed to manage your library. Should be an adjusted version of headers_auth.json.example in the project root. See setup() for how to fill in the correct credentials. Default: A default header is used without authentication.
  • user – Optional. Specify a user ID string to use in requests. This is needed if you want to send requests on behalf of a brand account. Otherwise the default account is used. You can retrieve the user ID by going to https://myaccount.google.com/brandaccounts and selecting your brand account. The user ID will be in the URL: https://myaccount.google.com/b/user_id/
  • requests_session – A Requests session object or a truthy value to create one. A falsy value disables sessions. It is generally a good idea to keep sessions enabled for performance reasons (connection pooling).
  • proxies

    Optional. Proxy configuration in requests format.

  • language – Optional. Can be used to change the language of returned data. English will be used by default. Available languages can be checked in the ytmusicapi/locales directory.

Setup

See also the Setup page

classmethod YTMusic.setup(filepath: str = None, headers_raw: str = None) → Dict[KT, VT]

Requests browser headers from the user via command line and returns a string that can be passed to YTMusic()

Parameters:
  • filepath – Optional filepath to store headers to.
  • headers_raw – Optional request headers copied from browser. Otherwise requested from terminal
Returns:

configuration headers string

Browsing

YTMusic.get_artist(channelId: str) → Dict[KT, VT]

Get information about an artist and their top releases (songs, albums, singles, videos, and related artists). The top lists contain pointers for getting the full list of releases. For songs/videos, pass the browseId to get_playlist(). For albums/singles, pass browseId and params to :py:func: get_artist_albums.

Parameters:channelId – channel id of the artist
Returns:Dictionary with requested information.

Example:

{
    "description": "Oasis were ...",
    "views": "1838795605",
    "name": "Oasis",
    "channelId": "UCUDVBtnOQi4c7E8jebpjc9Q",
    "subscribers": "2.3M",
    "subscribed": false,
    "thumbnails": [...],
    "songs": {
        "browseId": "VLPLMpM3Z0118S42R1npOhcjoakLIv1aqnS1",
        "results": [
            {
                "videoId": "ZrOKjDZOtkA",
                "title": "Wonderwall (Remastered)",
                "thumbnails": [...],
                "artist": "Oasis",
                "album": "(What's The Story) Morning Glory? (Remastered)"
            }
        ]
    },
    "albums": {
        "results": [
            {
                "title": "Familiar To Millions",
                "thumbnails": [...],
                "year": "2018",
                "browseId": "MPREb_AYetWMZunqA"
            }
        ],
        "browseId": "UCmMUZbaYdNH0bEd1PAlAqsA",
        "params": "6gPTAUNwc0JDbndLYlFBQV..."
    },
    "singles": {
        "results": [
            {
                "title": "Stand By Me (Mustique Demo)",
                "thumbnails": [...],
                "year": "2016",
                "browseId": "MPREb_7MPKLhibN5G"
            }
        ],
        "browseId": "UCmMUZbaYdNH0bEd1PAlAqsA",
        "params": "6gPTAUNwc0JDbndLYlFBQV..."
    },
    "videos": {
        "results": [
            {
                "title": "Wonderwall",
                "thumbnails": [...],
                "views": "358M",
                "videoId": "bx1Bh8ZvH84",
                "playlistId": "PLMpM3Z0118S5xuNckw1HUcj1D021AnMEB"
            }
        ],
        "browseId": "VLPLMpM3Z0118S5xuNckw1HUcj1D021AnMEB"
    },
    "related": {
        "results": [
            {
                "browseId": "UCt2KxZpY5D__kapeQ8cauQw",
                "subscribers": "450K",
                "title": "The Verve"
            },
            {
                "browseId": "UCwK2Grm574W1u-sBzLikldQ",
                "subscribers": "341K",
                "title": "Liam Gallagher"
            },
            ...
        ]
    }
}
YTMusic.get_artist_albums(channelId: str, params: str) → List[Dict[KT, VT]]

Get the full list of an artist’s albums or singles

Parameters:
  • channelId – channel Id of the artist
  • params – params obtained by get_artist()
Returns:

List of albums in the format of get_library_albums(), except artists key is missing.

YTMusic.get_user(channelId: str) → Dict[KT, VT]

Retrieve a user’s page. A user may own videos or playlists.

Parameters:channelId – channelId of the user
Returns:Dictionary with information about a user.

Example:

{
  "name": "4Tune – No Copyright Music",
  "videos": {
    "browseId": "UC44hbeRoCZVVMVg5z0FfIww",
    "results": [
      {
        "title": "Epic Music Soundtracks 2019",
        "videoId": "bJonJjgS2mM",
        "playlistId": "RDAMVMbJonJjgS2mM",
        "thumbnails": [
          {
            "url": "https://i.ytimg.com/vi/bJon...",
            "width": 800,
            "height": 450
          }
        ],
        "views": "19K"
      }
    ]
  },
  "playlists": {
    "browseId": "UC44hbeRoCZVVMVg5z0FfIww",
    "results": [
      {
        "title": "♚ Machinimasound | Playlist",
        "playlistId": "PLRm766YvPiO9ZqkBuEzSTt6Bk4eWIr3gB",
        "thumbnails": [
          {
            "url": "https://i.ytimg.com/vi/...",
            "width": 400,
            "height": 225
          }
        ]
      }
    ],
    "params": "6gO3AUNvWU..."
  }
}
YTMusic.get_user_playlists(channelId: str, params: str) → List[Dict[KT, VT]]

Retrieve a list of playlists for a given user. Call this function again with the returned params to get the full list.

Parameters:
  • channelId – channelId of the user.
  • params – params obtained by get_artist()
Returns:

List of user playlists in the format of get_library_playlists()

YTMusic.get_album(browseId: str) → Dict[KT, VT]

Get information and tracks of an album

Parameters:browseId – browseId of the album, for example returned by search()
Returns:Dictionary with title, description, artist and tracks.

Each track is in the following format:

{
  "title": "Seven",
  "trackCount": "7",
  "durationMs": "1439579",
  "playlistId": "OLAK5uy_kGnhwT08mQMGw8fArBowdtlew3DpgUt9c",
  "releaseDate": {
    "year": 2016,
    "month": 10,
    "day": 28
  },
  "description": "Seven is ...",
  "thumbnails": [...],
  "artist": [
    {
      "name": "Martin Garrix",
      "id": "UCqJnSdHjKtfsrHi9aI-9d3g"
    }
  ],
  "tracks": [
    {
      "index": "1",
      "title": "WIEE (feat. Mesto)",
      "artists": "Martin Garrix",
      "videoId": "8xMNeXI9wxI",
      "lengthMs": "203406",
      "likeStatus": "INDIFFERENT"
    }
  ]
}
YTMusic.get_song(videoId: str, signatureTimestamp: int = None) → Dict[KT, VT]

Returns metadata and streaming information about a song or video.

Parameters:
  • videoId – Video id
  • signatureTimestamp – Provide the current YouTube signatureTimestamp. If not provided a default value will be used, which might result in invalid streaming URLs
Returns:

Dictionary with song metadata.

Example:

{
  "videoDetails": {
    "allowRatings": true,
    "author": "Oasis - Topic",
    "averageRating": 4.5783687,
    "channelId": "UCmMUZbaYdNH0bEd1PAlAqsA",
    "isCrawlable": true,
    "isLiveContent": false,
    "isOwnerViewing": false,
    "isPrivate": false,
    "isUnpluggedCorpus": false,
    "lengthSeconds": "259",
    "musicVideoType": "MUSIC_VIDEO_TYPE_ATV",
    "thumbnail": {
      "thumbnails": [...]
    },
    "title": "Wonderwall",
    "videoId": "ZrOKjDZOtkA",
    "viewCount": "27429003"
  },
  "microformat": {
    "microformatDataRenderer": {
      "androidPackage": "com.google.android.apps.youtube.music",
      "appName": "YouTube Music",
      "availableCountries": ["AE",...],
      "category": "Music",
      "description": "Provided to YouTube by Ignition Wonderwall · Oasis ...",
      "familySafe": true,
      "iosAppArguments": "https://music.youtube.com/watch?v=ZrOKjDZOtkA",
      "iosAppStoreId": "1017492454",
      "linkAlternates": [
        {
          "hrefUrl": "android-app://com.google.android.youtube/http/youtube.com/watch?v=ZrOKjDZOtkA"
        },
        {
          "hrefUrl": "ios-app://544007664/http/youtube.com/watch?v=ZrOKjDZOtkA"
        },
        {
          "alternateType": "application/json+oembed",
          "hrefUrl": "https://www.youtube.com/oembed?format=json&url=...",
          "title": "Wonderwall (Remastered)"
        },
        {
          "alternateType": "text/xml+oembed",
          "hrefUrl": "https://www.youtube.com/oembed?format=xml&url=...",
          "title": "Wonderwall (Remastered)"
        }
      ],
      "noindex": false,
      "ogType": "video.other",
      "pageOwnerDetails": {
        "externalChannelId": "UCmMUZbaYdNH0bEd1PAlAqsA",
        "name": "Oasis - Topic",
        "youtubeProfileUrl": "http://www.youtube.com/channel/UCmMUZbaYdNH0bEd1PAlAqsA"
      },
      "paid": false,
      "publishDate": "2017-01-25",
      "schemaDotOrgType": "http://schema.org/VideoObject",
      "siteName": "YouTube Music",
      "tags": ["Oasis",...],
      "thumbnail": {
        "thumbnails": [
          {
            "height": 720,
            "url": "https://i.ytimg.com/vi/ZrOKjDZOtkA/maxresdefault.jpg",
            "width": 1280
          }
        ]
      },
      "title": "Wonderwall (Remastered) - YouTube Music",
      "twitterCardType": "player",
      "twitterSiteHandle": "@YouTubeMusic",
      "unlisted": false,
      "uploadDate": "2017-01-25",
      "urlApplinksAndroid": "vnd.youtube.music://music.youtube.com/watch?v=ZrOKjDZOtkA&feature=applinks",
      "urlApplinksIos": "vnd.youtube.music://music.youtube.com/watch?v=ZrOKjDZOtkA&feature=applinks",
      "urlCanonical": "https://music.youtube.com/watch?v=ZrOKjDZOtkA",
      "urlTwitterAndroid": "vnd.youtube.music://music.youtube.com/watch?v=ZrOKjDZOtkA&feature=twitter-deep-link",
      "urlTwitterIos": "vnd.youtube.music://music.youtube.com/watch?v=ZrOKjDZOtkA&feature=twitter-deep-link",
      "videoDetails": {
        "durationIso8601": "PT4M19S",
        "durationSeconds": "259",
        "externalVideoId": "ZrOKjDZOtkA"
      },
      "viewCount": "27429003"
    }
  },
  "playabilityStatus": {
    "contextParams": "Q0FFU0FnZ0I=",
    "miniplayer": {
      "miniplayerRenderer": {
        "playbackMode": "PLAYBACK_MODE_ALLOW"
      }
    },
    "playableInEmbed": true,
    "status": "OK"
  },
  "streamingData": {
    "adaptiveFormats": [
      {
        "approxDurationMs": "258760",
        "averageBitrate": 178439,
        "bitrate": 232774,
        "contentLength": "5771637",
        "fps": 25,
        "height": 1080,
        "indexRange": {
          "end": "1398",
          "start": "743"
        },
        "initRange": {
          "end": "742",
          "start": "0"
        },
        "itag": 137,
        "lastModified": "1614620567944400",
        "mimeType": "video/mp4; codecs="avc1.640020"",
        "projectionType": "RECTANGULAR",
        "quality": "hd1080",
        "qualityLabel": "1080p",
        "signatureCipher": "s=_xxxOq0QJ8...",
        "width": 1078
      }[...]
    ],
    "expiresInSeconds": "21540",
    "formats": [
      {
        "approxDurationMs": "258809",
        "audioChannels": 2,
        "audioQuality": "AUDIO_QUALITY_LOW",
        "audioSampleRate": "44100",
        "averageBitrate": 179462,
        "bitrate": 179496,
        "contentLength": "5805816",
        "fps": 25,
        "height": 360,
        "itag": 18,
        "lastModified": "1614620870611066",
        "mimeType": "video/mp4; codecs="avc1.42001E, mp4a.40.2"",
        "projectionType": "RECTANGULAR",
        "quality": "medium",
        "qualityLabel": "360p",
        "signatureCipher": "s=kXXXOq0QJ8...",
        "width": 360
      }
    ]
  }
}
YTMusic.get_lyrics(browseId: str) → Dict[KT, VT]

Returns lyrics of a song or video.

Parameters:browseId – Lyrics browse id obtained from get_watch_playlist
Returns:Dictionary with song lyrics.

Example:

{
    "lyrics": "Today is gonna be the day\nThat they're gonna throw it back to you\n",
    "source": "Source: LyricFind"
}

Explore

YTMusic.get_mood_categories() → Dict[KT, VT]

Fetch “Moods & Genres” categories from YouTube Music.

Returns:Dictionary of sections and categories.

Example:

{
    'For you': [
        {
            'params': 'ggMPOg1uX1ZwN0pHT2NBT1Fk',
            'title': '1980s'
        },
        {
            'params': 'ggMPOg1uXzZQbDB5eThLRTQ3',
            'title': 'Feel Good'
        },
        ...
    ],
    'Genres': [
        {
            'params': 'ggMPOg1uXzVLbmZnaWI4STNs',
            'title': 'Dance & Electronic'
        },
        {
            'params': 'ggMPOg1uX3NjZllsNGVEMkZo',
            'title': 'Decades'
        },
        ...
    ],
    'Moods & moments': [
        {
            'params': 'ggMPOg1uXzVuc0dnZlhpV3Ba',
            'title': 'Chill'
        },
        {
            'params': 'ggMPOg1uX2ozUHlwbWM3ajNq',
            'title': 'Commute'
        },
        ...
    ],
}
YTMusic.get_mood_playlists(params: str) → List[Dict[KT, VT]]

Retrieve a list of playlists for a given “Moods & Genres” category.

Parameters:params – params obtained by get_mood_categories()
Returns:List of playlists in the format of get_library_playlists()
YTMusic.get_charts(country: str = 'ZZ') → Dict[KT, VT]

Get latest charts data from YouTube Music: Top songs, top videos, top artists and top trending videos. Global charts have no Trending section, US charts have an extra Genres section with some Genre charts.

Parameters:country – ISO 3166-1 Alpha-2 country code. Default: ZZ = Global
Returns:Dictionary containing chart songs (only if authenticated), chart videos, chart artists and

trending videos.

Example:

{
    "countries": {
        "selected": {
            "text": "United States"
        },
        "options": ["DE",
            "ZZ",
            "ZW"]
    },
    "songs": {
        "playlist": "VLPL4fGSI1pDJn6O1LS0XSdF3RyO0Rq_LDeI",
        "items": [
            {
                "title": "Outside (Better Days)",
                "videoId": "oT79YlRtXDg",
                "artists": [
                    {
                        "name": "MO3",
                        "id": "UCdFt4Cvhr7Okaxo6hZg5K8g"
                    },
                    {
                        "name": "OG Bobby Billions",
                        "id": "UCLusb4T2tW3gOpJS1fJ-A9g"
                    }
                ],
                "thumbnails": [
                    {
                        "url": "https://lh3.googleusercontent.com/HtT4fwjY_SC7F2reuC1F3pREiq0z5G1XnO_IvhkI0LvCmdz05c8mhuZ6k3MiROvwH52TSJNj33TxnQIo=w60-h60-l90-rj",
                        "width": 60,
                        "height": 60
                    },
                    {
                        "url": "https://lh3.googleusercontent.com/HtT4fwjY_SC7F2reuC1F3pREiq0z5G1XnO_IvhkI0LvCmdz05c8mhuZ6k3MiROvwH52TSJNj33TxnQIo=w120-h120-l90-rj",
                        "width": 120,
                        "height": 120
                    }
                ],
                "isExplicit": true,
                "album": {
                    "name": "Outside (Better Days)",
                    "id": "MPREb_fX4Yv8frUNv"
                },
                "rank": "1",
                "trend": "up"
            }
        ]
    },
    "videos": {
        "playlist": "VLPL4fGSI1pDJn69On1f-8NAvX_CYlx7QyZc",
        "items": [
            {
                "title": "EVERY CHANCE I GET (Official Music Video) (feat. Lil Baby & Lil Durk)",
                "videoId": "BTivsHlVcGU",
                "playlistId": "PL4fGSI1pDJn69On1f-8NAvX_CYlx7QyZc",
                "thumbnails": [],
                "views": "46M"
            }
        ]
    },
    "artists": {
        "playlist": null,
        "items": [
            {
                "title": "YoungBoy Never Broke Again",
                "browseId": "UCR28YDxjDE3ogQROaNdnRbQ",
                "subscribers": "9.62M",
                "thumbnails": [],
                "rank": "1",
                "trend": "neutral"
            }
        ]
    },
    "genres": [
        {
            "title": "Top 50 Pop Music Videos United States",
            "playlistId": "PL4fGSI1pDJn77aK7sAW2AT0oOzo5inWY8",
            "thumbnails": []
        }
    ],
    "trending": {
        "playlist": "VLPLrEnWoR732-DtKgaDdnPkezM_nDidBU9H",
        "items": [
            {
                "title": "Permission to Dance",
                "videoId": "CuklIb9d3fI",
                "playlistId": "PLrEnWoR732-DtKgaDdnPkezM_nDidBU9H",
                "artists": [
                    {
                        "name": "BTS",
                        "id": "UC9vrvNSL3xcWGSkV86REBSg"
                    }
                ],
                "thumbnails": [],
                "views": "108M"
            }
        ]
    }
}

Watch

YTMusic.get_watch_playlist(videoId: str = None, playlistId: str = None, limit=25, params: str = None) → Dict[str, List[Dict[KT, VT]]]

Get a watch list of tracks. This watch playlist appears when you press play on a track in YouTube Music.

Please note that the INDIFFERENT likeStatus of tracks returned by this endpoint may be either INDIFFERENT or DISLIKE, due to ambiguous data returned by YouTube Music.

Parameters:
  • videoId – videoId of the played video
  • playlistId – playlistId of the played playlist or album
  • limit – minimum number of watch playlist items to return
  • params – only used internally by get_watch_playlist_shuffle()
Returns:

List of watch playlist items.

Example:

{
    "tracks": [
        {
          "title": "Interstellar (Main Theme) - Piano Version",
          "byline": "Patrik Pietschmann • 47M views",
          "length": "4:47",
          "videoId": "4y33h81phKU",
          "thumbnail": [
            {
              "url": "https://i.ytimg.com/vi/4y...",
              "width": 400,
              "height": 225
            }
          ],
          "feedbackTokens": [],
          "likeStatus": "LIKE"
        },...
    ],
    "playlist": "RDAMVM4y33h81phKU",
    "lyrics": "MPLYt_HNNclO0Ddoc-17"
}
YTMusic.get_watch_playlist_shuffle(videoId: str = None, playlistId: str = None, limit=50) → Dict[str, List[Dict[KT, VT]]]

Shuffle any playlist

Parameters:
  • videoId – Optional video id of the first video in the shuffled playlist
  • playlistId – Playlist id
  • limit – The number of watch playlist items to return
Returns:

A list of watch playlist items (see get_watch_playlist())

Library

YTMusic.get_library_playlists(limit: int = 25) → List[Dict[KT, VT]]

Retrieves the playlists in the user’s library.

Parameters:limit – Number of playlists to retrieve
Returns:List of owned playlists.

Each item is in the following format:

{
    'playlistId': 'PLQwVIlKxHM6rz0fDJVv_0UlXGEWf-bFys',
    'title': 'Playlist title',
    'thumbnails: [...],
    'count': 5
}
YTMusic.get_library_songs(limit: int = 25, validate_responses: bool = False, order: str = None) → List[Dict[KT, VT]]

Gets the songs in the user’s library (liked videos are not included). To get liked songs and videos, use get_liked_songs()

Parameters:
  • limit – Number of songs to retrieve
  • validate_responses – Flag indicating if responses from YTM should be validated and retried in case when some songs are missing. Default: False
  • order – Order of songs to return. Allowed values: ‘a_to_z’, ‘z_to_a’, ‘recently_added’. Default: Default order.
Returns:

List of songs. Same format as get_playlist()

YTMusic.get_library_artists(limit: int = 25, order: str = None) → List[Dict[KT, VT]]

Gets the artists of the songs in the user’s library.

Parameters:
  • limit – Number of artists to return
  • order – Order of artists to return. Allowed values: ‘a_to_z’, ‘z_to_a’, ‘recently_added’. Default: Default order.
Returns:

List of artists.

Each item is in the following format:

{
  "browseId": "UCxEqaQWosMHaTih-tgzDqug",
  "artist": "WildVibes",
  "subscribers": "2.91K",
  "thumbnails": [...]
}
YTMusic.get_library_albums(limit: int = 25, order: str = None) → List[Dict[KT, VT]]

Gets the albums in the user’s library.

Parameters:
  • limit – Number of albums to return
  • order – Order of albums to return. Allowed values: ‘a_to_z’, ‘z_to_a’, ‘recently_added’. Default: Default order.
Returns:

List of albums.

Each item is in the following format:

{
  "browseId": "MPREb_G8AiyN7RvFg",
  "title": "Beautiful",
  "type": "Album",
  "thumbnails": [...],
  "artists": {
    "name": "Project 46",
    "id": "UCXFv36m62USAN5rnVct9B4g"
  },
  "year": "2015"
}
YTMusic.get_liked_songs(limit: int = 100) → Dict[KT, VT]

Gets playlist items for the ‘Liked Songs’ playlist

Parameters:limit – How many items to return. Default: 100
Returns:List of playlistItem dictionaries. See get_playlist()
YTMusic.get_history() → List[Dict[KT, VT]]

Gets your play history in reverse chronological order

Returns:List of playlistItems, see get_playlist() The additional property played indicates when the playlistItem was played The additional property feedbackToken can be used to remove items with remove_history_items()
YTMusic.remove_history_items(feedbackTokens: List[str]) → Dict[KT, VT]

Remove an item from the account’s history. This method does currently not work with brand accounts

Parameters:feedbackTokens – Token to identify the item to remove, obtained from get_history()
Returns:Full response
YTMusic.rate_song(videoId: str, rating: str = 'INDIFFERENT') → Dict[KT, VT]

Rates a song (“thumbs up”/”thumbs down” interactions on YouTube Music)

Parameters:
  • videoId – Video id
  • rating

    One of ‘LIKE’, ‘DISLIKE’, ‘INDIFFERENT’

    ’INDIFFERENT’ removes the previous rating and assigns no rating
Returns:

Full response

YTMusic.edit_song_library_status(feedbackTokens: List[str] = None) → Dict[KT, VT]

Adds or removes a song from your library depending on the token provided.

Parameters:feedbackTokens – List of feedbackTokens obtained from authenticated requests to endpoints that return songs (i.e. get_album())
Returns:Full response
YTMusic.rate_playlist(playlistId: str, rating: str = 'INDIFFERENT') → Dict[KT, VT]

Rates a playlist/album (“Add to library”/”Remove from library” interactions on YouTube Music) You can also dislike a playlist/album, which has an effect on your recommendations

Parameters:
  • playlistId – Playlist id
  • rating

    One of ‘LIKE’, ‘DISLIKE’, ‘INDIFFERENT’

    ’INDIFFERENT’ removes the playlist/album from the library
Returns:

Full response

YTMusic.subscribe_artists(channelIds: List[str]) → Dict[KT, VT]

Subscribe to artists. Adds the artists to your library

Parameters:channelIds – Artist channel ids
Returns:Full response
YTMusic.unsubscribe_artists(channelIds: List[str]) → Dict[KT, VT]

Unsubscribe from artists. Removes the artists from your library

Parameters:channelIds – Artist channel ids
Returns:Full response

Playlists

YTMusic.get_playlist(playlistId: str, limit: int = 100) → Dict[KT, VT]

Returns a list of playlist items

Parameters:
  • playlistId – Playlist id
  • limit – How many songs to return. Default: 100
Returns:

Dictionary with information about the playlist. The key tracks contains a List of playlistItem dictionaries

Each item is in the following format:

{
  "id": "PLQwVIlKxHM6qv-o99iX9R85og7IzF9YS_",
  "privacy": "PUBLIC",
  "title": "New EDM This Week 03/13/2020",
  "thumbnails": [...]
  "description": "Weekly r/EDM new release roundup. Created with github.com/sigma67/spotifyplaylist_to_gmusic",
  "author": "sigmatics",
  "year": "2020",
  "duration": "6+ hours",
  "trackCount": 237,
  "tracks": [
    {
      "videoId": "bjGppZKiuFE",
      "title": "Lost",
      "artists": [
        {
          "name": "Guest Who",
          "id": "UCkgCRdnnqWnUeIH7EIc3dBg"
        },
        {
          "name": "Kate Wild",
          "id": "UCwR2l3JfJbvB6aq0RnnJfWg"
        }
      ],
      "album": {
        "name": "Lost",
        "id": "MPREb_PxmzvDuqOnC"
      },
      "duration": "2:58",
      "likeStatus": "INDIFFERENT",
      "thumbnails": [...],
      "isAvailable": True,
      "isExplicit": False,
      "feedbackTokens": {
        "add": "AB9zfpJxtvrU...",
        "remove": "AB9zfpKTyZ..."
    }
  ]
}

The setVideoId is the unique id of this playlist item and needed for moving/removing playlist items

YTMusic.create_playlist(title: str, description: str, privacy_status: str = 'PRIVATE', video_ids: List[T] = None, source_playlist: str = None) → Union[str, Dict[KT, VT]]

Creates a new empty playlist and returns its id.

Parameters:
  • title – Playlist title
  • description – Playlist description
  • privacy_status – Playlists can be ‘PUBLIC’, ‘PRIVATE’, or ‘UNLISTED’. Default: ‘PRIVATE’
  • video_ids – IDs of songs to create the playlist with
  • source_playlist – Another playlist whose songs should be added to the new playlist
Returns:

ID of the YouTube playlist or full response if there was an error

YTMusic.edit_playlist(playlistId: str, title: str = None, description: str = None, privacyStatus: str = None, moveItem: Tuple[str, str] = None, addPlaylistId: str = None) → Union[str, Dict[KT, VT]]

Edit title, description or privacyStatus of a playlist. You may also move an item within a playlist or append another playlist to this playlist.

Parameters:
  • playlistId – Playlist id
  • title – Optional. New title for the playlist
  • description – Optional. New description for the playlist
  • privacyStatus – Optional. New privacy status for the playlist
  • moveItem – Optional. Move one item before another. Items are specified by setVideoId, see get_playlist()
  • addPlaylistId – Optional. Id of another playlist to add to this playlist
Returns:

Status String or full response

YTMusic.delete_playlist(playlistId: str) → Union[str, Dict[KT, VT]]

Delete a playlist.

Parameters:playlistId – Playlist id
Returns:Status String or full response
YTMusic.add_playlist_items(playlistId: str, videoIds: List[str] = None, source_playlist: str = None, duplicates: bool = False) → Union[str, Dict[KT, VT]]

Add songs to an existing playlist

Parameters:
  • playlistId – Playlist id
  • videoIds – List of Video ids
  • source_playlist – Playlist id of a playlist to add to the current playlist (no duplicate check)
  • duplicates – If True, duplicates will be added. If False, an error will be returned if there are duplicates (no items are added to the playlist)
Returns:

Status String and a dict containing the new setVideoId for each videoId or full response

YTMusic.remove_playlist_items(playlistId: str, videos: List[Dict[KT, VT]]) → Union[str, Dict[KT, VT]]

Remove songs from an existing playlist

Parameters:
  • playlistId – Playlist id
  • videos – List of PlaylistItems, see get_playlist(). Must contain videoId and setVideoId
Returns:

Status String or full response

Uploads

YTMusic.get_library_upload_songs(limit: int = 25, order: str = None) → List[Dict[KT, VT]]

Returns a list of uploaded songs

Parameters:
  • limit – How many songs to return. Default: 25
  • order – Order of songs to return. Allowed values: ‘a_to_z’, ‘z_to_a’, ‘recently_added’. Default: Default order.
Returns:

List of uploaded songs.

Each item is in the following format:

{
  "entityId": "t_po_CICr2crg7OWpchDpjPjrBA",
  "videoId": "Uise6RPKoek",
  "artist": "Coldplay",
  "title": "A Sky Full Of Stars",
  "album": "Ghost Stories",
  "likeStatus": "LIKE",
  "thumbnails": [...]
}
YTMusic.get_library_upload_artists(limit: int = 25, order: str = None) → List[Dict[KT, VT]]

Gets the artists of uploaded songs in the user’s library.

Parameters:
  • limit – Number of artists to return. Default: 25
  • order – Order of artists to return. Allowed values: ‘a_to_z’, ‘z_to_a’, ‘recently_added’. Default: Default order.
Returns:

List of artists as returned by get_library_artists()

YTMusic.get_library_upload_albums(limit: int = 25, order: str = None) → List[Dict[KT, VT]]

Gets the albums of uploaded songs in the user’s library.

Parameters:
  • limit – Number of albums to return. Default: 25
  • order – Order of albums to return. Allowed values: ‘a_to_z’, ‘z_to_a’, ‘recently_added’. Default: Default order.
Returns:

List of albums as returned by get_library_albums()

YTMusic.get_library_upload_artist(browseId: str, limit: int = 25) → List[Dict[KT, VT]]

Returns a list of uploaded tracks for the artist.

Parameters:
  • browseId – Browse id of the upload artist, i.e. from get_library_upload_songs()
  • limit – Number of songs to return (increments of 25).
Returns:

List of uploaded songs.

Example List:

[
  {
    "entityId": "t_po_CICr2crg7OWpchDKwoakAQ",
    "videoId": "Dtffhy8WJgw",
    "title": "Hold Me (Original Mix)",
    "artist": [
      {
        "name": "Jakko",
        "id": "FEmusic_library_privately_owned_artist_detaila_po_CICr2crg7OWpchIFamFra28"
      }
    ],
    "album": null,
    "likeStatus": "LIKE",
    "thumbnails": [...]
  }
]
YTMusic.get_library_upload_album(browseId: str) → Dict[KT, VT]

Get information and tracks of an album associated with uploaded tracks

Parameters:browseId – Browse id of the upload album, i.e. from i.e. from get_library_upload_songs()
Returns:Dictionary with title, description, artist and tracks.

Example album:

{
  "title": "18 Months",
  "type": "Album",
  "thumbnails": [...],
  "trackCount": 7,
  "duration": "24 minutes",
  "audioPlaylistId": "MLPRb_po_55chars",
  "tracks": [
    {
      "entityId": "t_po_22chars",
      "videoId": "FVo-UZoPygI",
      "title": "Feel So Close",
      "duration": "4:15",
      "artist": None,
      "album": {
        "name": "18 Months",
        "id": "FEmusic_library_privately_owned_release_detailb_po_55chars"
      },
      "likeStatus": "INDIFFERENT",
      "thumbnails": None
    },
YTMusic.upload_song(filepath: str) → Union[str, requests.models.Response]

Uploads a song to YouTube Music

Parameters:filepath – Path to the music file (mp3, m4a, wma, flac or ogg)
Returns:Status String or full response
YTMusic.delete_upload_entity(entityId: str) → Union[str, Dict[KT, VT]]

Deletes a previously uploaded song or album

Parameters:entityId – The entity id of the uploaded song or album, e.g. retrieved from get_library_upload_songs()
Returns:Status String or error