跳转至

AlbumApi

modules.album.AlbumApi 

AlbumApi(executor: RequestExecutor)

Bases: ApiModule

专辑相关 API.

Source code in qqmusic_api/modules/_base.py 
33
34
35
36
37
38
def __init__(self, executor: RequestExecutor) -> None:
    """绑定请求执行器."""
    from ..core.client import Client

    self._executor = executor
    self._client = executor if isinstance(executor, Client) else None

get_detail 

get_detail(value: int | str) -> CgiRequestData

获取专辑详细信息.

PARAMETER DESCRIPTION
value

专辑 ID 或 MID.

TYPE: int | str

Source code in qqmusic_api/modules/album.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@cgi_endpoint(
    key="album.get_detail",
    module="music.musichallAlbum.AlbumInfoServer",
    method="GetAlbumDetail",
    response_model=GetAlbumDetailResponse,
)
def get_detail(self, value: int | str) -> CgiRequestData:
    """获取专辑详细信息.

    Args:
        value: 专辑 ID 或 MID.
    """
    param: dict[str, Any] = {}
    if isinstance(value, int) or (isinstance(value, str) and value.isdecimal()):
        param["albumId"] = int(value)
    else:
        param["albumMId"] = value

    return CgiRequestData(param=param)

get_song 

get_song(
    value: int | str, num: int = 10, page: int = 1
) -> CgiRequestData

获取专辑歌曲列表.

PARAMETER DESCRIPTION
value

专辑 ID 或 MID.

TYPE: int | str

num

返回结果数量.

TYPE: int DEFAULT: 10

page

页码.

TYPE: int DEFAULT: 1

Source code in qqmusic_api/modules/album.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@cgi_endpoint(
    key="album.get_song",
    module="music.musichallAlbum.AlbumSongList",
    method="GetAlbumSongList",
    response_model=GetAlbumSongResponse,
    item_type=Song,
)
def get_song(self, value: int | str, num: int = 10, page: int = 1) -> CgiRequestData:
    """获取专辑歌曲列表.

    Args:
        value: 专辑 ID 或 MID.
        num: 返回结果数量.
        page: 页码.
    """
    param: dict[str, Any] = {
        "begin": num * (page - 1),
        "num": num,
    }
    if isinstance(value, int) or (isinstance(value, str) and value.isdecimal()):
        param["albumId"] = int(value)
    else:
        param["albumMid"] = value

    return CgiRequestData(
        param=param,
        pager_strategy=OffsetStrategy[GetAlbumSongResponse](
            offset_key="begin",
            page_size_key="num",
            total_extractor=lambda r: r.total_num,
            count_extractor=lambda r: len(r.song_list),
        ),
        items_extractor=lambda r: r.song_list,
    )

get_new_album 

get_new_album(
    area: int = 1, num: int = 20, page: int = 1
) -> CgiRequestData

获取新碟上架列表.

PARAMETER DESCRIPTION
area

地区. 1=内地, 2=港台, 3=欧美, 4=韩国, 5=日本, 6=其他.

TYPE: int DEFAULT: 1

num

每页返回的专辑数量.

TYPE: int DEFAULT: 20

page

页码, 从 1 开始.

TYPE: int DEFAULT: 1

Source code in qqmusic_api/modules/album.py 
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
@cgi_endpoint(
    key="album.get_new_album",
    module="newalbum.NewAlbumServer",
    method="get_new_album_info",
    response_model=GetNewAlbumResponse,
    item_type=NewAlbumItem,
)
def get_new_album(self, area: int = 1, num: int = 20, page: int = 1) -> CgiRequestData:
    """获取新碟上架列表.

    Args:
        area: 地区. 1=内地, 2=港台, 3=欧美, 4=韩国, 5=日本, 6=其他.
        num: 每页返回的专辑数量.
        page: 页码, 从 1 开始.
    """
    return CgiRequestData(
        param={"area": area, "num": num, "start": num * (page - 1)},
        pager_strategy=OffsetStrategy[GetNewAlbumResponse](
            offset_key="start",
            page_size_key="num",
            total_extractor=lambda r: r.total,
            count_extractor=lambda r: len(r.albums),
        ),
        items_extractor=lambda r: r.albums,
    )

fav_album 

fav_album(
    album_id: int | list[int],
    *,
    credential: Credential | None = None,
) -> CgiRequestData

收藏专辑到当前登录用户.

PARAMETER DESCRIPTION
album_id

专辑 ID, 支持单个或列表.

TYPE: int | list[int]

credential

登录凭证.

TYPE: Credential | None DEFAULT: None

Source code in qqmusic_api/modules/album.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
@cgi_endpoint(
    key="album.fav_album",
    module="music.musicasset.AlbumFavWrite",
    method="FavAlbum",
    response_model=AlbumFavWriteResponse,
    require_login=True,
)
def fav_album(self, album_id: int | list[int], *, credential: Credential | None = None) -> CgiRequestData:
    """收藏专辑到当前登录用户.

    Args:
        album_id: 专辑 ID, 支持单个或列表.
        credential: 登录凭证.
    """
    ids = [album_id] if isinstance(album_id, int) else album_id
    return CgiRequestData(
        param={"v_albumId": ids},
        credential=credential,
    )

del_fav_album 

del_fav_album(
    album_id: int | list[int],
    *,
    credential: Credential | None = None,
) -> CgiRequestData

取消收藏专辑.

PARAMETER DESCRIPTION
album_id

专辑 ID, 支持单个或列表.

TYPE: int | list[int]

credential

登录凭证.

TYPE: Credential | None DEFAULT: None

Source code in qqmusic_api/modules/album.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
@cgi_endpoint(
    key="album.del_fav_album",
    module="music.musicasset.AlbumFavWrite",
    method="CancelFavAlbum",
    response_model=AlbumFavWriteResponse,
    require_login=True,
)
def del_fav_album(self, album_id: int | list[int], *, credential: Credential | None = None) -> CgiRequestData:
    """取消收藏专辑.

    Args:
        album_id: 专辑 ID, 支持单个或列表.
        credential: 登录凭证.
    """
    ids = [album_id] if isinstance(album_id, int) else album_id
    return CgiRequestData(
        param={"v_albumId": ids},
        credential=credential,
    )