SearchApi
modules.search.SearchApi
Bases: ApiModule
搜索相关 API.
Source code in qqmusic_api/modules/_base.py
get_hotkey
获取热搜词列表.
| RETURNS | DESCRIPTION |
|---|---|
CgiRequest[HotkeyResponse]
|
CgiRequest[HotkeyResponse]: 热搜词列表请求描述符. |
Source code in qqmusic_api/modules/search.py
complete
complete(keyword: str) -> CgiRequest[CompleteResponse]
搜索词补全建议.
| PARAMETER | DESCRIPTION |
|---|---|
keyword
|
关键词.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
CgiRequest[CompleteResponse]
|
CgiRequest[CompleteResponse]: 补全建议请求描述符. |
Source code in qqmusic_api/modules/search.py
quick_search
quick_search(
keyword: str,
) -> HttpRequest[QuickSearchResponse]
快速搜索.
| PARAMETER | DESCRIPTION |
|---|---|
keyword
|
关键词.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
HttpRequest[QuickSearchResponse]
|
HttpRequest[QuickSearchResponse]: 快速搜索结果请求描述符. |
Source code in qqmusic_api/modules/search.py
general_search
general_search(
keyword: str,
page: int = 1,
num: int = 15,
searchid: str | None = None,
page_start: dict[str, Any] | None = None,
*,
highlight: bool = True,
)
综合搜索.
| PARAMETER | DESCRIPTION |
|---|---|
keyword
|
关键词.
TYPE:
|
page
|
页码.
TYPE:
|
num
|
每页返回数量.
TYPE:
|
searchid
|
搜索会话 ID.
TYPE:
|
page_start
|
上一页分页游标对象. |
highlight
|
是否高亮关键词.
TYPE:
|
Source code in qqmusic_api/modules/search.py
search_by_type
search_by_type(
keyword: str,
search_type: Literal[
SONG, 0, LYRIC, 7, AUDIO, 18, RINGTONE, 10
] = SONG,
num: int = 10,
page: int = 1,
selectors: list[SearchSelector] | None = None,
searchid: str | None = None,
*,
highlight: bool = True,
) -> ItemPaginatedCgiRequest[
SearchByTypeResponse, SongSearch
]
search_by_type(
keyword: str,
search_type: Literal[SINGER, 1],
num: int = 10,
page: int = 1,
selectors: list[SearchSelector] | None = None,
searchid: str | None = None,
*,
highlight: bool = True,
) -> ItemPaginatedCgiRequest[
SearchByTypeResponse, SingerSearch
]
search_by_type(
keyword: str,
search_type: Literal[ALBUM, 2, AUDIO_ALBUM, 15],
num: int = 10,
page: int = 1,
selectors: list[SearchSelector] | None = None,
searchid: str | None = None,
*,
highlight: bool = True,
) -> ItemPaginatedCgiRequest[
SearchByTypeResponse, AlbumSearch
]
search_by_type(
keyword: str,
search_type: Literal[SONGLIST, 3],
num: int = 10,
page: int = 1,
selectors: list[SearchSelector] | None = None,
searchid: str | None = None,
*,
highlight: bool = True,
) -> ItemPaginatedCgiRequest[
SearchByTypeResponse, SongListSearch
]
search_by_type(
keyword: str,
search_type: int | SearchType = SONG,
num: int = 10,
page: int = 1,
selectors: list[SearchSelector] | None = None,
searchid: str | None = None,
*,
highlight: bool = True,
)
类型搜索.
固定使用 Android 平台.
| PARAMETER | DESCRIPTION |
|---|---|
keyword
|
关键词.
TYPE:
|
search_type
|
搜索类型.
TYPE:
|
num
|
返回结果数量.
TYPE:
|
page
|
页码.
TYPE:
|
selectors
|
搜索筛选器列表.
TYPE:
|
searchid
|
搜索会话 ID.
TYPE:
|
highlight
|
是否高亮关键词.
TYPE:
|