跳转至

TopApi

modules.top.TopApi 

TopApi(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_category 

get_category() -> CgiRequestData

获取所有排行榜分类.

Source code in qqmusic_api/modules/top.py 
13
14
15
16
17
18
19
20
21
@cgi_endpoint(
    key="top.get_category",
    module="music.musicToplist.Toplist",
    method="GetAll",
    response_model=TopCategoryResponse,
)
def get_category(self) -> CgiRequestData:
    """获取所有排行榜分类."""
    return CgiRequestData()

get_detail 

get_detail(
    top_id: int,
    num: int = 10,
    page: int = 1,
    *,
    tag: bool = True,
) -> CgiRequestData

获取排行榜详情及其歌曲列表.

PARAMETER DESCRIPTION
top_id

排行榜 ID.

TYPE: int

num

返回歌曲数量.

TYPE: int DEFAULT: 10

page

页码.

TYPE: int DEFAULT: 1

tag

是否返回歌曲标签信息.

TYPE: bool DEFAULT: True

Source code in qqmusic_api/modules/top.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@cgi_endpoint(
    key="top.get_detail",
    module="music.musicToplist.Toplist",
    method="GetDetail",
    response_model=TopDetailResponse,
    item_type=Song,
)
def get_detail(
    self,
    top_id: int,
    num: int = 10,
    page: int = 1,
    *,
    tag: bool = True,
) -> CgiRequestData:
    """获取排行榜详情及其歌曲列表.

    Args:
        top_id: 排行榜 ID.
        num: 返回歌曲数量.
        page: 页码.
        tag: 是否返回歌曲标签信息.
    """
    param = {
        "topId": top_id,
        "offset": num * (page - 1),
        "num": num,
    }
    if tag:
        param["withTags"] = True

    return CgiRequestData(
        param=param,
        preserve_bool=tag,
        pager_strategy=OffsetStrategy[TopDetailResponse](
            offset_key="offset",
            page_size_key="num",
            total_extractor=lambda r: r.info.total_num,
            count_extractor=lambda r: len(r.songs),
        ),
        items_extractor=lambda r: r.songs,
    )