Клиент¶

Приступив к работе первым делом необходимо создать экземпляр клиента.

Инициализация синхронного клиента:

from yandex_music import Client

client = Client()
client.init()

# или

client = Client().init()

После успешного создания клиента вы вольны в выборе необходимого метода из API. Все они доступны у объекта класса Client и описаны ниже. Используйте навигацию из меню справа для быстрого доступа.

yandex_music.client¶

class yandex_music.client.Client(token: str | None = None, base_url: str | None = None, request: Request | None = None, language: str = 'ru', report_unknown_fields: bool = False)¶

Bases: YandexMusicObject

Класс, представляющий клиент Yandex Music.

Note

Доступные языки: en, uz, uk, us, ru, kk, hy.

Поле device используется только при работе с очередью прослушивания.

logger¶

Объект логгера.

Type:: logging.Logger

token¶

Уникальный ключ для аутентификации.

Type:: str

base_url¶

Ссылка на API Yandex Music.

Type:: str

me¶

Информация об аккаунте.

Type:: yandex_music.Status

device¶

Строка, содержащая сведения об устройстве, с которого выполняются запросы.

Type:: str

report_unknown_fields¶

Включены ли предупреждения о неизвестных полях от API, которых нет в библиотеке.

Type:: bool

Parameters:

token (str, optional) – Уникальный ключ для аутентификации.
base_url (str, optional) – Ссылка на API Yandex Music.
request (yandex_music.utils.request.Request, optional) – Пре-инициализация yandex_music.utils.request.Request.
language (str, optional) – Язык, на котором будут приходить ответы от API. По умолчанию русский.
report_unknown_fields (bool, optional) – Включить предупреждения о неизвестных полях от API, которых нет в библиотеке.

accountExperiments(*args: Any, **kwargs: Any) → Experiments | None¶: Псевдоним для account_experiments

accountSettings(*args: Any, **kwargs: Any) → UserSettings | None¶: Псевдоним для account_settings

accountSettingsSet(param: str | None = None, value: str | int | bool | None = None, data: JSONType | None = None, *args: Any, **kwargs: Any) → UserSettings | None¶: Псевдоним для account_settings_set

accountStatus(*args: Any, **kwargs: Any) → Status | None¶: Псевдоним для account_status

account_experiments(*args: Any, **kwargs: Any) → Experiments | None¶

Получение значений экспериментальных функций аккаунта.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Состояние экспериментальных функций или None.

Return type:

yandex_music.Experiments | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

account_settings(*args: Any, **kwargs: Any) → UserSettings | None¶

Получение настроек текущего пользователя.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Настройки пользователя если аккаунт валиден,: иначе None.

Return type:

yandex_music.UserSettings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Изменение настроек текущего пользователя.

Note

Доступные названия параметров есть поля в классе yandex_music.UserSettings, только в CamelCase.

Parameters:

param (str) – Название параметра для изменения.
value (str | int | bool) – Значение параметра.
data (dict) – Словарь параметров и значений для множественного изменения.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Настройки пользователя или None.

Return type:

yandex_music.UserSettings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

account_status(*args: Any, **kwargs: Any) → Status | None¶

Получение статуса аккаунта. Нет обязательных параметров.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация об аккаунте если он валиден, иначе None.

Return type:

yandex_music.Status | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

afterTrack(next_track_id: str | int, context_item: str, prev_track_id: str | int | None = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', *args: Any, **kwargs: Any) → ShotEvent | None¶: Псевдоним для after_track

after_track(next_track_id: str | int, context_item: str, prev_track_id: str | int | None = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', *args: Any, **kwargs: Any) → ShotEvent | None¶

Получение рекламы или шота от Алисы после трека.

Note

При получения шота от Алисы prev_track_id можно не указывать.

Если context = ‘playlist’, то в context_item необходимо передать {OWNER_PLAYLIST}:{ID_PLAYLIST}. Плейлист с Алисой имеет владельца с id = 940441070.

ID плейлиста можно получить из блоков landing’a. Получить шот чужого плейлиста нельзя.

Известные значения context: playlist.

Известные значения types: shot, ad.

Parameters:

prev_track_id (str | int) – Уникальный идентификатор предыдущего трека.
next_track_id (str | int) – Уникальный идентификатор следующего трека.
context_item (str) – Уникальный идентификатор контекста.
context (str, optional) – Место, откуда было вызвано получение.
types (str, optional) – Тип того, что вернуть после трека.
from (str, optional) – Место, с которого попали в контекст.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Шот от Алисы или None.

Return type:

yandex_music.ShotEvent

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

albums(album_ids: List[str | int] | int | str, *args: Any, **kwargs: Any) → List[Album]¶

Получение альбома/альбомов.

Parameters:

album_ids (str | int | list из str | list из int) – Уникальный идентификатор альбома или альбомов.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Альбом или альбомы.

Return type:

list из yandex_music.Album

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

albumsWithTracks(album_id: str | int, *args: Any, **kwargs: Any) → Album | None¶: Псевдоним для albums_with_tracks

albums_with_tracks(album_id: str | int, *args: Any, **kwargs: Any) → Album | None¶

Получение альбома по его уникальному идентификатору вместе с треками.

Parameters:

album_id (str | int) – Уникальный идентификатор альбома.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Альбом или None.

Return type:

list из yandex_music.Album | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

artists(artist_ids: List[str | int] | int | str, *args: Any, **kwargs: Any) → List[Artist]¶

Получение исполнителя/исполнителей.

Parameters:

artist_ids (str | int | list из str | list из int) – Уникальный идентификатор исполнителя или исполнителей.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Исполнитель или исполнители.

Return type:

list из yandex_music.Artist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

artistsBriefInfo(artist_id: str | int, *args: Any, **kwargs: Any) → BriefInfo | None¶: Псевдоним для artists_brief_info

artistsDirectAlbums(artist_id: str | int, page: int = 0, page_size: int = 20, sort_by: str = 'year', *args: Any, **kwargs: Any) → ArtistAlbums | None¶: Псевдоним для artists_direct_albums

artistsTracks(artist_id: str | int, page: int = 0, page_size: int = 20, *args: Any, **kwargs: Any) → ArtistTracks | None¶: Псевдоним для artists_tracks

artists_brief_info(artist_id: str | int, *args: Any, **kwargs: Any) → BriefInfo | None¶

Получение информации об артисте.

Parameters:

artist_id (str | int) – Уникальный идентификатор исполнителя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация об артисте или None.

Return type:

yandex_music.BriefInfo | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

artists_direct_albums(artist_id: str | int, page: int = 0, page_size: int = 20, sort_by: str = 'year', *args: Any, **kwargs: Any) → ArtistAlbums | None¶

Получение альбомов артиста.

Note

Известные значения для sort_by: year, rating.

Parameters:

artist_id (str | int) – Уникальный идентификатор артиста.
page (int, optional) – Номер страницы.
page_size (int, optional) – Количество альбомов на странице.
sort_by (str, optional) – Параметр для сортировки.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница списка альбомов артиста или None.

Return type:

yandex_music.ArtistAlbums | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

artists_tracks(artist_id: str | int, page: int = 0, page_size: int = 20, *args: Any, **kwargs: Any) → ArtistTracks | None¶

Получение треков артиста.

Parameters:

artist_id (str | int) – Уникальный идентификатор артиста.
page (int, optional) – Номер страницы.
page_size (int, optional) – Количество треков на странице.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница списка треков артиста или None.

Return type:

yandex_music.ArtistsTracks | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

chart(chart_option: str = '', *args: Any, **kwargs: Any) → ChartInfo | None¶

Получение чарта.

Note

chart_option - это постфикс к запросу из поля menu чарта. Например, на сайте можно выбрать глобальный (world) чарт или российский (russia).

Parameters:

chart_option (str optional) – Параметры чарта.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Чарт.

Return type:

yandex_music.ChartInfo

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

consumePromoCode(code: str, language: str | None = None, *args, **kwargs) → PromoCodeStatus | None¶: Псевдоним для consume_promo_code

consume_promo_code(code: str, language: str | None = None, *args, **kwargs) → PromoCodeStatus | None¶

Активация промо-кода.

Note

Доступные языки: en, uz, uk, us, ru, kk, hy.

Parameters:

code (str) – Промо-код.
language (str, optional) – Язык ответа API в ISO 639-1. По умолчанию язык клиента.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация об активации промо-кода или None.

Return type:

yandex_music.PromoCodeStatus | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

feed(*args: Any, **kwargs: Any) → Feed | None¶

Получение потока информации (фида) подобранного под пользователя. Содержит умные плейлисты.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Умные плейлисты пользователя или None.

Return type:

yandex_music.Feed | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

feedWizardIsPassed(*args: Any, **kwargs: Any) → bool¶: Псевдоним для feed_wizard_is_passed

feed_wizard_is_passed(*args: Any, **kwargs: Any) → bool¶

Получение информации о прохождении визарда.

Note

Временное событие на хэллоуин.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Прошел ли пользователь визард или нет.

Return type:

bool

genres(*args: Any, **kwargs: Any) → List[Genre]¶

Получение жанров музыки.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Жанры музыки или None.

Return type:

list из yandex_music.Genre | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

init() → Client¶: Получение информацию об аккаунте использующихся в других запросах.

landing(blocks: str | List[str], *args: Any, **kwargs: Any) → Landing | None¶

Получение лендинг-страницы содержащий блоки с новыми релизами, чартами, плейлистами с новинками и т.д.

Note

Поддерживаемые типы блоков: personalplaylists, promotions, new-releases, new-playlists, mixes, chart, artists, albums, playlists, play_contexts.

Parameters:

blocks (str | list из str) – Блок или список блоков необходимых для выдачи.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Лендинг-страница или None.

Return type:

yandex_music.Landing | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

newPlaylists(*args: Any, **kwargs: Any) → LandingList | None¶: Псевдоним для new_playlists

newReleases(*args: Any, **kwargs: Any) → LandingList | None¶: Псевдоним для new_releases

new_playlists(*args: Any, **kwargs: Any) → LandingList | None¶

Получение полного списка всех новых плейлистов.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список новых плейлистов.

Return type:

yandex_music.LandingList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

new_releases(*args: Any, **kwargs: Any) → LandingList | None¶

Получение полного списка всех новых релизов (альбомов).

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список новых альбомов.

Return type:

yandex_music.LandingList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

permissionAlerts(*args: Any, **kwargs: Any) → PermissionAlerts | None¶: Псевдоним для permission_alerts

permission_alerts(*args: Any, **kwargs: Any) → PermissionAlerts | None¶

Получение оповещений. Нет обязательных параметров.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Оповещения если аккаунт валиден или None.

Return type:

yandex_music.PermissionAlerts | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

playAudio(track_id: str | int, from_: str, album_id: str | int, playlist_id: str | None = None, from_cache: bool = False, play_id: str | None = None, uid: int | None = None, timestamp: str | None = None, track_length_seconds: int = 0, total_played_seconds: int = 0, end_position_seconds: int = 0, client_now: str | None = None, *args: Any, **kwargs: Any) → bool¶: Псевдоним для play_audio

play_audio(track_id: str | int, from_: str, album_id: str | int, playlist_id: str | None = None, from_cache: bool = False, play_id: str | None = None, uid: int | None = None, timestamp: str | None = None, track_length_seconds: int = 0, total_played_seconds: int = 0, end_position_seconds: int = 0, client_now: str | None = None, *args: Any, **kwargs: Any) → bool¶

Метод для отправки текущего состояния прослушиваемого трека.

Parameters:

track_id (str | int) – Уникальный идентификатор трека.
from (str) – Наименования клиента с которого происходит прослушивание.
album_id (str | int) – Уникальный идентификатор альбома.
playlist_id (str, optional) – Уникальный идентификатор плейлиста, если таковой прослушивается.
from_cache (bool, optional) – Проигрывается ли трек с кеша.
play_id (str, optional) – Уникальный идентификатор проигрывания.
uid (int, optional) – Уникальный идентификатор пользователя.
timestamp (str, optional) – Текущая дата и время в ISO.
track_length_seconds (int, optional) – Продолжительность трека в секундах.
total_played_seconds (int, optional) – Сколько было всего воспроизведено трека в секундах.
end_position_seconds (int, optional) – Окончательное значение воспроизведенных секунд.
client_now (str, optional) – Текущая дата и время клиента в ISO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

playlistsCollectiveJoin(user_id: int, token: str, **kwargs: Any) → bool¶: Псевдоним для playlists_collective_join

playlistsList(playlist_ids: List[str | int] | int | str, *args: Any, **kwargs: Any) → List[Playlist]¶: Псевдоним для playlists_list

playlists_collective_join(user_id: int, token: str, **kwargs: Any) → bool¶

Присоединение к плейлисту как соавтор.

Note

В качестве user_id принимается исключительно числовой уникальный идентификатор пользователя, не username.

Токен можно получить в Web-версии. Для этого, на странице плейлиста нужно нажать на “Добавить соавтора”. В полученной ссылке GET параметр token и будет токеном для присоединения.

Parameters:

user_id (int) – Владелец плейлиста.
token (str) – Токен для присоединения.
**kwargs – Произвольные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

playlists_list(playlist_ids: List[str | int] | int | str, *args: Any, **kwargs: Any) → List[Playlist]¶

Получение плейлиста/плейлистов.

Note

Идентификатор плейлиста указывается в формате owner_id:playlist_id. Где playlist_id - идентификатор плейлиста, owner_id - уникальный идентификатор владельца плейлиста.

Данный метод возвращает сокращенную модель плейлиста для отображения больших список.

Warning

Данный метод не возвращает список треков у плейлиста! Для получения объекта yandex_music.Playlist c заполненным полем tracks используйте метод yandex_music.Client.users_playlists() или метод yandex_music.Playlist.fetch_tracks().

Parameters:

playlist_ids (str | int | list из str | list из int) – Уникальный идентификатор плейлиста или плейлистов.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Плейлист или плейлисты.

Return type:

list из yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

podcasts(*args: Any, **kwargs: Any) → LandingList | None¶

Получение подкастов с лендинга.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список подкастов.

Return type:

yandex_music.LandingList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queue(queue_id: str, *args: Any, **kwargs: Any) → Queue | None¶

Получение информации об очереди треков и самих треков в ней.

Parameters:

queue_id (str) – Уникальный идентификатор очереди.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Очередь или None.

Return type:

yandex_music.Queue

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queueCreate(queue: Queue | str, device: str | None = None, *args: Any, **kwargs: Any) → str | None¶: Псевдоним для queue_create

queueUpdatePosition(queue_id: str, current_index: int, device: str | None = None, **kwargs) → bool¶: Псевдоним для queue_update_position

queue_create(queue: Queue | str, device: str | None = None, *args: Any, **kwargs: Any) → str | None¶

Создание новой очереди треков.

Parameters:

queue (yandex_music.Queue | str) – Объект очереди или JSON строка с этим объектом.
device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Вернёт уникальный идентификатор созданной очереди, иначе None.

Return type:

str

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queue_update_position(queue_id: str, current_index: int, device: str | None = None, **kwargs) → bool¶

Установка текущего индекса проигрываемого трека в очереди треков.

Note

Изменить можно только у той очереди, которая была создана с переданного device!

Parameters:

queue_id (str) – Уникальный идентификатор очереди.
current_index (int) – Текущий индекс.
device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queuesList(device: str | None = None, *args: Any, **kwargs: Any) → List[QueueItem]¶: Псевдоним для queues_list

queues_list(device: str | None = None, *args: Any, **kwargs: Any) → List[QueueItem]¶

Получение всех очередей треков с разных устройств для синхронизации между ними.

Note

Именно к device привязывается очередь. На одном устройстве может быть создана одна очередь.

Аргумент device имеет следующий формат: ключ=значение; ключ2=значение2. Обязательные паля указы в значении по умолчанию.

Parameters:

device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Элементы очереди всех устройств.

Return type:

list из yandex_music.QueueItem

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

property request: Request¶

Объект вспомогательного класса для отправки запросов.

Type:: yandex_music.utils.request.Request

rotorAccountStatus(*args: Any, **kwargs: Any) → Status | None¶: Псевдоним для rotor_account_status

rotorStationFeedback(station: str, type_: str, timestamp: str | float | int | None = None, from_: str | None = None, batch_id: str | None = None, total_played_seconds: int | float | None = None, track_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для rotor_station_feedback

rotorStationFeedbackRadioStarted(station: str, from_: str, batch_id: str | None = None, timestamp: str | float | int | None = None, **kwargs: Any) → bool¶: Псевдоним для rotor_station_feedback_radio_started

rotorStationFeedbackSkip(station: str, track_id: str | int, total_played_seconds: float, batch_id: str | None = None, timestamp: str | float | int | None = None, **kwargs: Any) → bool¶: Псевдоним для rotor_station_feedback_skip

rotorStationFeedbackTrackFinished(station: str, track_id: str | int, total_played_seconds: float, batch_id: str | None = None, timestamp: str | float | int | None = None, **kwargs: Any) → bool¶: Псевдоним для rotor_station_feedback_track_finished

rotorStationFeedbackTrackStarted(station: str, track_id: str | int, batch_id: str | None = None, timestamp: str | float | int | None = None, **kwargs: Any) → bool¶: Псевдоним для rotor_station_feedback_track_started

rotorStationInfo(station: str, *args: Any, **kwargs: Any) → List[StationResult]¶: Псевдоним для rotor_station_info

rotorStationSettings2(station: str, mood_energy: str, diversity: str, language: str = 'not-russian', type_: str = 'rotor', **kwargs: Any) → bool¶: Псевдоним для rotor_station_settings2

rotorStationTracks(station: str, settings2: bool = True, queue: str | int | None = None, *args: Any, **kwargs: Any) → StationTracksResult | None¶: Псевдоним для rotor_station_tracks

rotorStationsDashboard(*args: Any, **kwargs: Any) → Dashboard | None¶: Псевдоним для rotor_stations_dashboard

rotorStationsList(language: str | None = None, *args: Any, **kwargs: Any) → List[StationResult]¶: Псевдоним для rotor_stations_list

rotor_account_status(*args: Any, **kwargs: Any) → Status | None¶

Получение статуса пользователя с дополнительными полями.

Note

Данный статус отличается от обычного наличием дополнительных полей, например, skips_per_hour.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Статус пользователя с дополнительными полями от радио или: None.

Return type:

yandex_music.Status | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Отправка обратной связи на действия при прослушивании радио.

Note

Сообщения о начале прослушивания радио, начале и конце трека, его пропуска.

Известные типы обратной связи: radioStarted, trackStarted, trackFinished, skip.

Пример station: user:onyourwave, genre:allrock.

Пример from_: mobile-radio-user-123456789.

Parameters:

station (str) – Станция.
type (str) – Тип отправляемого отзыва.
timestamp (str | float | int, optional) – Текущее время и дата.
from (str, optional) – Откуда начато воспроизведение радио.
batch_id (str, optional) – Уникальный идентификатор партии треков. Возвращается при получении треков.
total_played_seconds (int |float, optional) – Сколько было проиграно секунд трека перед действием.
track_id (int | str, optional) – Уникальной идентификатор трека.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_station_feedback_radio_started(station: str, from_: str, batch_id: str | None = None, timestamp: str | float | int | None = None, **kwargs: Any) → bool¶

Сокращение для:

client.rotor_station_feedback(station, 'radioStarted', timestamp, from, batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Сокращение для:

client.rotor_station_feedback(station, 'skip', timestamp, track_id=track_id,
total_played_seconds=total_played_seconds, batch_id=batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Сокращение для:

client.rotor_station_feedback(station, 'trackFinished', timestamp,
track_id=track_id, total_played_seconds=total_played_seconds, batch_id=batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Сокращение для:

client.rotor_station_feedback(station, 'trackStarted', timestamp, track_id=track_id,
batch_id=batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_station_info(station: str, *args: Any, **kwargs: Any) → List[StationResult]¶

Получение информации о станции и пользовательских настроек на неё.

Parameters:

station (str) – Станция.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация о станции или None.

Return type:

list из yandex_music.StationResult | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_station_settings2(station: str, mood_energy: str, diversity: str, language: str = 'not-russian', type_: str = 'rotor', **kwargs: Any) → bool¶

Изменение настроек определённой станции.

Note

Доступные значения для mood_energy: fun, active, calm, sad, all.

Доступные значения для diversity: favorite, popular, discover, default.

Доступные значения для language: not-russian, russian, any.

Доступные значения для type_: rotor, generative.

У станций в restrictions есть Enum’ы, а в них possible_values - доступные значения для поля.

Parameters:

station (str) – Станция.
mood_energy (str) – Настроение.
diversity (str) – Треки.
language (str) – Язык.
type (str) – Тип.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_station_tracks(station: str, settings2: bool = True, queue: str | int | None = None, *args: Any, **kwargs: Any) → StationTracksResult | None¶

Получение цепочки треков определённой станции.

Note

Запуск потока по сущности сервиса осуществляется через станцию <type>:<id>. Например, станцией для запуска потока по треку будет track:1234.

Для продолжения цепочки треков необходимо:

Передавать ID трека, что был до этого (первый в цепочки).
Отправить фидбек о конце или скипе трека, что был передан в queue.
Отправить фидбек о начале следующего трека (второй в цепочки).
Выполнить запрос получения треков. В ответе придёт новые треки или произойдёт сдвиг цепочки на 1 элемент.

Проход по цепочке до конца не изучен. Часто встречаются дубликаты.

Все официальные клиенты выполняют запросы с settings2 = True.

Parameters:

station (str) – Станция.
settings2 (bool, optional) – Использовать ли второй набор настроек.
queue (str | int, optional) – Уникальной идентификатор трека, который только что был.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Последовательность треков станции или None.

Return type:

yandex_music.StationTracksResult | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_stations_dashboard(*args: Any, **kwargs: Any) → Dashboard | None¶

Получение рекомендованных станций текущего пользователя.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Рекомендованные станции или None.

Return type:

yandex_music.Dashboard | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_stations_list(language: str | None = None, *args: Any, **kwargs: Any) → List[StationResult]¶

Получение всех радиостанций с настройками пользователя.

Note

Доступные языки: en, uz, uk, us, ru, kk, hy.

Чтобы определить что за тип станции (жанры, настроения, занятие и т.д.) необходимо смотреть в поле id_for_from.

Parameters:

language (str, optional) – Язык, на котором будет информация о станциях. По умолчанию язык клиента.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список станций.

Return type:

list из yandex_music.StationResult

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

search(text: str, nocorrect: bool = False, type_: str = 'all', page: int = 0, playlist_in_best: bool = True, *args: Any, **kwargs: Any) → Search | None¶

Осуществление поиска по запросу и типу, получение результатов.

Note

Известные значения для поля type_: all, artist, user, album, playlist, track, podcast, podcast_episode.

При поиске type=all не возвращаются подкасты и эпизоды. Указывайте конкретный тип для поиска.

Parameters:

text (str) – Текст запроса.
nocorrect (bool) – Если False, то ошибочный запрос будет исправлен. Например, запрос “Гражданская абарона” будет исправлен на “Гражданская оборона”.
type (str) – Среди какого типа искать (трек, плейлист, альбом, исполнитель, пользователь, подкаст).
page (int) – Номер страницы.
playlist_in_best (bool) – Выдавать ли плейлисты лучшим вариантом поиска.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Результаты поиска или None.

Return type:

yandex_music.Search | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

searchSuggest(part: str, *args: Any, **kwargs: Any) → Suggestions | None¶: Псевдоним для search_suggest

search_suggest(part: str, *args: Any, **kwargs: Any) → Suggestions | None¶

Получение подсказок по введенной части поискового запроса.

Parameters:

part (str) – Часть поискового запроса.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Подсказки для запроса или None.

Return type:

yandex_music.Suggestions | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

settings(*args: Any, **kwargs: Any) → Settings | None¶

Получение предложений по покупке. Нет обязательных параметров.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информацию о предлагаемых продуктах если аккаунт валиден: или None.

Return type:

yandex_music.Settings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

tags(tag_id: str, *args: Any, **kwargs: Any) → TagResult | None¶

Получение тега (подборки).

Note

Теги есть в MixLink у Landing, а также плейлистов в .tags.

У MixLink есть URL, но tag_id только его последняя часть. Например, /tag/belarus/. Tag - belarus.

Parameters:

tag_id (str) – Уникальный идентификатор тега.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Тег с плейлистами.

Return type:

yandex_music.TagResult

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

trackSupplement(track_id: str | int, *args: Any, **kwargs: Any) → Supplement | None¶: Псевдоним для track_supplement

track_supplement(track_id: str | int, *args: Any, **kwargs: Any) → Supplement | None¶

Получение дополнительной информации о треке.

Warning

Получение текста из дополнительной информации устарело. Используйте yandex_music.Client.tracks_lyrics().

Parameters:

track_id (str | int) – Уникальный идентификатор трека.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Дополнительная информация о треке.

Return type:

yandex_music.Supplement

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Получение трека/треков.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
with_positions (bool, optional) – С позициями TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Трек или Треки.

Return type:

list из yandex_music.Track

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

tracksDownloadInfo(track_id: str | int, get_direct_links: bool = False, *args: Any, **kwargs: Any) → List[DownloadInfo]¶: Псевдоним для tracks_download_info

tracksLyrics(track_id: str | int, format_: str = 'TEXT', **kwargs: Any) → TrackLyrics | None¶: Псевдоним для tracks_lyrics

tracksSimilar(track_id: str | int, *args: Any, **kwargs: Any) → SimilarTracks | None¶: Псевдоним для tracks_similar

tracks_download_info(track_id: str | int, get_direct_links: bool = False, *args: Any, **kwargs: Any) → List[DownloadInfo]¶

Получение информации о доступных вариантах загрузки трека.

Parameters:

track_id (str | list из str) – Уникальный идентификатор трека или треков.
get_direct_links (bool, optional) – Получить ли при вызове метода прямую ссылку на загрузку.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Варианты загрузки трека или None.

Return type:

list из yandex_music.DownloadInfo | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

tracks_lyrics(track_id: str | int, format_: str = 'TEXT', **kwargs: Any) → TrackLyrics | None¶

Получение текста трека.

Note

Для работы с методом необходима авторизация.

Известные значения для аргумента format:

LRC - формат с временными метками.
TEXT - простой текст.

Parameters:

track_id (str | int) – Уникальный идентификатор трека.
format (str) – Формат текста.
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация о тексте трека.

Return type:

yandex_music.TrackLyrics | None

Raises:

yandex_music.exceptions.UnauthorizedError – Метод вызван без авторизации.
yandex_music.exceptions.NotFoundError – Текст у трека отсутствует.
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

tracks_similar(track_id: str | int, *args: Any, **kwargs: Any) → SimilarTracks | None¶

Получение похожих треков.

Parameters:

track_id (str | int) – Уникальный идентификатор трека.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Похожие треки на другой трек.

Return type:

yandex_music.SimilarTracks

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

usersDislikesTracks(user_id: str | int | None = None, if_modified_since_revision: int = 0, *args: Any, **kwargs: Any) → TracksList | None¶: Псевдоним для users_dislikes_tracks

usersDislikesTracksAdd(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для users_dislikes_tracks_add

usersDislikesTracksRemove(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для users_dislikes_tracks_remove

usersLikesAlbums(user_id: str | int | None = None, rich: bool = True, *args: Any, **kwargs: Any) → List[Like]¶: Псевдоним для users_likes_albums

usersLikesAlbumsAdd(album_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для users_likes_albums_add

usersLikesAlbumsRemove(album_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для users_likes_albums_remove

usersLikesArtists(user_id: str | int | None = None, with_timestamps: bool = True, *args: Any, **kwargs: Any) → List[Like]¶: Псевдоним для users_likes_artists

usersLikesArtistsAdd(artist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для users_likes_artists_add

usersLikesArtistsRemove(artist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для users_likes_artists_remove

usersLikesPlaylists(user_id: str | int | None = None, *args: Any, **kwargs: Any) → List[Like]¶: Псевдоним для users_likes_playlists

usersLikesPlaylistsAdd(playlist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для users_likes_playlists_add

usersLikesPlaylistsRemove(playlist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для users_likes_playlists_remove

usersLikesTracks(user_id: str | int | None = None, if_modified_since_revision: int = 0, *args: Any, **kwargs: Any) → TracksList | None¶: Псевдоним для users_likes_tracks

usersLikesTracksAdd(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для users_likes_tracks_add

usersLikesTracksRemove(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶: Псевдоним для users_likes_tracks_remove

usersPlaylists(kind: List[str | int] | str | int, user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | List[Playlist] | None¶: Псевдоним для users_playlists

usersPlaylistsChange(kind: str | int, diff: str, revision: int = 1, user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶: Псевдоним для users_playlists_change

usersPlaylistsCreate(title: str, visibility: str = 'public', user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶: Псевдоним для users_playlists_create

usersPlaylistsDelete(kind: str | int, user_id: str | int | None = None, *args: Any, **kwargs: Any) → bool¶: Псевдоним для users_playlists_delete

usersPlaylistsDeleteTrack(kind: str | int, from_: int, to: int, revision: int = 1, user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶: Псевдоним для users_playlists_delete_track

usersPlaylistsInsertTrack(kind: str | int, track_id: str | int, album_id: str | int, at: int = 0, revision: int = 1, user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶: Псевдоним для users_playlists_insert_track

usersPlaylistsList(user_id: str | int | None = None, *args: Any, **kwargs: Any) → List[Playlist]¶: Псевдоним для users_playlists_list

usersPlaylistsName(kind: str | int, name: str, user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶: Псевдоним для users_playlists_name

usersPlaylistsRecommendations(kind: str | int, user_id: str | int | None = None, *args: Any, **kwargs: Any) → PlaylistRecommendations | None¶: Псевдоним для users_playlists_recommendations

usersPlaylistsVisibility(kind: str | int, visibility: str, user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶: Псевдоним для users_playlists_visibility

usersSettings(user_id: str | int | None = None, *args: Any, **kwargs: Any) → UserSettings | None¶: Псевдоним для users_settings

users_dislikes_tracks(user_id: str | int | None = None, if_modified_since_revision: int = 0, *args: Any, **kwargs: Any) → TracksList | None¶

Получение треков с отметкой “Не рекомендовать”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
if_modified_since_revision (bool, optional) – TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Треки с отметкой “Не рекомендовать”.

Return type:

list из yandex_music.TracksList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_dislikes_tracks_add(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶

Поставить отметку “Не рекомендовать” треку/трекам.

Note

Так же снимает отметку “Мне нравится” если она есть.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_dislikes_tracks_remove(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶

Снять отметку “Не рекомендовать” у трека/треков.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_albums(user_id: str | int | None = None, rich: bool = True, *args: Any, **kwargs: Any) → List[Like]¶

Получение альбомов с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
rich (bool, optional) – Если False, то приходит укороченная версия.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Альбомы с отметкой “Мне нравится”.

Return type:

list из yandex_music.Like

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_albums_add(album_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶

Поставить отметку “Мне нравится” альбому/альбомам.

Parameters:

album_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_albums_remove(album_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶

Снять отметку “Мне нравится” у альбома/альбомов.

Parameters:

album_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_artists(user_id: str | int | None = None, with_timestamps: bool = True, *args: Any, **kwargs: Any) → List[Like]¶

Получение артистов с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
with_timestamps (bool, optional) – С временными метками TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Артисты с отметкой “Мне нравится”.

Return type:

list из yandex_music.Like

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_artists_add(artist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶

Поставить отметку “Мне нравится” исполнителю/исполнителям.

Parameters:

artist_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_artists_remove(artist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶

Снять отметку “Мне нравится” у исполнителя/исполнителей.

Parameters:

artist_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_playlists(user_id: str | int | None = None, *args: Any, **kwargs: Any) → List[Like]¶

Получение плейлистов с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Плейлисты с отметкой “Мне нравится”.

Return type:

list из yandex_music.Like

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_playlists_add(playlist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶

Поставить отметку “Мне нравится” плейлисту/плейлистам.

Note

Parameters:

playlist_ids (str | int | list из str | list из int) – Уникальный идентификатор плейлиста или плейлистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_playlists_remove(playlist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶

Снять отметку “Мне нравится” у плейлиста/плейлистов.

Note

Parameters:

playlist_ids (str | int | list из str | list из int) – Уникальный идентификатор плейлиста или плейлистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_tracks(user_id: str | int | None = None, if_modified_since_revision: int = 0, *args: Any, **kwargs: Any) → TracksList | None¶

Получение треков с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
if_modified_since_revision (int, optional) – TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Треки с отметкой “Мне нравится”.

Return type:

yandex_music.TracksList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_tracks_add(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶

Поставить отметку “Мне нравится” треку/трекам.

Note

Так же снимает отметку “Не рекомендовать” если она есть.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_tracks_remove(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) → bool¶

Снять отметку “Мне нравится” у трека/треков.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Получение плейлиста или списка плейлистов по уникальным идентификаторам.

Note

Если передан один kind, то вернётся не список плейлистов, а один плейлист.

Parameters:

kind (str | int | list из str | int) – Уникальный идентификатор плейлиста или их список.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список плейлистов или плейлист, иначе None.

Return type:

list из yandex_music.Playlist | yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_change(kind: str | int, diff: str, revision: int = 1, user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶

Изменение плейлиста.

Note

Для получения отличий есть вспомогательный класс yandex_music.utils.difference.Difference.

Так же существуют уже готовые методы-обёртки над операциями.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
revision (int) – TODO.
diff (str) – JSON представления отличий старого и нового плейлиста.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_create(title: str, visibility: str = 'public', user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶

Создание плейлиста.

Parameters:

title (str) – Название.
visibility (str, optional) – Модификатор доступа.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Созданный плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_delete(kind: str | int, user_id: str | int | None = None, *args: Any, **kwargs: Any) → bool¶

Удаление плейлиста.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_delete_track(kind: str | int, from_: int, to: int, revision: int = 1, user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶

Удаление треков из плейлиста.

Note

Для удаление необходимо указать границы с какого по какой элемент (трек) удалить.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
from (int) – С какого индекса.
to (int) – По какой индекс.
revision (int) – TODO.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Добавление трека в плейлист.

Note

Трек можно вставить с любое место плейлиста задав индекс вставки (аргумент at).

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
track_id (str | int) – Уникальный идентификатор трека.
album_id (str | int) – Уникальный идентификатор альбома.
at (int) – Индекс для вставки.
revision (int) – TODO.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_list(user_id: str | int | None = None, *args: Any, **kwargs: Any) → List[Playlist]¶

Получение списка плейлистов пользователя.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Плейлисты пользователя.

Return type:

list из yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_name(kind: str | int, name: str, user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶

Изменение названия плейлиста.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
name (str) – Новое название.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_recommendations(kind: str | int, user_id: str | int | None = None, *args: Any, **kwargs: Any) → PlaylistRecommendations | None¶

Получение рекомендаций для плейлиста.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
user_id (str | int) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Рекомендации для плейлиста или None.

Return type:

yandex_music.PlaylistRecommendations | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_visibility(kind: str | int, visibility: str, user_id: str | int | None = None, *args: Any, **kwargs: Any) → Playlist | None¶

Изменение видимости плейлиста.

Note

Видимость (visibility) может быть задана только одним из двух значений: private, public.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
visibility (str) – Новое название.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_settings(user_id: str | int | None = None, *args: Any, **kwargs: Any) → UserSettings | None¶

Получение настроек пользователя.

Note

Для получения настроек пользователя нужно быть авторизованным или владеть user_id.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя чьи настройки хотим получить.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Настройки пользователя или None.

Return type:

yandex_music.UserSettings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

yandex_music.client.log(method: F) → F¶