QQ Music API

https://jsososo.github.io/QQMusicApi/
Admin
A Node.js API for QQ Music, built with Express and Axios, providing comprehensive access to music...
Tokens:15,068
Snippets:67
Trust Score:8.3
Update:9 months ago
Show doc for...
Tokens:
Raw
### Start Project

Source: https://jsososo.github.io/QQMusicApi/index

Steps to clone the repository, install dependencies, and start the QQ Music API server.

```APIDOC
## Start

Clone the repository:
```bash
$ git clone git@github.com:jsososo/QQMusicApi.git
```

Install dependencies:
```bash
$ npm install
```

Start the server:
```bash
$ npm start
```

The project defaults to port 3300 and QQ number 1234567. You can customize these by modifying `bin/config.js` or using environment variables like `PORT=3400 QQ=7654321 npm start`.
```

--------------------------------

### Clone and Start QQ Music API Project

Source: https://jsososo.github.io/QQMusicApi/index

Provides instructions for cloning the QQMusicApi project from GitHub, installing its dependencies using npm, and starting the server. It also mentions how to configure the port and QQ number via environment variables or config files.

```bash
$ git clone git@github.com:jsososo/QQMusicApi.git

$ npm install

$ npm start
```

--------------------------------

### QQ Music API - Get Vkey and GUID

Source: https://jsososo.github.io/QQMusicApi/index

Illustrates how to obtain the vkey and guid, which are crucial for constructing music playback URLs. This snippet shows the structure of the response data containing these essential parameters and the domain for streaming.

```json
{
  "data": {
    "vkey": "78159670DE0BF35ABEF86841070FDA6818BC95FB25E5C983547E9D29C9803D30971A3500E2D85D5204848BDC4E3E130BE9FCC63EB73F0F47",
    "guid": "5339940689",
    "domain": "http://ws.stream.qqmusic.qq.com/"
  },
  "result": 100,
  "success": true
}
```

--------------------------------

### GET /new/mv

Source: https://jsososo.github.io/QQMusicApi/index

Get new MV recommendations by type. Defaults to featured.

```APIDOC
## GET /new/mv

### Description
Retrieves recommendations for new music videos (MVs). The `type` parameter allows filtering by featured MVs or MVs from specific regions.

### Method
GET

### Endpoint
/new/mv

### Parameters
#### Query Parameters
- **type** (integer) - Optional - The type of MV recommendations. Defaults to 0 (Featured). Other options: 1 (Mainland China), 2 (Hong Kong & Taiwan), 3 (Europe & America), 4 (Korea), 5 (Japan).

### Request Example
```
GET /new/mv?type=1
```

### Response
#### Success Response (200)
- **mvs** (array) - A list of new MVs.
  - **name** (string) - The name of the MV.
  - **artist** (string) - The artist featured in the MV.
  - **vid** (string) - The video ID of the MV.
  - **coverUrl** (string) - The URL of the MV cover image.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "mvs": [
    {
      "name": "New MV Title",
      "artist": "Featured Artist",
      "vid": "mv12345",
      "coverUrl": "http://example.com/mv_cover.jpg"
    }
  ]
}
```
```

--------------------------------

### Install and Use QQ Music API (NodeJS)

Source: https://jsososo.github.io/QQMusicApi/index

Demonstrates how to install the 'qq-music-api' package using Yarn and how to use its functions to set cookies, search for songs, and retrieve hot search terms. It also shows how to handle API responses and errors.

```bash
yarn add qq-music-api
```

```javascript
const qqMusic = require('qq-music-api');

// Set user cookie (string or object)qqMusic.setCookie('xxx=xxx; xxx=xxx;');
// orqqMusic.setCookie({ a: 'xxx', b: 'xxx' });

// Search for a songqqMusic.api('search', { key: '周杰伦' })
    .then(res => console.log(res))
    .catch(err => console.log('接口调用出错'))

// Get hot search termsqqMusic.api('search/hot')
    .then((res) => console.log('热搜词：', res))
    .catch(err => console.log('接口调用出错'))

// Refresh loginqqMusic.api('user/refresh')
```

--------------------------------

### GET /album

Source: https://jsososo.github.io/QQMusicApi/index

Get information about a specific album. Requires `albummid`.

```APIDOC
## GET /album

### Description
Retrieves detailed information about a specific album using its unique media ID (`albummid`).

### Method
GET

### Endpoint
/album

### Parameters
#### Query Parameters
- **albummid** (string) - Required - The unique media ID of the album.

### Request Example
```
GET /album?albummid=002MAeob3zLXwZ
```

### Response
#### Success Response (200)
- **albumInfo** (object) - Contains details about the album.
  - **name** (string) - The name of the album.
  - **artist** (string) - The artist of the album.
  - **releaseDate** (string) - The release date of the album.
  - **coverUrl** (string) - The URL of the album cover.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "albumInfo": {
    "name": "Album Title",
    "artist": "Artist Name",
    "releaseDate": "2023-01-15",
    "coverUrl": "http://example.com/album_cover.jpg"
  }
}
```
```

--------------------------------

### GET /recommend/banner

Source: https://jsososo.github.io/QQMusicApi/index

Get banner recommendations, currently returns album recommendations with albumid.

```APIDOC
## GET /recommend/banner

### Description
Fetches banner recommendations, which currently provide album recommendations. The response includes the `albumid`.

### Method
GET

### Endpoint
/recommend/banner

### Parameters
None

### Request Example
```
GET /recommend/banner
```

### Response
#### Success Response (200)
- **banners** (array) - A list of banner recommendations.
  - **albumid** (string) - The ID of the recommended album.
  - **imageUrl** (string) - The URL of the banner image.
  - **targetUrl** (string) - The URL to navigate to when the banner is clicked.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "banners": [
    {
      "albumid": "002MAeob3zLXwZ",
      "imageUrl": "http://example.com/banner.jpg",
      "targetUrl": "http://example.com/album/002MAeob3zLXwZ"
    }
  ]
}
```
```

--------------------------------

### NPM Usage

Source: https://jsososo.github.io/QQMusicApi/index

Instructions on how to install and use the qq-music-api package in your Node.js project.

```APIDOC
## NPM Usage

Install the package using yarn:
```
yarn add qq-music-api
```

Import and use the library in your project:
```javascript
const qqMusic = require('qq-music-api');

// Set user cookie (string or object)
qqMusic.setCookie('xxx=xxx; xxx=xxx;');
// or
qqMusic.setCookie({ a: 'xxx', b: 'xxx' });

// Example: Search for a song
qqMusic.api('search', { key: '周杰伦' })
    .then(res => console.log(res))
    .catch(err => console.log('API call failed'));

// Example: Get hot search terms
qqMusic.api('search/hot')
    .then((res) => console.log('Hot search terms:', res))
    .catch(err => console.log('API call failed'));

// Example: Refresh login status
qqMusic.api('user/refresh');
```
```

--------------------------------

### GET /recommend/daily

Source: https://jsososo.github.io/QQMusicApi/index

Get daily recommended songs. Requires user login via Cookie.

```APIDOC
## GET /recommend/daily

### Description
Retrieves a list of songs recommended daily for the logged-in user. This endpoint requires authentication via the user's Cookie.

### Method
GET

### Endpoint
/recommend/daily

### Parameters
None (Requires authentication via Cookie)

### Request Example
```
GET /recommend/daily
```

### Response
#### Success Response (200)
- **songs** (array) - A list of daily recommended songs.
  - **name** (string) - The name of the song.
  - **singer** (string) - The artist of the song.
  - **album** (string) - The album the song belongs to.
  - **mid** (string) - The media ID of the song.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "songs": [
    {
      "name": "Daily Tune",
      "singer": "Artist Name",
      "album": "Album Title",
      "mid": "abcdef12345"
    }
  ]
}
```
```

--------------------------------

### GET /singer/album

Source: https://jsososo.github.io/QQMusicApi/index

Get albums by a singer. Requires `singermid`.

```APIDOC
## GET /singer/album

### Description
Retrieves a list of albums released by a specific singer. Supports pagination to fetch albums in batches.

### Method
GET

### Endpoint
/singer/album

### Parameters
#### Query Parameters
- **singermid** (string) - Required - The unique media ID of the singer.
- **pageNo** (integer) - Optional - The page number for pagination. Defaults to 1.
- **pageSize** (integer) - Optional - The number of albums per page. Defaults to 20.

### Request Example
```
GET /singer/album?singermid=0025NhlN2yWrP4&pageNo=3&pageSize=10
```

### Response
#### Success Response (200)
- **albums** (array) - A list of albums by the singer.
  - **name** (string) - The name of the album.
  - **mid** (string) - The media ID of the album.
  - **releaseDate** (string) - The release date of the album.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "albums": [
    {
      "name": "Album Title",
      "mid": "albummid456",
      "releaseDate": "2022-05-15"
    }
  ]
}
```
```

--------------------------------

### GET /new/album

Source: https://jsososo.github.io/QQMusicApi/index

Get new album recommendations by region. Defaults to Mainland China.

```APIDOC
## GET /new/album

### Description
Fetches recommendations for new albums, categorized by region. The `type` parameter specifies the region, and `num` controls the number of albums returned.

### Method
GET

### Endpoint
/new/album

### Parameters
#### Query Parameters
- **type** (integer) - Optional - The region category for new albums. Defaults to 1 (Mainland China). Other options: 2 (Hong Kong & Taiwan), 3 (Europe & America), 4 (Korea), 5 (Japan), 6 (Other).
- **num** (integer) - Optional - The number of albums to return. Defaults to 10.

### Request Example
```
GET /new/album?type=4&num=5
```

### Response
#### Success Response (200)
- **albums** (array) - A list of new albums.
  - **name** (string) - The name of the album.
  - **artist** (string) - The artist of the album.
  - **mid** (string) - The media ID of the album.
  - **releaseDate** (string) - The release date of the album.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "albums": [
    {
      "name": "New Album Title",
      "artist": "New Artist Name",
      "mid": "newalbummid123",
      "releaseDate": "2023-10-27"
    }
  ]
}
```
```

--------------------------------

### GET /singer/mv

Source: https://jsososo.github.io/QQMusicApi/index

Get music videos (MVs) by a singer. Requires `singermid`.

```APIDOC
## GET /singer/mv

### Description
Retrieves a list of music videos (MVs) by a specific singer. Supports pagination to fetch MVs in batches.

### Method
GET

### Endpoint
/singer/mv

### Parameters
#### Query Parameters
- **singermid** (string) - Required - The unique media ID of the singer.
- **pageNo** (integer) - Optional - The page number for pagination. Defaults to 1.
- **pageSize** (integer) - Optional - The number of MVs per page. Defaults to 20.

### Request Example
```
GET /singer/mv?singermid=0025NhlN2yWrP4&pageNo=2&pageSize=15
```

### Response
#### Success Response (200)
- **mvs** (array) - A list of MVs by the singer.
  - **name** (string) - The name of the MV.
  - **vid** (string) - The video ID of the MV.
  - **coverUrl** (string) - The URL of the MV cover image.
  - **releaseDate** (string) - The release date of the MV.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "mvs": [
    {
      "name": "Singer's MV",
      "vid": "mv7890",
      "coverUrl": "http://example.com/singer_mv.jpg",
      "releaseDate": "2021-11-01"
    }
  ]
}
```
```

--------------------------------

### GET /singer/sim

Source: https://jsososo.github.io/QQMusicApi/index

Get similar singers to a given singer. Requires `singermid`.

```APIDOC
## GET /singer/sim

### Description
Finds and returns a list of singers similar to a given singer. The API is designed to return a maximum of 10 similar singers.

### Method
GET

### Endpoint
/singer/sim

### Parameters
#### Query Parameters
- **singermid** (string) - Required - The unique media ID of the singer for whom to find similar artists.

### Request Example
```
GET /singer/sim?singermid=0025NhlN2yWrP4
```

### Response
#### Success Response (200)
- **singers** (array) - A list of similar singers.
  - **name** (string) - The name of the similar singer.
  - **singermid** (string) - The media ID of the similar singer.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "singers": [
    {
      "name": "Similar Artist 1",
      "singermid": "simartist1mid"
    },
    {
      "name": "Similar Artist 2",
      "singermid": "simartist2mid"
    }
  ]
}
```
```

--------------------------------

### GET /new/songs

Source: https://jsososo.github.io/QQMusicApi/index

Get new songs recommendations based on region. Defaults to latest.

```APIDOC
## GET /new/songs

### Description
Retrieves recommendations for new songs, categorized by region. The `type` parameter allows filtering by specific regions or selecting the latest releases.

### Method
GET

### Endpoint
/new/songs

### Parameters
#### Query Parameters
- **type** (integer) - Optional - The region category for new songs. Defaults to 0 (Latest). Other options: 1 (Mainland China), 2 (Hong Kong & Taiwan), 3 (Europe & America), 4 (Korea), 5 (Japan).

### Request Example
```
GET /new/songs?type=3
```

### Response
#### Success Response (200)
- **songs** (array) - A list of new songs.
  - **name** (string) - The name of the song.
  - **singer** (string) - The artist of the song.
  - **album** (string) - The album the song belongs to.
  - **mid** (string) - The media ID of the song.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "songs": [
    {
      "name": "New Hit",
      "singer": "New Artist",
      "album": "Debut Album",
      "mid": "newabc123"
    }
  ]
}
```
```

--------------------------------

### GET /recommend/playlist

Source: https://jsososo.github.io/QQMusicApi/index

Get recommended playlists based on category. Supports pagination and defaults to official playlists.

```APIDOC
## GET /recommend/playlist

### Description
Retrieves recommended playlists based on a specified category ID. Supports pagination to fetch results in batches.

### Method
GET

### Endpoint
/recommend/playlist

### Parameters
#### Query Parameters
- **id** (integer) - Optional - The category ID for recommendations. Defaults to 3317 (Official Playlists). Other examples: 59 (Classic), 71 (Love Songs), 3056 (Online Songs), 64 (KTV Hot Songs).
- **pageNo** (integer) - Optional - The page number for pagination. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items per page. Defaults to 20.

### Request Example
```
GET /recommend/playlist?id=59&pageNo=2&pageSize=10
```

### Response
#### Success Response (200)
- **data** (object) - Contains playlist information.
  - **v_playlist** (array) - List of recommended playlists.
    - **title** (string) - The title of the playlist.
    - **picurl** (string) - The cover image URL of the playlist.
    - **disscount** (integer) - The number of songs in the playlist.
    - **creator** (object) - Information about the playlist creator.
      - **nickname** (string) - The creator's nickname.
      - **avatarUrl** (string) - The creator's avatar URL.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "data": {
    "v_playlist": [
      {
        "title": "经典老歌",
        "picurl": "http://example.com/cover.jpg",
        "disscount": 100,
        "creator": {
          "nickname": "Music Lover",
          "avatarUrl": "http://example.com/avatar.jpg"
        }
      }
    ]
  }
}
```
```

--------------------------------

### GET /singer/desc

Source: https://jsososo.github.io/QQMusicApi/index

Get detailed information about a singer. Requires `singermid`.

```APIDOC
## GET /singer/desc

### Description
Retrieves detailed biographical and descriptive information about a specific singer. Requires the singer's unique media ID (`singermid`).

### Method
GET

### Endpoint
/singer/desc

### Parameters
#### Query Parameters
- **singermid** (string) - Required - The unique media ID of the singer.

### Request Example
```
GET /singer/desc?singermid=0025NhlN2yWrP4
```

### Response
#### Success Response (200)
- **singerInfo** (object) - Contains detailed information about the singer.
  - **name** (string) - The name of the singer.
  - **intro** (string) - A detailed introduction to the singer.
  - **birthplace** (string) - The birthplace of the singer.
  - **company** (string) - The record label or company the singer is associated with.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "singerInfo": {
    "name": "Example Singer",
    "intro": "A renowned artist known for their soulful voice...",
    "birthplace": "City, Country",
    "company": "Record Label Inc."
  }
}
```
```

--------------------------------

### Get Recommended Playlists

Source: https://jsososo.github.io/QQMusicApi/index

Provides a list of playlists recommended for the user. This endpoint does not require any parameters.

```APIDOC
## GET /recommend/playlist/u

### Description
Returns a list of playlists recommended specifically for the current user. This endpoint does not require any input parameters.

### Method
GET

### Endpoint
`/recommend/playlist/u`

### Parameters
(No parameters required)

### Request Example
```
/recommend/playlist/u
```

### Response
#### Success Response (200)
- Returns a list of recommended playlists. The data format differs from other playlist endpoints.

#### Response Example
(Response structure not explicitly defined, but contains recommended playlist data.)
```

--------------------------------

### vkey & guid Acquisition (Deprecated)

Source: https://jsososo.github.io/QQMusicApi/index

Information about obtaining vkey and guid, which were previously used for constructing music playback links. This method is now deprecated.

```APIDOC
## vkey & guid Acquisition (Deprecated)

This endpoint was used to obtain `vkey` and `guid`, essential components for constructing music playback URLs. However, due to changes in QQ Music's API for obtaining playback links, this specific interface is no longer functional.

### Endpoint
`/vkey`

### Response Example (Deprecated)
```json
{
  "data": {
    "vkey": "78159670DE0BF35ABEF86841070FDA6818BC95FB25E5C983547E9D29C9803D30971A3500E2D85D5204848BDC4E3E130BE9FCC63EB73F0F47",
    "guid": "5339940689",
    "domain": "http://ws.stream.qqmusic.qq.com/"
  },
  "result": 100,
  "success": true
}
```

**Note:** For current methods of obtaining music playback links, please refer to the updated API documentation.
```

--------------------------------

### Music Playback URL Construction

Source: https://jsososo.github.io/QQMusicApi/index

Details on how to construct music playback URLs using format information, vkey, guid, and media identifiers.

```APIDOC
## Music Playback URL Construction

This section explains how to construct playback URLs for different audio formats using the `vkey`, `guid`, and `strMediaMid`.

### Format Map
```javascript
const formatMap = {
  size128: {
    val: '128k',
    s: 'M500',
    e: '.mp3',
    content: 'audio/mpeg',
  },
  size320: {
    val: '320k',
    s: 'M800',
    e: '.mp3',
    content: 'audio/mpeg',
  },
  sizeape: {
    val: '无损ape',
    s: 'A000',
    e: '.ape',
    content: 'audio/ape',
  },
  sizeflac: {
    val: '无损flac',
    s: 'F000',
    e: '.flac',
    content: 'audio/x-flac',
  }
};
```

### URL Construction Example
```javascript
const format = 'size320'; // Choose the desired format
const { s, e } = formatMap[format];
const domain = 'http://ws.stream.qqmusic.qq.com/'; // Obtained from vkey/guid endpoint
const strMediaMid = 'YOUR_STR_MEDIA_MID'; // Media identifier for the song
const guid = 'YOUR_GUID'; // Obtained from vkey/guid endpoint
const vkey = 'YOUR_VKEY'; // Obtained from vkey/guid endpoint

const url = `${domain}${s}${strMediaMid}${e}?guid=${guid}&vkey=${vkey}&fromtag=8&uin=0`;
```

**Important:** Use `strMediaMid` for paid songs, as it differs from `songmid`. For non-paid songs, `strMediaMid` and `songmid` are the same. High-quality formats might be restricted (403 Forbidden).
```

--------------------------------

### GET /singer/songs

Source: https://jsososo.github.io/QQMusicApi/index

Get popular songs by a singer. Requires `singermid`.

```APIDOC
## GET /singer/songs

### Description
Retrieves a list of popular songs by a specific singer. You can specify the number of songs and the page number for pagination.

### Method
GET

### Endpoint
/singer/songs

### Parameters
#### Query Parameters
- **singermid** (string) - Required - The unique media ID of the singer.
- **num** (integer) - Optional - The number of songs to return. Defaults to 20.
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.

### Request Example
```
GET /singer/songs?singermid=0025NhlN2yWrP4&num=10&page=2
```

### Response
#### Success Response (200)
- **songs** (array) - A list of songs by the singer.
  - **name** (string) - The name of the song.
  - **album** (string) - The album the song belongs to.
  - **mid** (string) - The media ID of the song.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "songs": [
    {
      "name": "Hit Song",
      "album": "Greatest Hits",
      "mid": "songmid123"
    }
  ]
}
```
```

--------------------------------

### QQ Music API - Constructing Playback URL

Source: https://jsososo.github.io/QQMusicApi/index

Details how to construct music playback URLs using the obtained vkey, guid, and domain. It includes a `formatMap` to specify different audio quality formats (128k, 320k, ape, flac) and their corresponding parameters for URL construction.

```javascript
const formatMap = {
          size128: {
            val: '128k',
            s: 'M500',
            e: '.mp3',
            content: 'audio/mpeg',
          },
          size320: {
            val: '320k',
            s: 'M800',
            e: '.mp3',
            content: 'audio/mpeg',
          },
          sizeape: {
            val: '无损ape',
            s: 'A000',
            e: '.ape',
            content: 'audio/ape',
          },
          sizeflac: {
            val: '无损flac',
            s: 'F000',
            e: '.flac',
            content: 'audio/x-flac',
          }
        }
      }
const format = 'size320';
const { s, e } = formatMap[format];

// Note: use strMediaMid, not songid or songmid. For paid songs, strMediaMid differs from songmid.
const url = `${domain}${s}${strMediaMid}${e}?guid=${guid}&vkey=${vkey}&fromtag=8&uin=0`
```

--------------------------------

### GET /singer/category

Source: https://jsososo.github.io/QQMusicApi/index

Get singer categories including area, genre, initial, and sex/group.

```APIDOC
## GET /singer/category

### Description
Retrieves various classification categories for singers, including region (`area`), genre (`genre`), initial letter (`index`), and sex/group (`sex`). This information can be used to filter singers in other endpoints.

### Method
GET

### Endpoint
/singer/category

### Parameters
None

### Request Example
```
GET /singer/category
```

### Response
#### Success Response (200)
- **categories** (object) - Contains different singer categories.
  - **area** (array) - List of region categories.
  - **genre** (array) - List of genre categories.
  - **index** (array) - List of initial letter categories.
  - **sex** (array) - List of sex/group categories.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "categories": {
    "area": [
      {"id": -100, "name": "All"},
      {"id": 1, "name": "Mainland China"}
    ],
    "genre": [
      {"id": -100, "name": "All"},
      {"id": 10, "name": "Pop"}
    ],
    "index": [
      {"id": -100, "name": "All"},
      {"id": 1, "name": "A"}
    ],
    "sex": [
      {"id": -100, "name": "All"},
      {"id": 1, "name": "Male"}
    ]
  }
}
```
```

--------------------------------

### GET /singer/list

Source: https://jsososo.github.io/QQMusicApi/index

Get a list of singers based on category filters. Returns 80 singers per request.

```APIDOC
## GET /singer/list

### Description
Retrieves a list of singers based on specified category filters such as area, genre, initial letter, and sex/group. This endpoint is designed to return a fixed number of 80 singers per request.

### Method
GET

### Endpoint
/singer/list

### Parameters
#### Query Parameters
- **area** (integer) - Optional - The region category ID. Defaults to -100 (All).
- **genre** (integer) - Optional - The genre category ID. Defaults to -100 (All).
- **index** (integer) - Optional - The initial letter category ID. Defaults to -100 (All).
- **sex** (integer) - Optional - The sex/group category ID. Defaults to -100 (All).
- **pageNo** (integer) - Optional - The page number for pagination. Defaults to 1.

### Request Example
```
GET /singer/list?area=1&genre=10&index=1&sex=1&pageNo=2
```

### Response
#### Success Response (200)
- **singers** (array) - A list of singers matching the criteria.
  - **name** (string) - The name of the singer.
  - **singermid** (string) - The media ID of the singer.
  - **albumInfo** (object) - Information about the singer's latest album.
    - **name** (string) - The name of the latest album.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "singers": [
    {
      "name": "Artist Name",
      "singermid": "artistmid789",
      "albumInfo": {
        "name": "Latest Album"
      }
    }
  ]
}
```
```

--------------------------------

### Get User Detail

Source: https://jsososo.github.io/QQMusicApi/index

Retrieves detailed information about a user's profile, including their liked music and created playlists. Requires login via cookie; otherwise, a 301 redirect occurs.

```APIDOC
## GET /user/detail

### Description
Fetches detailed information about a user's profile, including their liked music and created playlists. This endpoint requires a valid user cookie for authentication; otherwise, it returns a 301 redirect.

### Method
GET

### Endpoint
`/user/detail`

### Parameters
#### Query Parameters
- **id** (string) - Required - The QQ number of the user.

### Request Example
```
/user/detail?id=123456
```

### Response
#### Success Response (200)
- Contains user details, including 'mymusic' (liked music) and 'mydiss' (created playlists).

#### Response Example
(Response structure not explicitly defined, but includes user profile data.)
```

--------------------------------

### GET /album/songs

Source: https://jsososo.github.io/QQMusicApi/index

Get songs within a specific album. Requires `albummid`.

```APIDOC
## GET /album/songs

### Description
Retrieves a list of all songs contained within a specific album, identified by its `albummid`.

### Method
GET

### Endpoint
/album/songs

### Parameters
#### Query Parameters
- **albummid** (string) - Required - The unique media ID of the album.

### Request Example
```
GET /album/songs?albummid=002MAeob3zLXwZ
```

### Response
#### Success Response (200)
- **songs** (array) - A list of songs in the album.
  - **name** (string) - The name of the song.
  - **mid** (string) - The media ID of the song.
  - **duration** (integer) - The duration of the song in seconds.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "songs": [
    {
      "name": "Track 1",
      "mid": "trackmid001",
      "duration": 240
    },
    {
      "name": "Track 2",
      "mid": "trackmid002",
      "duration": 180
    }
  ]
}
```
```

--------------------------------

### Get Playlist Details

Source: https://jsososo.github.io/QQMusicApi/index

Retrieves detailed information about a specific playlist, including file size information for various audio formats.

```APIDOC
## GET /songlist

### Description
Retrieves detailed information for a specific playlist, including the file sizes for different audio quality formats (e.g., 128k, 320k, lossless).

### Method
GET

### Endpoint
`/songlist`

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the playlist.

### Request Example
```
/songlist?id=2429907335
```

### Response
#### Success Response (200)
- Contains file size information for various formats:
  - **size128** (integer) - File size for 128k quality.
  - **size320** (integer) - File size for 320k quality.
  - **sizeape** (integer) - File size for APE lossless format.
  - **sizeflac** (integer) - File size for FLAC lossless format.

#### Response Example
```json
{
  "size128": 1922927,
  "size320": 4803503,
  "sizeape": 10810010,
  "sizeflac": 10827560
}
```
```

--------------------------------

### Get Song Playback URLs

Source: https://jsososo.github.io/QQMusicApi/index

Retrieves playback URLs for given song mids. Supports both GET and POST requests. Note that not all songs are available due to login status, VIP restrictions, or purchase requirements. The server uses a member's cookie by default; custom cookies can be provided.

```APIDOC
## GET /song/urls

### Description
Retrieves playback URLs for specified song mids. This endpoint can be accessed via GET or POST. Availability of playback URLs depends on user login status, VIP membership, and whether the song requires purchase.

### Method
GET, POST

### Endpoint
`/song/urls`

### Parameters
#### Query Parameters
- **id** (string) - Required - Comma-separated song mids (songmid).

### Request Example
```json
{
  "id": "0039MnYb0qxYhV,004Z8Ihr0JIu5s"
}
```

### Response
#### Success Response (200)
- **data** (object) - An object where keys are song mids and values are playback URLs.
- **result** (integer) - Indicates the success of the operation.

#### Response Example
```json
{
  "data": {
    "0039MnYb0qxYhV": "http://ws.stream.qqmusic.qq.com/C400002202B43Cq4V4.m4a?guid=2796982635&vkey=0A1ADCEDC042ABE27FE184A3436DBB6F15AFF286F0F06DDFAEA9ADAF2D82F67EF33746A9472F62B444B7E7CEB32EE0D34DFD53A6E2D97D7B&uin=1899&fromtag=66",
    "004Z8Ihr0JIu5s": "http://ws.stream.qqmusic.qq.com/C4000012Ez0a1tFcOI.m4a?guid=2796982635&vkey=DB0E16676C581AE2E762FCA5D32FBB52454EA229C6BD58D9BA2976BA7CC3E49532EA299860E0F219148005848530335ABC254EC7A3374F80&uin=1899&fromtag=66"
  },
  "result": 100
}
```
```

--------------------------------

### GET /comment

Source: https://jsososo.github.io/QQMusicApi/index

Get comments for a specific item (song, album, etc.). Supports pagination and hot comments.

```APIDOC
## GET /comment

### Description
Retrieves comments for a given item, such as a song, album, playlist, or MV. Supports fetching latest comments or hot comments, with pagination.

### Method
GET

### Endpoint
/comment

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the item (song, album, playlist, MV, etc.).
- **pageNo** (integer) - Optional - The page number for pagination. Defaults to 1.
- **pageSize** (integer) - Optional - The number of comments per page. Defaults to 20.
- **type** (integer) - Optional - The type of comments to retrieve. 0: Latest comments, 1: Hot comments. Defaults to 0.
- **biztype** (integer) - Optional - The business type of the item. 1: Song, 2: Album, 3: Playlist, 4: Chart, 5: MV.

### Request Example
```
GET /comment?id=97773&type=1&biztype=1
```

### Response
#### Success Response (200)
- **comments** (array) - A list of comments.
  - **content** (string) - The text of the comment.
  - **user** (object) - Information about the user who posted the comment.
    - **nickname** (string) - The user's nickname.
    - **avatarUrl** (string) - The user's avatar URL.
  - **praiseCount** (integer) - The number of likes the comment has received.
  - **timestamp** (integer) - The time the comment was posted (Unix timestamp).
- **hot_comment** (array) - A list of hot comments (returned when pageNo is 1 and type is 0).

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "comments": [
    {
      "content": "Great song!",
      "user": {
        "nickname": "User123",
        "avatarUrl": "http://example.com/avatar.jpg"
      },
      "praiseCount": 50,
      "timestamp": 1678886400
    }
  ],
  "hot_comment": [
    {
      "content": "This is a trending comment.",
      "user": {
        "nickname": "HotUser",
        "avatarUrl": "http://example.com/hot_avatar.jpg"
      },
      "praiseCount": 100,
      "timestamp": 1678880000
    }
  ]
}
```
```

--------------------------------

### Get Similar Songs

Source: https://jsososo.github.io/QQMusicApi/index

Finds and returns a list of songs that are similar to a given song ID.

```APIDOC
## GET /song/similar

### Description
Retrieves a list of songs that are musically similar to the specified song.

### Method
GET

### Endpoint
`/song/similar`

### Parameters
#### Query Parameters
- **id** (string) - Required - The song ID for which to find similar songs.

### Request Example
```
/song/similar?id=5105986
```
```

--------------------------------

### Get Related MVs

Source: https://jsososo.github.io/QQMusicApi/index

Returns a list of music videos (MVs) that are related to a given song ID.

```APIDOC
## GET /song/mv

### Description
Retrieves a list of music videos (MVs) that are related to the specified song.

### Method
GET

### Endpoint
`/song/mv`

### Parameters
#### Query Parameters
- **id** (string) - Required - The song ID for which to find related MVs.

### Request Example
```
/song/mv?id=5105986
```
```

--------------------------------

### Get Song Lyrics

Source: https://jsososo.github.io/QQMusicApi/index

Retrieves the lyrics and translated lyrics for a given song MID. Lyrics are returned in Base64 format.

```APIDOC
## GET /lyric

### Description
Fetches the lyrics and translated lyrics for a specified song MID. The lyrics are encoded in Base64 format.

### Method
GET

### Endpoint
`/lyric`

### Parameters
#### Query Parameters
- **songmid** (string) - Required - The MID of the song for which to retrieve lyrics.

### Request Example
```
/lyric?songmid=0039MnYb0qxYhV
```

### Response
#### Success Response (200)
- **lyric** (string) - Base64 encoded lyrics.
- **trans** (string) - Base64 encoded translated lyrics.

#### Response Example
(Response structure not explicitly defined, but contains Base64 encoded lyric strings.)
```

--------------------------------

### Get Song Information

Source: https://jsososo.github.io/QQMusicApi/index

Retrieves detailed information about a specific song, including artist, album, genre, etc., but not lyrics. Provides a link to the album cover image.

```APIDOC
## GET /song

### Description
Retrieves comprehensive information about a specific song, such as its artist, album details, genre, and more. It does not include lyrics but provides a URL format for the album cover image.

### Method
GET

### Endpoint
`/song`

### Parameters
#### Query Parameters
- **songmid** (string) - Required - The unique song MID (Music ID).

### Request Example
```
/song?songmid=0039MnYb0qxYhV
```

### Response
#### Success Response (200)
- Contains detailed song information, including:
  - **songinfo.data.track_info.album.mid** (string) - The MID of the album.

#### Album Cover URL Format
`https://y.gtimg.cn/music/photo_new/T002R300x300M000${mid}.jpg`
```

--------------------------------

### Get Song File Sizes by Bitrate

Source: https://jsososo.github.io/QQMusicApi/index

Provides file sizes for a song in various bitrates (128k, 320k, m4a, flac, ape). A size of 0 indicates that the format is not available for the given song. This information is crucial for determining available download options.

```json
{
  "size128": 1922927,
  "size320": 4803503,
  "sizeape": 10810010,
  "sizeflac": 10827560
}
```

--------------------------------

### Get Song Information

Source: https://jsososo.github.io/QQMusicApi/index

Fetches detailed information about a specific song, identified by its `songmid`. This includes artist, album, language, and genre, but not lyrics. The response also provides a base URL format for album cover images using the album's `mid`.

```javascript
`https://y.gtimg.cn/music/photo_new/T002R300x300M000${mid}.jpg`
```

--------------------------------

### Get User Song List

Source: https://jsososo.github.io/QQMusicApi/index

Retrieves a list of playlists created by a specific user. This endpoint is more focused than `/user/detail` and does not strictly require login, but access to private playlists depends on user's privacy settings and potentially the user's own cookie.

```APIDOC
## GET /user/songlist

### Description
Retrieves a list of playlists created by a specific user. This endpoint provides a more focused view compared to `/user/detail` and generally does not require a login cookie, although access to private playlists may depend on the user's privacy settings or the presence of the user's own cookie.

### Method
GET

### Endpoint
`/user/songlist`

### Parameters
#### Query Parameters
- **id** (string) - Required - The QQ number of the user.

### Request Example
```
/user/songlist?id=123456
```

### Response
#### Success Response (200)
- Returns a list of playlists created by the user.

#### Response Example
(Response structure not explicitly defined, but contains playlist information.)
```

--------------------------------

### Get Hot Search Terms

Source: https://jsososo.github.io/QQMusicApi/index

Retrieves a list of trending or hot search terms, along with their respective search volumes.

```APIDOC
## GET /search/hot

### Description
Fetches a list of currently popular search terms on QQ Music, including the number of times each term has been searched.

### Method
GET

### Endpoint
`/search/hot`

### Response
#### Success Response (200)
- **result** (integer) - Indicates the success of the operation.
- **data** (array) - An array of objects, where each object contains:
  - **k** (string) - The hot search term.
  - **n** (integer) - The search volume for the term.

#### Response Example
```json
{
  "result": 100,
  "data": [
    {
      "k": "PHOENIX 涅槃 ",
      "n": 440301
    },
    {
      "k": "嚣张 ",
      "n": 430912
    },
    ...
  ]
}
```
```

--------------------------------

### Get Song ID and MID Hash Table

Source: https://jsososo.github.io/QQMusicApi/index

Generates a hash table mapping song IDs to MIDs for playlists owned by the user. Requires the user's cookie.

```APIDOC
## GET /songlist/map

### Description
Generates a hash table mapping song IDs to their corresponding MIDs for playlists owned by the user. This endpoint requires the user's cookie to be present and defaults to the 'My Favorite Songs' playlist.

### Method
GET

### Endpoint
`/songlist/map`

### Parameters
#### Query Parameters
- **dirid** (integer) - Optional - The ID of the playlist. Defaults to 201 (My Favorite Songs).

### Response
#### Success Response (200)
- Returns a hash table mapping song IDs to MIDs.

#### Response Example
(Response structure not explicitly defined, but contains a map of song IDs to MIDs.)
```
Tokens:
Raw