The KKBOX Open API zh-TW Developer Hub

Welcome to the KKBOX Open API zh-TW developer hub. You'll find comprehensive guides and documentation to help you start working with KKBOX Open API zh-TW as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    
 

KKBOX OAuth 2.0 API 採用 OAuth 標準,為驗證開發者應用程式的方法。

KKBOX OAuth 2.0 API 的設計允許 KKBOX 會員授權給第三方應用,使第三方應用可存取個人在 KKBOX 建立的資料(如收藏歌曲、專輯、歌單),而無需將 KKBOX 帳號密碼提供給第三方應用。

KKBOX 提供的 OAuth Flow 比較表如下:

Flow
User Authorization Required
Access User Resources
Access Token Refresh
Suitable for Use in

Client Credentials Flow

No

No

No

只需取得 KKBOX 公開資料

Authorization Code Flow

Yes

Yes

Yes

須獲得使用者個人資料(如收藏歌曲、專輯,歌單)

Devices Flow

Yes

Yes

Yes

須獲得使用者個人資料(如收藏歌曲、專輯,歌單),且終端設備不方便使用者輸入帳號密碼進行登入

若選擇用 Authorization Code Flow Devices Flow 取得 Access Token,可一併實做 Token Refreshing 以讓用戶授權的 Access Token 在過期時可以重新取得新的 Access Token,不須再經過用戶重新授權。

Suggest Edits

Client Credentials Flow

使用 App ID 及 App Secret 取得 access token
建立 App => https://developer.kkbox.com/#/app

 
posthttps://account.kkbox.com/oauth2/token
POST /oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: account.kkbox.com

grant_type=client_credentials&client_id=234560AA085B38C19FB60371C8C6D25E&client_secret=6B7928FDE40394CCC81962D7700C0107
A binary file was returned

You couldn't be authenticated

{
  "access_token": "fCVTwABPlcO6Qxc7Ll23rsdfsf",
  "expires_in": 2592000,
  "token_type": "Bearer"
}
{
  "error":"invalid_request"
}
{
  "error":"invalid_client"
}
{
  "error":"invalid_grant"
}
{
  "error":"invalid_request"
}

Form Data

grant_type
string
required

必須填入 client_credentials

client_id
string
required

App ID,您也可以選擇透過 HTTP Basic access authentication 傳輸

client_secret
string
required

App Secret,您也可以選擇透過 HTTP Basic access authentication 傳輸

 
Suggest Edits

Authorization Code Flow

 

OAuth 2.0 Authorization Code Grant 標準 用於幫助可打開網頁瀏覽器及具備 Cloud Service 的應用程式取得 Access Token,流程中獲取的 Access Token 即可與 KKBOX 進行認證,最終得以使用 KKBOX API 服務。KKBOX 建議之 OAuth 2.0 for Authorization Code Flow 整合方式如下:

角色說明

  • 使用者 使用應用程式的人
  • User Agent 一般為瀏覽器 Browser 或者為 Web View Component
  • Cloud Service 建立在 Web Server 上的 KKBOX OAuth Client Service
  • KKBOX API 服務 KKBOX 提供給開發者之 API 服務

Authorization Code Flow 登入流程說明

  • 使用者 欲體驗應用程式中的 KKBOX 服務,則應用程式需打開 User Agent 呈現介面詢問使用者是否接受 KKBOX 登入,若接受,則使用者於 User Agent 上授權 Cloud Service 存取個人 KKBOX 服務資源 [1-2] ,並發送帳號登入請求。
  • Cloud Service 呼叫 KKBOX OAuth 2.0 Authorize API [3],發送參數中需填入 redirect_uri(須經過 URL encoding),此參數需與 開發者網站中 My Apps 頁面 內該專案 redirect_uri 欄位所填的相同。請求後 User Agent 會轉址到一組帶有 state 的 KKBOX 帳號密碼入頁面 [3-8]。此頁面建議 Android 使用 Chrome Custom Tab、iOS 使用 SFAuthenticationSession 開啟網址,並由使用者輸入 KKBOX 帳號/密碼或註冊新帳號。輸入帳號密碼後,KKBOX API 服務 會檢查 redirect_uri 是否有誤,若有誤則會拒絕授權,若正確則完成使用者授權之流程。

KKBOX OAuth 2.0 Authorize API Request

GET /oauth2/authorize?redirect_uri={MY_CLIENT_REDIRECT_URI}&client_id={MY_CLIENT_ID}&response_type=code&state={YOUR_STATE_MSG} HTTP/1.1
Host: account.kkbox.com
Location: /login?url=%2Foauth2%2Fauthorize%3Fredirect_uri%3D{MY_CLIENT_REDIRECT_URI}%26client_id%3D{MY_CLIENT_ID}%26response_type%3Dcode%26state%3D{YOUR_STATE_MSG}

使用者同意授權後,瀏覽器會導入至 Cloud Service(亦即先前所填的 redirect_uri 頁面,由於 redirect_uri 的網站建立在 Web Server 上,此網站即為 Cloud Service)[9],以下圖為範例,當瀏覽器進行轉址後,網址後會帶有 Authorization Code 及 State,開發者必須擷取位於網址後的 Authorization Code [10-11] 。

Cloud Service 呼叫 Token API for Authorization Code Flow [12-13],使用 Authorization Code 向 KKBOX API 服務 請求獲取 Access Token。

Token API for Authorization Code Flow Request

POST /oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: account.kkbox.com
  
grant_type=authorization_code&code={authorization_code}&client_id={MY_CLIENT_ID}&client_secret={MY_CLIENT_SECRET}
{
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 9223372036854775807,
  "token_type": "Bearer",
  "refresh_token": "{REFRESH_TOKEN}"
}

最後告知 使用者 完成登入,顯示可開始體驗 KKBOX 服務的訊息 [14-15]。

Access Token 管理

  • 在此使用情境下, Access Token 應為保存於 Web Server 上,若需要透過網路傳輸傳輸 Access Token 使您的設備/服務可存取 KKBOX 資訊之權限識別資料,請務必採用加密傳輸協定,例如 TLS 1.2 以上。
Suggest Edits

Step 1. Authorize

讓用戶進入特定網址授權給您的 App

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://account.kkbox.com/oauth2/authorize
GET /oauth2/authorize?redirect_uri=https%3A%2F%2Flocalhost%2F&client_id=my_client_id&response_type=code&state=1234 HTTP/1.1
Host: account.kkbox.com
A binary file was returned

You couldn't be authenticated

Location: /login?url=url=%2Foauth2%2Fauthorize%3Fredirect_uri%3Dhttps%253A%252F%252Flocalhost%252F%26client_id%3Dmy_client_id%26response_type%3Dcode%26state%3D1234
{
  "error":"invalid_request"
}
{
  "error":"unauthorized_client"
}
{
  "error":"unsupported_response_type"
}
{
  "error":"access_denied"
}

Query Params

redirect_uri
string
required

用戶成功授權後的轉址連結(須經過 URL encoding),必須與 App 中設定的 redirect_uri ㄧ致 https://developer.kkbox.com/#/app

client_id
string
required

App ID

response_type
string
required

必須填入 code

state
string
required

狀態參數,用戶成功授權轉址時會帶同樣的值,可確保為同一用戶授權,基於安全需求

 
Suggest Edits

Step 2. Token API for Authorization Code Flow

使用 Authorization Code 取得 access token

 
posthttps://account.kkbox.com/oauth2/token
POST /oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: account.kkbox.com

grant_type=authorization_code&code=eff150349d630c2accd0ab55c5172ba7&client_id=234560AA085B38C19FB60371C8C6D25E&client_secret=6B7928FDE40394CCC81962D7700C0107
A binary file was returned

You couldn't be authenticated

{
  "access_token": "fCVTwABPlcO6Qxc7Ll23rsdfsf",
  "expires_in": 2592000,
  "token_type": "Bearer",
  "refresh_token": "y600sLtGlsR+oU4mhYtOeg=="
}
{
  "error": "invalid_client"
}
{
  "error": "invalid_grant"
}
{
  "error": "invalid_request"
}

Form Data

grant_type
string
required

必須填入 authorization_code

code
string
required

請填入步驟一中用戶同意授權,redirect 回來在 url parameter 帶的 code

client_id
string
required

App ID,您也可以選擇透過 HTTP Basic access authentication 傳輸

client_secret
string
required

App Secret,您也可以選擇透過 HTTP Basic access authentication 傳輸

 
Suggest Edits

Devices Flow

 

OAuth 2.0 Device Flow 標準 用於幫助無瀏覽器環境或輸入不便的設備以簡便的方式取得 Access Token,常見應用場景為開發版、Smart TV、Set-top box、Smart Speaker 等應用,可以利用 Device Code、QR Code 或其他通訊方式,將輸入流程轉移到 Smart Phone 或具備瀏覽器的連網設備協助登入授權,KKBOX 建議之 OAuth 2.0 for Device Flow 整合方式如下:

角色說明

  • 使用者 使用 IoT 設備體驗 KKBOX 服務的人
  • Control App IoT 設備輔助使用者操控之應用程式,一般為 iOS/Android App
  • IoT Device 開發者之 IoT 設備
  • KKBOX API 服務 KKBOX 提供給開發者之 API 服務

Device Flow 登入流程說明

  • 使用者初次使用 IoT 設備,並完成 Wifi 等基礎設定後 [1]
  • Control App 呈現介面詢問使用是否接受 KKBOX 登入 [2]
  • 使用者 使用 Control App 介面接受 KKBOX 登入 [3]
  • Control AppIoT Device 發送 KKBOX 帳號登入請求 [4]
  • IoT Device 呼叫 Device Code API 取得 device_code、verification_qrcode(URL) [5-6]

Device Code API Request

POST /oauth2/device/code HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: account.kkbox.com
  
client_id={MY_CLIENT_ID}
{
  "device_code": "{DEVICE_CODE}",
  "expires_in": 600,
  "interval": 5,
  "short_verification_url": "https://www.kkbox.com/device",
  "user_code": "{USER_CODE}",
  "verification_qrcode": "https://account.kkbox.com/oauth2/authorize?response_type=device&user_code={USER_CODE}",
  "verification_url": "https://account.kkbox.com/device"
}

IoT Device 傳遞 verification_qrcode(URL) 給 Control App,建議 Android 使用 Chrome Custom Tab 、iOS 使用 SFAuthenticationSession 開啟 verification_qrcode,並由使用者輸入 KKBOX 帳號/密碼或註冊新帳號後進行授權 [8-10],verification_qrcode URL 呼叫格式如下:

GET /oauth2/authorize?response_type=device&user_code={USER_CODE} HTTP/1.1
Host: account.kkbox.com

IoT Device 以 Polling 方式呼叫 Token API for Devices Flow [7],如 [8-10] 未完成則會出現錯誤 authorization_pending,持續呼叫直到取得 Access Token [11],其中 {ACCESS_TOKEN}{REFRESH_TOKEN} 皆為重要欄位,請務必妥善保存。

Token API for Devices Flow Request

POST /oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: account.kkbox.com
  
grant_type=http://oauth.net/grant_type/device/1.0&client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}&code={DEVICE_CODE}
{
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 9223372036854775807,
  "token_type": "Bearer",
  "refresh_token": "{REFRESH_TOKEN}"
}

IoT Device 取得 Access Token 後 [11],告知 Control App 使用者已完成登入 [12]。如 Control App 需存取 KKBOX 資料,亦可將 Access Token 傳遞給 Control App,例如部分設備的Control App 可能提供顯示歌單、專輯封面等功能。

最後 Control App 顯示可開始體驗 KKBOX 服務的訊息 [13]。

Suggest Edits

Step 1. Device Code API

取得 device_codeverification_qrcode,讓用戶進入該連結,授權給您的 App。

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://account.kkbox.com/oauth2/device/code
POST /oauth2/device/code HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: account.kkbox.com

client_id=my_client_id
A binary file was returned

You couldn't be authenticated

{
  "device_code": "3ff6c414af09003d2dsf34dsdfsdf",
  "expires_in": 600,
  "interval": 5,
  "short_verification_url": "https://www.kkbox.com/device",
  "user_code": "135793242432",
  "verification_qrcode": "https://account.kkbox.com/oauth2/authorize?response_type=device&user_code=135793242432",
  "verification_url": "https://account.kkbox.com/device"
}

Form Data

client_id
string
required

App ID

 
Suggest Edits

(Optional) Generate QR Code Image

如果您的設備不方便使用者輸入 KKBOX 帳號密碼進行授權,但是具備顯示螢幕,可以將授權網址生成 QR Code,讓用戶用手機掃描,然後在手機瀏覽器中登入、授權給您的 App

 
gethttps://account.kkbox.com/oauth2/generator
GET /generator?content=https%3A%2F%2Fevent.kkbox.com%2Fcontent%2Fplaylist%2FDZni8m29ciOFbRxTJq%3Fdesktop%3Dtrue&image_size=250&logo_size=50&response_type=json HTTP/1.1
Host: qrcode.kkbox.com.tw
A binary file was returned

You couldn't be authenticated

{
  "status":"success",
  "data":"data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAYAAACI7Fo9AAAgAElEQVR4nOy9ebgdR3E2\/va55+771X61b5ZtWZZsybbMapsYEwgYAiGEkBAS1nyEhMX5+EISfgkJJOwkToAAcQirCbtZAnYwYI....."
}

Query Params

content
string
required

生成 QR Code 的字串。在 Devices Flow 中使用,請填入步驟一中取得的 verification_qrcode

image_size
int32
required

正方形,以 pixel 為單位

logo_size
int32
required

正方形,會出現在 QR Code 正中央,以 pixel 為單位

response_type
string
required

可選擇 response 的 content type 要為 image 或者是 json

foreground_color
int32

QR Code 的顏色,以十六進制 RGB 色碼表示

background_color
int32

QR Code 圖片的背景顏色,以十六進制 RGB 色碼表示

 
Suggest Edits

Step 2. Token API for Devices Flow

使用 device_code 取得 access token

 
posthttps://account.kkbox.com/oauth2/token
POST /oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: account.kkbox.com

grant_type=http://oauth.net/grant_type/device/1.0&code=2e64328c71f35dc9c55417c8194a46b8&client_id=234560AA085B38C19FB60371C8C6D25E&client_secret=6B7928FDE40394CCC81962D7700C0107
A binary file was returned

You couldn't be authenticated

{
  "access_token": "fCVTwABPlcO6Qxc7Ll23rsdfsf",
  "expires_in": 9223372036854775807,
  "token_type": "Bearer",
  "refresh_token": "UeOKz4pJepEkIaGvlBUm3z=="
}
{
  "error":"authorization_pending"
}
{
  "error":"invalid_request"
}
{
  "error":"invalid_client"
}
{
  "error":"invalid_request"
}

Form Data

grant_type
string
required

必須填入 http://oauth.net/grant_type/device/1.0

code
string
required

在步驟一中取得的 device_code

client_id
string
required

App ID,您也可以選擇透過 HTTP Basic access authentication 傳輸

client_secret
string
required

App Secret,您也可以選擇透過 HTTP Basic access authentication 傳輸

 
Suggest Edits

Token Refreshing

 

透過 Token API 取得之 Access Token 與 Refresh Token 皆有生命週期,Access Token 會依據 expires_in 欄位知道過期時間,而 Refresh Token 生命週期會略長於 Access Token,請務必於 Access Token 過期前進行更新 Token 程序,以免 Access Token 過期無法正確取得 API 內容影響使用者體驗。

Token API Response

{
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 2592000,
  "token_type": "Bearer",
  "refresh_token": "{REFRESH_TOKEN}"
}

JSON 欄位說明

欄位
訊息說明

access_token

Access Token,後續所有 API 存取之權限識別

expires_in

Access Token 過期資料,單位為秒,以上範例表示:2592000/60/60/24(s)=30(days)

token_type

Bearer / Basic,與 KKBOX 會員帳號連結皆為 Bearer

refresh_token

用於更新 Access Token 之權限識別,如成功透過 Refresh Token 更新 Access Token 則無須再進行帳號/密碼輸入流程

更新 Token 可參照 Token API for Refreshing ,在有效期限內以 Refresh Token 呼叫 Token API for Refreshing 進行更新 Access Token。

Token API for Refreshing Request

POST /oauth2/token HTTP/1.1
Authorization: Basic {BASE64_ENCODE(CLIENT_ID:CLIENT_SECRET)}
Content-Type: application/x-www-form-urlencoded
Host: account.kkbox.com

grant_type=refresh_token&refresh_token={REFRESH_TOKEN}
{
  "access_token": "{NEW_ACCESS_TOKEN}",
  "expires_in": 9223372036854775807,
  "token_type": "Bearer",
  "refresh_token": "{NEW_REFRESH_TOKEN}"
}

錯誤處理:請留意 Token API for Refreshing 文件的 Results,如發生 Token Refreshing 錯誤,則需重新進行 OAuth 認證流程。

Suggest Edits

Token API for Refreshing

使用 refresh_token 得到新的 access token

 
posthttps://account.kkbox.com/oauth2/token
POST /oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: account.kkbox.com

grant_type=refresh_token&refresh_token=y700ELGGlsR+qU5ohZtOeg==&client_id=234560AA085B38C19FB60371C8C6D25E&client_secret=6B7928FDE40394CCC81962D7700C0107
A binary file was returned

You couldn't be authenticated

{
  "access_token": "fCVTwABPlcO6Qxc7Ll23rsdfsf",
  "expires_in": 9223372036854775807,
  "token_type": "Bearer",
  "refresh_token": "UfKLz4PHepEkIaGvmXUm3z=="
}
{
  "error":"invalid_request"
}
{
  "error":"invalid_client"
}
{
  "error":"invalid_grant"
}
{
  "error":"invalid_request"
}

Form Data

grant_type
string
required

必須填入 refresh_token

refresh_token
string
required

填入您在 Authorization Code Flow 或是 Devices Flow 得到的 refresh token

client_id
string
required

App ID,您也可以選擇透過 HTTP Basic access authentication 傳輸

client_secret
string
required

App Secret,您也可以選擇透過 HTTP Basic access authentication 傳輸

 
Suggest Edits

Getting Started

 

透過 KKBOX OAuth 2.0 API 取得 Access Token 後,就可以開始使用 KKBOX Open API 的資料。方法即是在每個 HTTP Request 的 Headers 中加入 Authorization: Bearer my_access_token。舉例而言,假設您的 Access Token 是 fCVTwABPlcO6Qxc7Ll23rsdfsf,若想獲取 KKBOX 音樂排行榜列表,HTTP Request 的內容為:

GET /v1.1/charts?territory=TW HTTP/1.1
Authorization: Bearer fCVTwABPlcO6Qxc7Ll23rsdfsf
Host: api.kkbox.com

詳細可參考 Charts 說明。

Suggest Edits

/charts

取得各種音樂排行榜列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/charts
GET /v1.1/charts?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "LZPhK2EyYzN15dU-PT",
      "title": "綜合新歌即時榜",
      "description": "綜合新歌即時榜",
      "url": "https://www.kkbox.com/tw/tc/playlist/LZPhK2EyYzN15dU-PT",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/59599602v1259/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/59599602v1259/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/59599602v1259/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-08-02T03:01:58+00:00",
      "owner": {
        "id": "T-YMdq3gnf6AVbuqgt",
        "url": "https://www.kkbox.com/tw/profile/T-YMdq3gnf6AVbuqgt",
        "name": "KKBOX",
        "description": "",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "PYQbSKw4piAuZAS8z8",
      "title": "華語單曲日榜",
      "description": "華語單曲日榜",
      "url": "https://www.kkbox.com/tw/tc/playlist/PYQbSKw4piAuZAS8z8",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/65090851v1/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/65090851v1/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/65090851v1/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-08-01T23:20:50+00:00",
      "owner": {
        "id": "T-YMdq3gnf6AVbuqgt",
        "url": "https://www.kkbox.com/tw/profile/T-YMdq3gnf6AVbuqgt",
        "name": "KKBOX",
        "description": "",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "1-O_-tQ-1E2cxrYDeH",
      "title": "西洋單曲日榜",
      "description": "西洋單曲日榜",
      "url": "https://www.kkbox.com/tw/tc/playlist/1-O_-tQ-1E2cxrYDeH",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/65090970v1/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/65090970v1/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/65090970v1/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-08-01T23:21:04+00:00",
      "owner": {
        "id": "T-YMdq3gnf6AVbuqgt",
        "url": "https://www.kkbox.com/tw/profile/T-YMdq3gnf6AVbuqgt",
        "name": "KKBOX",
        "description": "",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "DXg7Kh_0Hhl4u8NbiB",
      "title": "韓語單曲日榜",
      "description": "韓語單曲日榜",
      "url": "https://www.kkbox.com/tw/tc/playlist/DXg7Kh_0Hhl4u8NbiB",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/65090872v1/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/65090872v1/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/65090872v1/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-08-01T23:20:53+00:00",
      "owner": {
        "id": "T-YMdq3gnf6AVbuqgt",
        "url": "https://www.kkbox.com/tw/profile/T-YMdq3gnf6AVbuqgt",
        "name": "KKBOX",
        "description": "",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "5YQgr1nN3dAINAbNFD",
      "title": "日語單曲日榜",
      "description": "日語單曲日榜",
      "url": "https://www.kkbox.com/tw/tc/playlist/5YQgr1nN3dAINAbNFD",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/65090865v1/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/65090865v1/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/65090865v1/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-08-01T23:20:52+00:00",
      "owner": {
        "id": "T-YMdq3gnf6AVbuqgt",
        "url": "https://www.kkbox.com/tw/profile/T-YMdq3gnf6AVbuqgt",
        "name": "KKBOX",
        "description": "",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/300x300.jpg"
          }
        ]
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 5,
    "previous": null,
    "next": null
  },
  "summary": {
    "total": 29
  }
}

Query Params

territory
string
required

地區參數,取得該地區的排行榜資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/charts/:chart_id

使用 playlist_id 取得該音樂排行榜的資料。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/charts/chart_id
GET /v1.1/charts/X-6lSz-IwzDxkPuDP-?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "tracks": {
    "data": [
      {
        "id": "Cl6IBBqIFKtg2hkWuB",
        "name": "有一種悲傷 (A Kind of Sorrow)",
        "duration": 237008,
        "url": "https://www.kkbox.com/tw/tc/song/EJT009KS-TZFBgeRFBgeR0XL-index.html",
        "track_number": 1,
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "album": {
          "id": "OtS1j6YhEqbM8XuF5D",
          "name": "有一種悲傷 (A Kind of Sorrow)",
          "url": "https://www.kkbox.com/tw/tc/album/aMZ0PysNRqgHN0F2RKf6009H-index.html",
          "explicitness": false,
          "available_territories": [
            "TW",
            "HK",
            "SG",
            "MY",
            "JP"
          ],
          "release_date": "2018-10-12",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/global/40716998,1v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/global/40716998,1v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/global/40716998,1v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "Osbh3TUzyafhBl0WD5",
            "name": "A-Lin",
            "url": "https://www.kkbox.com/tw/tc/artist/RTQrEhYKUkU5NCX0F03LZ08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/13667,0v22/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/13667,0v22/fit/300x300.jpg"
              }
            ]
          }
        }
      }....
    ],
  "updated_at": "2018-12-12T19:38:46+00:00",
  "owner": {
    "id": "T-YMdq3gnf6AVbuqgt",
    "url": "https://www.kkbox.com/tw/profile/T-YMdq3gnf6AVbuqgt",
    "name": "KKBOX",
    "description": "",
    "images": [
      {
        "height": 75,
        "width": 75,
        "url": "https://i.kfs.io/muser/global/noimg/cropresize/75x75.jpg"
      },
      {
        "height": 180,
        "width": 180,
        "url": "https://i.kfs.io/muser/global/noimg/cropresize/180x180.jpg"
      },
      {
        "height": 300,
        "width": 300,
        "url": "https://i.kfs.io/muser/global/noimg/cropresize/300x300.jpg"
      }
    ]
  }
}

Path Params

chart_id
string
required

音樂排行榜 ID

Query Params

territory
string
required

地區參數,取得該地區的歌曲資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/charts/:chart_id/tracks

使用 playlist_id 取得該音樂排行榜的歌曲列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/charts/chart_id/tracks
GET /v1.1/charts/X-6lSz-IwzDxkPuDP-/tracks?territory=TW&limit=2 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "Cl6IBBqIFKtg2hkWuB",
      "name": "有一種悲傷 (A Kind of Sorrow)",
      "duration": 237008,
      "url": "https://www.kkbox.com/tw/tc/song/EJT009KS-TZFBgeRFBgeR0XL-index.html",
      "track_number": 1,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "OtS1j6YhEqbM8XuF5D",
        "name": "有一種悲傷 (A Kind of Sorrow)",
        "url": "https://www.kkbox.com/tw/tc/album/aMZ0PysNRqgHN0F2RKf6009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2018-10-12",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/40716998,1v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/40716998,1v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/40716998,1v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "Osbh3TUzyafhBl0WD5",
          "name": "A-Lin",
          "url": "https://www.kkbox.com/tw/tc/artist/RTQrEhYKUkU5NCX0F03LZ08J-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/13667,0v22/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/13667,0v22/fit/300x300.jpg"
            }
          ]
        }
      }
    },
    {
      "id": "CrmRXkVxa7_3NcU5lL",
      "name": "備胎 (feat. Eetu Kalavainen)",
      "duration": 272013,
      "url": "https://www.kkbox.com/tw/tc/song/ydR00K7A0TnUF7q5UF7q50XL-index.html",
      "track_number": 1,
      "explicitness": true,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "PX-NUOP3Q7mrw8OHOO",
        "name": "備胎 (feat. Eetu Kalavainen)",
        "url": "https://www.kkbox.com/tw/tc/album/GPk7Uh328ma8L0F2XdRF009H-index.html",
        "explicitness": true,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2018-11-29",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/42374863,1v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/42374863,1v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/42374863,1v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "4nnlQg-K2KLL4Qwdrg",
          "name": "謝和弦 (R-chord)",
          "url": "https://www.kkbox.com/tw/tc/artist/E0hu.wEuV-BsvmQ0F09mG08J-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/40080,0v12/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/40080,0v12/fit/300x300.jpg"
            }
          ]
        }
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 2,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/charts/X-6lSz-IwzDxkPuDP-/tracks?limit=2&territory=TW&offset=2"
  },
  "summary": {
    "total": 100
  }
}

Path Params

chart_id
string
required

音樂排行榜 ID

Query Params

territory
string
required

地區參數,取得該地區的歌曲資料。可使用 TW, HK, SG, MY, JP

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

New Hits Playlists

 
Suggest Edits

/new-hits-playlists

取得最新熱門歌單列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/new-hits-playlists
GET /v1.1/new-hits-playlists?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "DZrC8m29ciOFY2JAm3",
      "title": "華語速爆新歌 (每週二五更新)",
      "description": "【封面人物:曾沛慈】\n大受好評華語歌壇重量級速爆歌單,\n收藏一張歌單,流行最強音零時差搶先收聽。",
      "url": "https://www.kkbox.com/tw/tc/playlist/DZrC8m29ciOFY2JAm3",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/26541395v263/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/26541395v263/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/26541395v263/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-07-30T10:13:43+00:00",
      "owner": {
        "id": "Os-z4yYPRlzOAkzZm3",
        "url": "https://www.kkbox.com/tw/profile/Os-z4yYPRlzOAkzZm3",
        "name": "KKBOX 華語小編",
        "description": "這次我要播很多 華語 類別的歌曲,快來跟我一起聽音樂吧!",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/94562966v27/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/94562966v27/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/94562966v27/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "DZni8m29ciOFbRxTJq",
      "title": "西洋速爆新歌  (每週六更新)",
      "description": "最新西洋新歌都在這裡!Cover:Alan Walker",
      "url": "https://www.kkbox.com/tw/tc/playlist/DZni8m29ciOFbRxTJq",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/26541409v142/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/26541409v142/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/26541409v142/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-07-27T03:12:14+00:00",
      "owner": {
        "id": "5XIttVqe0foATcIFMp",
        "url": "https://www.kkbox.com/tw/profile/5XIttVqe0foATcIFMp",
        "name": "KKBOX 西洋小編",
        "description": "",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/94563062v1/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/94563062v1/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/94563062v1/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "1_pCwOnj-qZsGU3rTJ",
      "title": "日語速爆新歌(每週日更新)",
      "description": "最新日語新歌都在這裡!\n\nCover Artist:愛繆",
      "url": "https://www.kkbox.com/tw/tc/playlist/1_pCwOnj-qZsGU3rTJ",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/26541410v126/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/26541410v126/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/26541410v126/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-07-26T08:01:46+00:00",
      "owner": {
        "id": "Ooerjv5-p-TJsFGLg5",
        "url": "https://www.kkbox.com/tw/profile/Ooerjv5-p-TJsFGLg5",
        "name": "KKBOX 日語小編",
        "description": "",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/94563302v1/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/94563302v1/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/94563302v1/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "0kM_Sp_Ezou3BMGK-n",
      "title": "韓語速爆新歌 (每週一更新)",
      "description": "最新韓語新歌都在這裡!\nCover Artist:姜丹尼爾",
      "url": "https://www.kkbox.com/tw/tc/playlist/0kM_Sp_Ezou3BMGK-n",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/26541412v131/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/26541412v131/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/26541412v131/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-08-01T03:39:32+00:00",
      "owner": {
        "id": "D-gh_8TEudW64tRSCs",
        "url": "https://www.kkbox.com/tw/profile/D-gh_8TEudW64tRSCs",
        "name": "KKBOX 韓語小編",
        "description": "",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/94563350v1/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/94563350v1/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/94563350v1/cropresize/300x300.jpg"
          }
        ]
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 5,
    "previous": null,
    "next": null
  },
  "summary": {
    "total": 4
  }
}

Query Params

territory
string
required

地區參數,取得該地區的最新熱門歌單資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/new-hits-playlists/:playlist_id

使用 playlist_id 取得該最新熱門歌單的資料。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/new-hits-playlists/playlist_id
GET /v1.1/new-hits-playlists/DZrC8m29ciOFY2JAm3?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "tracks": {
    "data": [
      {
        "id": "WpOR92XbaMOw9-5qhi",
        "name": "謎之音 (Confession)",
        "duration": 265691,
        "url": "https://www.kkbox.com/tw/tc/song/JFs00H.4ZH-RiJY8RiJY80XL-index.html",
        "track_number": 1,
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "album": {
          "id": "Ol6Nm-x5CCud88oW2-",
          "name": "謎之音 (Confession)",
          "url": "https://www.kkbox.com/tw/tc/album/SkqaUAPZS2gFu0F3Tz3N009H-index.html",
          "explicitness": false,
          "available_territories": [
            "TW",
            "HK",
            "SG",
            "MY",
            "JP"
          ],
          "release_date": "2019-07-26",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/global/58192087,1v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/global/58192087,1v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/global/58192087,1v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "0t3qKleq91sO_PChVT",
            "name": "曾沛慈 (Pets Tseng)",
            "url": "https://www.kkbox.com/tw/tc/artist/XPFR3oF3.0Dh890F03rWf08K-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/1013803,0v5/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/1013803,0v5/fit/300x300.jpg"
              }
            ]
          }
        }
      },
      {
        "id": "9-Gl4RJfF6qQ0WU7dr",
        "name": "兩秒終 (2 Seconds)",
        "duration": 220473,
        "url": "https://www.kkbox.com/tw/tc/song/eUb00W15WD-jkBmgjkBmg0XL-index.html",
        "track_number": 3,
        "explicitness": true,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "album": {
          "id": "PavDxuKhDe7LXcxCwo",
          "name": "WHAT A LIFE",
          "url": "https://www.kkbox.com/tw/tc/album/UGQdQ3-uysUVU0F3VCL.009H-index.html",
          "explicitness": true,
          "available_territories": [
            "TW",
            "HK",
            "SG",
            "MY",
            "JP"
          ],
          "release_date": "2019-07-25",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/global/58508645,0v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/global/58508645,0v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/global/58508645,0v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "4pCYG3uv_-WY5d9QYt",
            "name": "周湯豪 (NICKTHEREAL)",
            "url": "https://www.kkbox.com/tw/tc/artist/RMbSPqW5.xeUHFK0F0CqQ08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/52634,0v5/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/52634,0v5/fit/300x300.jpg"
              }
            ]
          }
        }
      },
      {
        "id": "SqrAF0uNV6Obwu2w1w",
        "name": "simple",
        "duration": 169534,
        "url": "https://www.kkbox.com/tw/tc/song/1GX00C3TNH-I6jYOI6jYO0XL-index.html",
        "track_number": 1,
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "album": {
          "id": "8pHFTC4cvmYiMRIm5j",
          "name": "simple",
          "url": "https://www.kkbox.com/tw/tc/album/x86rxvWwRBZLO0F3Wagx009H-index.html",
          "explicitness": false,
          "available_territories": [
            "TW",
            "HK",
            "SG",
            "MY",
            "JP"
          ],
          "release_date": "2019-07-26",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/global/58878781,0v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/global/58878781,0v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/global/58878781,0v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "8sh6QVl8zbMOksEAKR",
            "name": "葛仲珊 (MISS KO)",
            "url": "https://www.kkbox.com/tw/tc/artist/mjv4v-5-0dn.j5g0F0wVp08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/247797,0v5/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/247797,0v5/fit/300x300.jpg"
              }
            ]
          }
        }
      },
    ],
    "paging": {
      "offset": 0,
      "limit": 100,
      "previous": null,
      "next": null
    },
    "summary": {
      "total": 51
    }
  },
  "id": "DZrC8m29ciOFY2JAm3",
  "title": "華語速爆新歌 (每週二五更新)",
  "description": "【封面人物:曾沛慈】\n大受好評華語歌壇重量級速爆歌單,\n收藏一張歌單,流行最強音零時差搶先收聽。",
  "url": "https://www.kkbox.com/tw/tc/playlist/DZrC8m29ciOFY2JAm3",
  "images": [
    {
      "height": 300,
      "width": 300,
      "url": "https://i.kfs.io/playlist/global/26541395v263/cropresize/300x300.jpg"
    },
    {
      "height": 600,
      "width": 600,
      "url": "https://i.kfs.io/playlist/global/26541395v263/cropresize/600x600.jpg"
    },
    {
      "height": 1000,
      "width": 1000,
      "url": "https://i.kfs.io/playlist/global/26541395v263/cropresize/1000x1000.jpg"
    }
  ],
  "updated_at": "2019-07-30T10:13:43+00:00",
  "owner": {
    "id": "Os-z4yYPRlzOAkzZm3",
    "url": "https://www.kkbox.com/tw/profile/Os-z4yYPRlzOAkzZm3",
    "name": "KKBOX 華語小編",
    "description": "這次我要播很多 華語 類別的歌曲,快來跟我一起聽音樂吧!",
    "images": [
      {
        "height": 75,
        "width": 75,
        "url": "https://i.kfs.io/muser/global/94562966v27/cropresize/75x75.jpg"
      },
      {
        "height": 180,
        "width": 180,
        "url": "https://i.kfs.io/muser/global/94562966v27/cropresize/180x180.jpg"
      },
      {
        "height": 300,
        "width": 300,
        "url": "https://i.kfs.io/muser/global/94562966v27/cropresize/300x300.jpg"
      }
    ]
  }
}

Path Params

playlist_id
string
required

最新熱門歌單 ID

Query Params

territory
string
required

地區參數,取得該地區的歌曲資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/new-hits-playlists/:playlist_id/tracks

使用 playlist_id 取得該熱門歌單的歌曲列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/new-hits-playlists/playlist_id/tracks
GET /v1.1/new-hits-playlists/DZrC8m29ciOFY2JAm3/tracks?territory=TW&limit=3 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "WpOR92XbaMOw9-5qhi",
      "name": "謎之音 (Confession)",
      "duration": 265691,
      "url": "https://www.kkbox.com/tw/tc/song/JFs00H.4ZH-RiJY8RiJY80XL-index.html",
      "track_number": 1,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "Ol6Nm-x5CCud88oW2-",
        "name": "謎之音 (Confession)",
        "url": "https://www.kkbox.com/tw/tc/album/SkqaUAPZS2gFu0F3Tz3N009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2019-07-26",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/58192087,1v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/58192087,1v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/58192087,1v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "0t3qKleq91sO_PChVT",
          "name": "曾沛慈 (Pets Tseng)",
          "url": "https://www.kkbox.com/tw/tc/artist/XPFR3oF3.0Dh890F03rWf08K-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/1013803,0v5/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/1013803,0v5/fit/300x300.jpg"
            }
          ]
        }
      }
    },
    {
      "id": "9-Gl4RJfF6qQ0WU7dr",
      "name": "兩秒終 (2 Seconds)",
      "duration": 220473,
      "url": "https://www.kkbox.com/tw/tc/song/eUb00W15WD-jkBmgjkBmg0XL-index.html",
      "track_number": 3,
      "explicitness": true,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "PavDxuKhDe7LXcxCwo",
        "name": "WHAT A LIFE",
        "url": "https://www.kkbox.com/tw/tc/album/UGQdQ3-uysUVU0F3VCL.009H-index.html",
        "explicitness": true,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2019-07-25",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/58508645,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/58508645,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/58508645,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "4pCYG3uv_-WY5d9QYt",
          "name": "周湯豪 (NICKTHEREAL)",
          "url": "https://www.kkbox.com/tw/tc/artist/RMbSPqW5.xeUHFK0F0CqQ08J-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/52634,0v5/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/52634,0v5/fit/300x300.jpg"
            }
          ]
        }
      }
    },
    {
      "id": "SqrAF0uNV6Obwu2w1w",
      "name": "simple",
      "duration": 169534,
      "url": "https://www.kkbox.com/tw/tc/song/1GX00C3TNH-I6jYOI6jYO0XL-index.html",
      "track_number": 1,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "8pHFTC4cvmYiMRIm5j",
        "name": "simple",
        "url": "https://www.kkbox.com/tw/tc/album/x86rxvWwRBZLO0F3Wagx009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2019-07-26",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/58878781,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/58878781,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/58878781,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "8sh6QVl8zbMOksEAKR",
          "name": "葛仲珊 (MISS KO)",
          "url": "https://www.kkbox.com/tw/tc/artist/mjv4v-5-0dn.j5g0F0wVp08J-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/247797,0v5/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/247797,0v5/fit/300x300.jpg"
            }
          ]
        }
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 3,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/new-hits-playlists/DZrC8m29ciOFY2JAm3/tracks?limit=3&territory=TW&offset=3"
  },
  "summary": {
    "total": 51
  }
}

Path Params

playlist_id
string
required

最新熱門歌單 ID

Query Params

territory
string
required

地區參數,取得該地區的歌曲資料。可使用 TW, HK, SG, MY, JP

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

New Release Categories

 
Suggest Edits

/new-release-categories

取得最新發行專輯類別列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/new-release-categories
GET /v1.1/new-release-categories?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "KrdH2LdyUKS8z2aoxX",
      "title": "綜合"
    },
    {
      "id": "Cng5IUIQhxb8w1cbsz",
      "title": "華語"
    },
    {
      "id": "CkgxHJdAgNrEruEDza",
      "title": "西洋"
    },
    {
      "id": "4pVhRTE2XjCwnJfQRn",
      "title": "韓語"
    },
    {
      "id": "-nap5A1iST1A6Ny3ze",
      "title": "日語"
    },
    {
      "id": "1ZQwmFTaLE4p7BG-Ua",
      "title": "台語"
    },
    {
      "id": "GtN6qomUYBvqtWeRP8",
      "title": "粵語"
    },
    {
      "id": "HaGEkt7m7GQpGZOizF",
      "title": "原聲帶"
    },
    {
      "id": "8oroiyJSZINEq8f7Nc",
      "title": "電子"
    },
    {
      "id": "0oiRsbGpPKxymZD1Lg",
      "title": "嘻哈"
    },
    {
      "id": "XZjUObcyRqcInHd62v",
      "title": "R&B"
    },
    {
      "id": "KsOPYl5NAnG7rpnWpe",
      "title": "搖滾"
    },
    {
      "id": "Ksfvcl5NAnG7pjDuca",
      "title": "另類/獨立"
    },
    {
      "id": "Cod1x4lH1l7Y1dhuy4",
      "title": "靈魂樂"
    },
    {
      "id": "LX484KR5HnYUt4luvG",
      "title": "鄉村"
    },
    {
      "id": "0nyjA5B6Bj-8DkdXVI",
      "title": "雷鬼"
    },
    {
      "id": "0pGAIGDf5SqYh_SyHr",
      "title": "藍調歌曲"
    },
    {
      "id": "5YLZUQJX6npjoGcFdr",
      "title": "有聲書/相聲"
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 50,
    "previous": null,
    "next": null
  },
  "summary": {
    "total": 18
  }
}
{
  "error": {
    "message": "Invalid Territory",
    "code": 0
  }
}

Query Params

territory
string
required

地區參數,取得該地區的最新發行類別資料。可使用 TW, HK, SG, MY, JP

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

/new-release-categories/:category_id

使用 category_id 取得該最新發行專輯類別的資料。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/new-release-categories/category_id
GET /v1.1/new-release-categories/1ZQwmFTaLE4p7BG-Ua?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "id": "1ZQwmFTaLE4p7BG-Ua",
  "title": "台語",
  "albums": {
    "data": [
      {
        "id": "8tH-BDNMZgqWexd-LS",
        "name": "無你惦身邊 (Long Distance Relationship)",
        "url": "https://www.kkbox.com/tw/tc/album/lf-b9ejuhjUI-0F3V.y2009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2019-08-01",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/58613634,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/58613634,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/58613634,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "Cr1MGNx2Y7UDAI8Cth",
          "name": "魏嘉榆",
          "url": "https://www.kkbox.com/tw/tc/artist/ERROlu4B5PP6.Y0F0Dngd08K-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/3619625,0v1/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/3619625,0v1/fit/300x300.jpg"
            }
          ]
        }
      },
      {
        "id": "WoJGwjRnYBvu8I7Z8n",
        "name": "咱的膨紗衫",
        "url": "https://www.kkbox.com/tw/tc/album/5HD8jxEsxTljC0F3YlV2009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2019-07-31",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/59447234,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/59447234,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/59447234,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "__Zt5ICtv1wl2B0drt",
          "name": "王瑞霞",
          "url": "https://www.kkbox.com/tw/tc/artist/3sTqVU9OIzsit1DU0F0Ns08I-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/1528,0v1/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/1528,0v1/fit/300x300.jpg"
            }
          ]
        }
      },
      {
        "id": "-rACvEbp1XBjKwFpGe",
        "name": "愛到底",
        "url": "https://www.kkbox.com/tw/tc/album/02ZzYbMMivLZy0F3XJoE009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2019-07-24",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/59063566,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/59063566,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/59063566,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "9ZvjQ3i6Jj_jLQm727",
          "name": "白冰冰",
          "url": "https://www.kkbox.com/tw/tc/artist/03oq-55HsAIhveH0F01Wv08J-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/6203,0v1/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/6203,0v1/fit/300x300.jpg"
            }
          ]
        }
      },
      {
        "id": "PYBSkUqmqns_RzyIci",
        "name": "爸爸",
        "url": "https://www.kkbox.com/tw/tc/album/CCMkoa9qqfRKt0F3XG0R009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2019-07-24",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/59047963,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/59047963,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/59047963,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "-ptBFzWlb8HCQypwkd",
          "name": "顏千翔",
          "url": "https://www.kkbox.com/tw/tc/artist/OqBCtUOPhyING0F011fbV08L-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/tw/noimg/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/tw/noimg/fit/300x300.jpg"
            }
          ]
        }
      },
      {
        "id": "-nlaaCE4NWEdaOICHN",
        "name": "終愛",
        "url": "https://www.kkbox.com/tw/tc/album/vCV8cstfqZ8eT0F3WnHr009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2019-07-23",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/58930295,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/58930295,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/58930295,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "L_hPERzqgunFPnzaIP",
          "name": "陳采捷 (CAI JIE)",
          "url": "https://www.kkbox.com/tw/tc/artist/f4aHazN.JwiwG0F011-qh08L-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/tw/noimg/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/tw/noimg/fit/300x300.jpg"
            }
          ]
        }
      }
    ],
    "paging": {
      "offset": 0,
      "limit": 5,
      "previous": null,
      "next": null
    },
    "summary": {
      "total": 21
    }
  }
}
{
  "error": {
    "message": "Invalid Territory",
    "code": 0
  }
}
{
  "error": {
    "message": "Resource does not exist",
    "code": 0
  }
}

Path Params

category_id
string
required

最新發行專輯類別 ID

Query Params

territory
string
required

地區參數,取得該地區的最新發行類別資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/new-release-categories/:category_id/albums

使用 category_id 取得該最新發行專輯類別的專輯列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/new-release-categories/category_id/albums
GET /v1.1/new-release-categories/1ZQwmFTaLE4p7BG-Ua/albums?territory=TW&limit=5 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "8tH-BDNMZgqWexd-LS",
      "name": "無你惦身邊 (Long Distance Relationship)",
      "url": "https://www.kkbox.com/tw/tc/album/lf-b9ejuhjUI-0F3V.y2009H-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "release_date": "2019-08-01",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/global/58613634,0v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/global/58613634,0v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/global/58613634,0v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "Cr1MGNx2Y7UDAI8Cth",
        "name": "魏嘉榆",
        "url": "https://www.kkbox.com/tw/tc/artist/ERROlu4B5PP6.Y0F0Dngd08K-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/3619625,0v1/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/3619625,0v1/fit/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "WoJGwjRnYBvu8I7Z8n",
      "name": "咱的膨紗衫",
      "url": "https://www.kkbox.com/tw/tc/album/5HD8jxEsxTljC0F3YlV2009H-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "release_date": "2019-07-31",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/global/59447234,0v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/global/59447234,0v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/global/59447234,0v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "__Zt5ICtv1wl2B0drt",
        "name": "王瑞霞",
        "url": "https://www.kkbox.com/tw/tc/artist/3sTqVU9OIzsit1DU0F0Ns08I-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/1528,0v1/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/1528,0v1/fit/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "-rACvEbp1XBjKwFpGe",
      "name": "愛到底",
      "url": "https://www.kkbox.com/tw/tc/album/02ZzYbMMivLZy0F3XJoE009H-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "release_date": "2019-07-24",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/global/59063566,0v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/global/59063566,0v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/global/59063566,0v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "9ZvjQ3i6Jj_jLQm727",
        "name": "白冰冰",
        "url": "https://www.kkbox.com/tw/tc/artist/03oq-55HsAIhveH0F01Wv08J-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/6203,0v1/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/6203,0v1/fit/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "PYBSkUqmqns_RzyIci",
      "name": "爸爸",
      "url": "https://www.kkbox.com/tw/tc/album/CCMkoa9qqfRKt0F3XG0R009H-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "release_date": "2019-07-24",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/global/59047963,0v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/global/59047963,0v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/global/59047963,0v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "-ptBFzWlb8HCQypwkd",
        "name": "顏千翔",
        "url": "https://www.kkbox.com/tw/tc/artist/OqBCtUOPhyING0F011fbV08L-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/tw/noimg/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/tw/noimg/fit/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "-nlaaCE4NWEdaOICHN",
      "name": "終愛",
      "url": "https://www.kkbox.com/tw/tc/album/vCV8cstfqZ8eT0F3WnHr009H-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "release_date": "2019-07-23",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/global/58930295,0v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/global/58930295,0v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/global/58930295,0v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "L_hPERzqgunFPnzaIP",
        "name": "陳采捷 (CAI JIE)",
        "url": "https://www.kkbox.com/tw/tc/artist/f4aHazN.JwiwG0F011-qh08L-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/tw/noimg/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/tw/noimg/fit/300x300.jpg"
          }
        ]
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 5,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/new-release-categories/1ZQwmFTaLE4p7BG-Ua/albums?limit=5&territory=TW&offset=5"
  },
  "summary": {
    "total": 21
  }
}
{
  "error": {
    "message": "Invalid Territory",
    "code": 0
  }
}
{
  "error": {
    "message": "Resource does not exist",
    "code": 0
  }
}

Path Params

category_id
string
required

最新發行專輯類別 ID

Query Params

territory
string
required

地區參數,取得該地區的專輯資料。可使用 TW, HK, SG, MY, JP

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

Featured Playlist Categories

 
Suggest Edits

Featured Playlists

 
Suggest Edits

Shared Playlists

 
Suggest Edits

/shared-playlists/:playlist_id

使用 playlist_id 取得該公開分享歌單的資料。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/shared-playlists/playlist_id
GET /v1.1/shared-playlists/4nUZM-TY2aVxZ2xaA-?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "tracks": {
    "data": [
      {
        "id": "SsJItLYfDXYxalPgtU",
        "name": "這個世界",
        "duration": 240195,
        "url": "https://www.kkbox.com/tw/tc/song/NKl00LGCdYHWnLsZWnLsZ0XL-index.html",
        "track_number": 12,
        "explicitness": false,
        "available_territories": [
          "TW"
        ],
        "album": {
          "id": "CnWnDaRF4d6Z3EgCnv",
          "name": "這個世界 (This World)",
          "url": "https://www.kkbox.com/tw/tc/album/EPWsiNVmD5o7V0F193Zv009H-index.html",
          "explicitness": false,
          "available_territories": [
            "TW"
          ],
          "release_date": "2016-10-12",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/global/19151099,0v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/global/19151099,0v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/global/19151099,0v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "-lm_2ldXI0rBCMeriC",
            "name": "蔡藍欽",
            "url": "https://www.kkbox.com/tw/tc/artist/h-lOMWJF9LIrmo80F01Dn08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/4979,0v1/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/4979,0v1/fit/300x300.jpg"
              }
            ]
          }
        }
      },
      {
        "id": "-kQ0G1lzMveSbRJI1h",
        "name": "這個世界",
        "duration": 268956,
        "url": "https://www.kkbox.com/tw/tc/song/LKT-Nvm0x00w7Y91vH1vH0On-index.html",
        "track_number": 25,
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "album": {
          "id": "KqoKCbzKOnJP4qBEAZ",
          "name": "當我們混在一起 2005 演唱會 Live 全記錄",
          "url": "https://www.kkbox.com/tw/tc/album/.3-abKn7x-jiu1a0FDMp008l-index.html",
          "explicitness": false,
          "available_territories": [
            "TW",
            "HK",
            "SG",
            "MY",
            "JP"
          ],
          "release_date": "2005-05-27",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/tw/54709,0v3/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/tw/54709,0v3/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/tw/54709,0v3/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "9XN-7yg5vg3gYnCdsM",
            "name": "五月天 (Mayday)",
            "url": "https://www.kkbox.com/tw/tc/artist/Tqyk2VnYD3.Md.I0F01bv08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/6651,0v9/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/6651,0v9/fit/300x300.jpg"
              }
            ]
          }
        }
      },
    ],
    "paging": {
      "offset": 0,
      "limit": 100,
      "previous": null,
      "next": null
    },
    "summary": {
      "total": 10
    }
  },
  "id": "4nUZM-TY2aVxZ2xaA-",
  "title": "各種版本的「這個世界」",
  "description": "原來曾經有這麼多人重唱過「你的世界」",
  "url": "https://www.kkbox.com/tw/tc/playlist/4nUZM-TY2aVxZ2xaA-",
  "images": [
    {
      "height": 300,
      "width": 300,
      "url": "https://i.kfs.io/playlist/global/39885447v1/cropresize/300x300.jpg"
    },
    {
      "height": 600,
      "width": 600,
      "url": "https://i.kfs.io/playlist/global/39885447v1/cropresize/600x600.jpg"
    },
    {
      "height": 1000,
      "width": 1000,
      "url": "https://i.kfs.io/playlist/global/39885447v1/cropresize/1000x1000.jpg"
    }
  ],
  "updated_at": "2016-10-18T08:15:09+00:00",
  "owner": {
    "id": "CoiM4s7qXvCTQBLstX",
    "url": "https://www.kkbox.com/tw/profile/CoiM4s7qXvCTQBLstX",
    "name": "澳門首家線上__",
    "description": "http://about.me/honglong",
    "images": [
      {
        "height": 75,
        "width": 75,
        "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/75x75.jpg"
      },
      {
        "height": 180,
        "width": 180,
        "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/180x180.jpg"
      },
      {
        "height": 300,
        "width": 300,
        "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/300x300.jpg"
      }
    ]
  }
}

Path Params

playlist_id
string
required

公開分享歌單 ID

Query Params

territory
string
required

地區參數,取得該地區的歌曲資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/shared-playlists/:playlist_id/tracks

使用 playlist_id 取得該公開分享歌單的歌曲列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/shared-playlists/playlist_id/tracks
GET /v1.1/shared-playlists/4nUZM-TY2aVxZ2xaA-/tracks?territory=TW&limit=3 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "SsJItLYfDXYxalPgtU",
      "name": "這個世界",
      "duration": 240195,
      "url": "https://www.kkbox.com/tw/tc/song/NKl00LGCdYHWnLsZWnLsZ0XL-index.html",
      "track_number": 12,
      "explicitness": false,
      "available_territories": [
        "TW"
      ],
      "album": {
        "id": "CnWnDaRF4d6Z3EgCnv",
        "name": "這個世界 (This World)",
        "url": "https://www.kkbox.com/tw/tc/album/EPWsiNVmD5o7V0F193Zv009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW"
        ],
        "release_date": "2016-10-12",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/19151099,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/19151099,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/19151099,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "-lm_2ldXI0rBCMeriC",
          "name": "蔡藍欽",
          "url": "https://www.kkbox.com/tw/tc/artist/h-lOMWJF9LIrmo80F01Dn08J-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/4979,0v1/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/4979,0v1/fit/300x300.jpg"
            }
          ]
        }
      }
    },
    {
      "id": "-kQ0G1lzMveSbRJI1h",
      "name": "這個世界",
      "duration": 268956,
      "url": "https://www.kkbox.com/tw/tc/song/LKT-Nvm0x00w7Y91vH1vH0On-index.html",
      "track_number": 25,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "KqoKCbzKOnJP4qBEAZ",
        "name": "當我們混在一起 2005 演唱會 Live 全記錄",
        "url": "https://www.kkbox.com/tw/tc/album/.3-abKn7x-jiu1a0FDMp008l-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2005-05-27",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/tw/54709,0v3/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/tw/54709,0v3/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/tw/54709,0v3/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "9XN-7yg5vg3gYnCdsM",
          "name": "五月天 (Mayday)",
          "url": "https://www.kkbox.com/tw/tc/artist/Tqyk2VnYD3.Md.I0F01bv08J-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/6651,0v9/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/6651,0v9/fit/300x300.jpg"
            }
          ]
        }
      }
    },
    {
      "id": "0oVpLhDXhv4OSjm_fJ",
      "name": "這個世界",
      "duration": 234370,
      "url": "https://www.kkbox.com/tw/tc/song/erPcI2o01.aG47W547W540P4-index.html",
      "track_number": 6,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "__v-2rnU8IHVqOOmz9",
        "name": "黃鶯鶯搖籃曲",
        "url": "https://www.kkbox.com/tw/tc/album/LBvK2LMIsY7XwR0F1LyF0091-index.html",
        "explicitness": false,
        "available_territories": [
          "HK",
          "MY",
          "JP",
          "TW",
          "SG"
        ],
        "release_date": "2012-07-02",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/tw/352143,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/tw/352143,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/tw/352143,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "GsuNkAHedyFlIFnpAU",
          "name": "黃鶯鶯 (Tracy Huang)",
          "url": "https://www.kkbox.com/tw/tc/artist/Pu.C.nO1c58lTBej0F05f08I-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/363,0v1/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/363,0v1/fit/300x300.jpg"
            }
          ]
        }
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 3,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/shared-playlists/4nUZM-TY2aVxZ2xaA-/tracks?limit=3&territory=TW&offset=3"
  },
  "summary": {
    "total": 10
  }
}

Path Params

playlist_id
string
required

公開分享歌單 ID

Query Params

territory
string
required

地區參數,取得該地區的歌曲資料。可使用 TW, HK, SG, MY, JP

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

Genre Stations

 
Suggest Edits

/genre-stations

取得曲風電台列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/genre-stations
GET /v1.1/genre-stations?territory=TW&limit=10 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "TYq3EHFTl-1EOvJM5Y",
      "category": "Mandarin",
      "name": "Mandarin New Release"
    },
    {
      "id": "SrGnPsRNdLGo2-QD4_",
      "category": "Mandarin",
      "name": "Mandopop Male"
    },
    {
      "id": "KmH_kXscZ40s9YgvHo",
      "category": "Mandarin",
      "name": "Mandopop Female"
    },
    {
      "id": "WoqzVWL-LKrtawiYGT",
      "category": "Mandarin",
      "name": "Mandopop Group"
    },
    {
      "id": "DZFgBL_02ygfJq12I0",
      "category": "Mandarin",
      "name": "Mandopop Duet"
    },
    {
      "id": "Wmm-aBHQWjQ0swnWFc",
      "category": "Mandarin",
      "name": "Mandopop Idol"
    },
    {
      "id": "CrUb2t-gr2k6sxUxH5",
      "category": "Mandarin",
      "name": "Love Song"
    },
    {
      "id": "OlKxmKz5tfab39jlx_",
      "category": "Mandarin",
      "name": "Karaoke Hits"
    },
    {
      "id": "LaN6zM2q9ZeLxC790i",
      "category": "Mandarin",
      "name": "Golden Melody Award Winner"
    },
    {
      "id": "Wmn-aBHQWjQ0vtJ5mX",
      "category": "Mandarin",
      "name": "Mandarin Film & TV Songs"
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 10,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/genre-stations?limit=10&territory=TW&offset=10"
  },
  "summary": {
    "total": 188
  }
}

Query Params

territory
string
required

地區參數,取得該地區的曲風電台資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/genre-stations/:genre_station_id

使用 genre_station_id 取得該曲風電台的資料。
每次回傳的歌曲隨機排序。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/genre-stations/genre_station_id
GET /v1.1/genre-stations/9ax4APKMtg7NqOqhNp?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "id": "9ax4APKMtg7NqOqhNp",
  "category": "Hokkien",
  "name": "Classic Hokkien Duet",
  "tracks": {
    "data": [
      {
        "id": "Hatg1yFFE8K3YEuzH4",
        "name": "無人來作伴",
        "duration": 236773,
        "url": "https://www.kkbox.com/tw/tc/song/Lwqxf1pKO424W52M4W52M0PL-index.html",
        "track_number": 9,
        "explicitness": false,
        "available_territories": [
          "TW"
        ],
        "album": {
          "id": "9Z8fmhgn_BzuOzEEta",
          "name": "男性的堅持-精選集",
          "url": "https://www.kkbox.com/tw/tc/album/RJYE1yzo3dF2Dh0F7M9q0091-index.html",
          "explicitness": false,
          "available_territories": [
            "TW"
          ],
          "release_date": "2010-04-26",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/tw/1925750,0v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/tw/1925750,0v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/tw/1925750,0v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "5X4ebVHk-xgqdNMH5b",
            "name": "翁立友",
            "url": "https://www.kkbox.com/tw/tc/artist/vVCqxCo08XWxw9w0F09hP08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/39769,0v1/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/39769,0v1/fit/300x300.jpg"
              }
            ]
          }
        }
      },
      {
        "id": "Kq2tpviB3UapG1sNLm",
        "name": "心愛請保重",
        "duration": 334576,
        "url": "https://www.kkbox.com/tw/tc/song/S25EH7L06YK9nQJB1QJB10P4-index.html",
        "track_number": 1,
        "explicitness": false,
        "available_territories": [
          "TW"
        ],
        "album": {
          "id": "8pBN1E4svmYiPQ12SJ",
          "name": "心愛請保重",
          "url": "https://www.kkbox.com/tw/tc/album/UnjfyLMk8HwPn40F1E8.0091-index.html",
          "explicitness": false,
          "available_territories": [
            "TW"
          ],
          "release_date": "1999-08-04",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/tw/320037,0v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/tw/320037,0v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/tw/320037,0v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "GqW_sKigyaDAkjTMdC",
            "name": "林良歡+許志豪",
            "url": "https://www.kkbox.com/tw/tc/artist/RhHCf7Xb5hNFlBG0F0lEG08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/201616,0v2/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/201616,0v2/fit/300x300.jpg"
              }
            ]
          }
        }
      }
    ],
    "paging": {
      "offset": 0,
      "limit": 100,
      "previous": null,
      "next": null
    },
    "summary": {
      "total": 100
    }
  }
}

Path Params

genre_station_id
string
required

曲風電台 ID

Query Params

territory
string
required

地區參數,取得該地區的曲風電台資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

Mood Stations

 
Suggest Edits

/mood-stations

取得情境電台列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/mood-stations
GET /v1.1/mood-stations?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "StGZp2ToWq92diPHS7",
      "name": "Work Out",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_616.png"
        }
      ]
    },
    {
      "id": "CqKi7kny7nlTW42w5M",
      "name": "Party Animal",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_617.png"
        }
      ]
    },
    {
      "id": "CmJ_Y5mRTWygkTXsYl",
      "name": "Relaxing",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_618.png"
        }
      ]
    },
    {
      "id": "TZZ4fMCHdJNYqHEf-p",
      "name": "Working Time",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_619.png"
        }
      ]
    },
    {
      "id": "4tmrBI125HMtMlO9OF",
      "name": "Romantic",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_620.png"
        }
      ]
    },
    {
      "id": "8oxjHzAAeM8PU8KCw5",
      "name": "Vacation",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_621.png"
        }
      ]
    },
    {
      "id": "HXvnvb5yEReQJAiNMB",
      "name": "Chill Out",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_622.png"
        }
      ]
    },
    {
      "id": "9anYIPKMtg7NqGbiy4",
      "name": "Tipsy Night",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_623.png"
        }
      ]
    },
    {
      "id": "-msVbZnpWLE4CpWBJo",
      "name": "Acoustic Pop",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_624.png"
        }
      ]
    },
    {
      "id": "OkN0EhmweNQdIEGkor",
      "name": "Hardcore",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_625.png"
        }
      ]
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 50,
    "previous": null,
    "next": null
  },
  "summary": {
    "total": 10
  }
}

Query Params

territory
string
required

地區參數,取得該地區的情境電台資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/mood-stations/:mood_station_id

使用 mood_station_id 取得該曲風電台的資料。
每次回傳的歌曲隨機排序。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/mood-stations/mood_station_id
GET /v1.1/mood-stations/-msVbZnpWLE4CpWBJo?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "id": "-msVbZnpWLE4CpWBJo",
  "name": "Acoustic Pop",
  "images": [
    {
      "height": 300,
      "width": 300,
      "url": "https://a.kfs.io/banner/theme-channel/grey_center/channel_624.png"
    }
  ],
  "tracks": {
    "data": [
      {
        "id": "X_vP1g2OxGbE4W_ZX_",
        "name": "My Old Man",
        "duration": 227239,
        "url": "https://www.kkbox.com/tw/tc/song/utF008r8GXIE8sn-E8sn-0XL-index.html",
        "track_number": 6,
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "album": {
          "id": "-oz-uw1c2jy1yqD_W-",
          "name": "Welcome Home",
          "url": "https://www.kkbox.com/tw/tc/album/-LhtthFQXO6cB0F1X6D1009H-index.html",
          "explicitness": false,
          "available_territories": [
            "TW",
            "HK",
            "SG",
            "MY",
            "JP"
          ],
          "release_date": "2017-05-12",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/global/25453377,0v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/global/25453377,0v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/global/25453377,0v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "WtnyvdUWvn57W7ybDj",
            "name": "Zac Brown Band",
            "url": "https://www.kkbox.com/tw/tc/artist/jgq675QS4wfTv6C0F096008J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/37248,0v21/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/37248,0v21/fit/300x300.jpg"
              }
            ]
          }
        }
      },
      {
        "id": "OkiEzeWHwySdIfx6Cn",
        "name": "繼續",
        "duration": 236982,
        "url": "https://www.kkbox.com/tw/tc/song/FlwuVj504O6D2H-a6H-a60P4-index.html",
        "track_number": 6,
        "explicitness": false,
        "available_territories": [
          "TW"
        ],
        "album": {
          "id": "WnZObdD3UikGiIHCzY",
          "name": "從這裡到那裡",
          "url": "https://www.kkbox.com/tw/tc/album/Ozptj15BvzZmpM30Fh9F008l-index.html",
          "explicitness": false,
          "available_territories": [
            "TW"
          ],
          "release_date": "2011-03-31",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/tw/184911,0v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/tw/184911,0v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/tw/184911,0v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "OlYY5KsPZGERMxx2ZV",
            "name": "宇珩",
            "url": "https://www.kkbox.com/tw/tc/artist/7Rd9GlEUHTMhzXk0F0FMA08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/62858,0v1/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/62858,0v1/fit/300x300.jpg"
              }
            ]
          }
        }
      }
    ],
    "paging": {
      "offset": 0,
      "limit": 100,
      "previous": null,
      "next": null
    },
    "summary": {
      "total": 100
    }
  }
}

Path Params

mood_station_id
string
required

情境電台 ID

Query Params

territory
string
required

地區參數,取得該地區的情境電台資料。可使用 TW, HK, SG, MY, JP

 
 
Suggest Edits

/artists/:artist_id

使用 artist_id 取得該歌手的資料。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/artists/artist_id
GET /v1.1/artists/8q3_xzjl89Yakn_7GB?territory=TW HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "id": "8q3_xzjl89Yakn_7GB",
  "name": "滅火器 (Fire EX.)",
  "url": "https://www.kkbox.com/tw/tc/artist/ozHoLIy-jPvlc1P0F06Sb08J-index-1.html",
  "images": [
    {
      "height": 160,
      "width": 160,
      "url": "https://i.kfs.io/artist/global/26407,0v5/fit/160x160.jpg"
    },
    {
      "height": 300,
      "width": 300,
      "url": "https://i.kfs.io/artist/global/26407,0v5/fit/300x300.jpg"
    }
  ]
}

Path Params

artist_id
string
required

歌手 ID

Query Params

territory
string
required

地區參數,取得該地區的歌手資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/artists/:artist_id/albums

使用 artist_id 取得該歌手的專輯列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/artists/artist_id/albums
GET /v1.1/artists/CluDKLYxr1GFQqLSZt/albums?territory=TW&limit=2 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "OrZNXB5eLG7iPlkRfm",
      "name": "The Art of The Ballad",
      "url": "https://www.kkbox.com/tw/tc/album/4nCmXeytdESd4Hu0F7uA008l-index.html",
      "explicitness": false,
      "available_territories": [],
      "release_date": "1970-01-01",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/tw/32394,0v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/tw/32394,0v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/tw/32394,0v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "CluDKLYxr1GFQqLSZt",
        "name": "Dexter Gordon",
        "url": "https://www.kkbox.com/tw/tc/artist/DbKJdlxk96b0RAy0F017308J-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/4547,0v551/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/4547,0v551/fit/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "4mPUAQFE2kVG4kRaM8",
      "name": "Sophisticated Giant",
      "url": "https://www.kkbox.com/tw/tc/album/fhVSzO-E41SO6xx0FE67008l-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY"
      ],
      "release_date": "1997-08-26",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/tw/57735,0v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/tw/57735,0v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/tw/57735,0v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "CluDKLYxr1GFQqLSZt",
        "name": "Dexter Gordon",
        "url": "https://www.kkbox.com/tw/tc/artist/DbKJdlxk96b0RAy0F017308J-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/4547,0v551/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/4547,0v551/fit/300x300.jpg"
          }
        ]
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 2,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/artists/CluDKLYxr1GFQqLSZt/albums?limit=2&territory=TW&offset=2"
  },
  "summary": {
    "total": 801
  }
}

Path Params

artist_id
string
required

歌手 ID

Query Params

territory
string
required

地區參數,取得該地區的專輯資料。可使用 TW, HK, SG, MY, JP

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

/artists/:artist_id/top-tracks

使用 artist_id 取得該歌手的熱門歌曲列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/artists/artist_id/top-tracks
GET /v1.1/artists/GmHEVs8n1D6m6pz6zC/top-tracks?territory=TW&limit=2 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "Pac1gYzqWKr81wzSsi",
      "name": "天空下",
      "duration": 210755,
      "url": "https://www.kkbox.com/tw/tc/song/44-00Hl.maHS8RlzS8Rlz0XL-index.html",
      "track_number": 1,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "_-5I-tcxQDQcUrHUwo",
        "name": "天空下 (Under the Same Sky)",
        "url": "https://www.kkbox.com/tw/tc/album/rxnG8TIB1Pyfc0F19Bt9009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2016-10-17",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/19185225,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/19185225,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/19185225,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "GmHEVs8n1D6m6pz6zC",
          "name": "盧芸 (Rita)",
          "url": "https://www.kkbox.com/tw/tc/artist/ET7BOpmsnU-TAw0F0Pcw708K-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/6721287,0v2/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/6721287,0v2/fit/300x300.jpg"
            }
          ]
        }
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 3,
    "previous": null,
    "next": null
  },
  "summary": {
    "total": 1
  }
}

Path Params

artist_id
string
required

歌手 ID

Query Params

territory
string
required

地區參數,取得該地區的熱門歌曲資料。可使用 TW, HK, SG, MY, JP

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

/albums/:album_id

使用 album_id 取得該專輯的資料。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/albums/album_id
curl --request GET \
  --url 'https://api.kkbox.com/v1.1/albums/KmRKnW5qmUrTnGRuxF?territory=TW' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer YOUR ACCESS TOKEN HERE'
require 'uri'
require 'net/http'

url = URI("https://api.kkbox.com/v1.1/albums/KmRKnW5qmUrTnGRuxF?territory=TW")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Bearer YOUR ACCESS TOKEN HERE'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "api.kkbox.com",
  "port": null,
  "path": "/v1.1/albums/KmRKnW5qmUrTnGRuxF?territory=TW",
  "headers": {
    "accept": "application/json",
    "authorization": "Bearer YOUR ACCESS TOKEN HERE"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.kkbox.com")

headers = {
    'accept': "application/json",
    'authorization': "Bearer YOUR ACCESS TOKEN HERE"
    }

conn.request("GET", "/v1.1/albums/KmRKnW5qmUrTnGRuxF?territory=TW", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.kkbox.com/v1.1/albums/KmRKnW5qmUrTnGRuxF?territory=TW",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Bearer YOUR ACCESS TOKEN HERE"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {

    url := "https://api.kkbox.com/v1.1/albums/KmRKnW5qmUrTnGRuxF?territory=TW"

    req, _ := http.NewRequest("GET", url, nil)

    req.Header.Add("accept", "application/json")
    req.Header.Add("authorization", "Bearer YOUR ACCESS TOKEN HERE")

    res, _ := http.DefaultClient.Do(req)

    defer res.Body.Close()
    body, _ := ioutil.ReadAll(res.Body)

    fmt.Println(res)
    fmt.Println(string(body))

}
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "id": "KmRKnW5qmUrTnGRuxF",
  "name": "FLASH",
  "url": "https://www.kkbox.com/tw/tc/album/FFOEbmkriZ-HMo0FqNnk0091-index.html",
  "explicitness": false,
  "available_territories": [
    "TW",
    "HK",
    "SG",
    "MY"
  ],
  "release_date": "2016-03-16",
  "images": [
    {
      "height": 160,
      "width": 160,
      "url": "https://i.kfs.io/album/global/14253296,0v1/fit/160x160.jpg"
    },
    {
      "height": 500,
      "width": 500,
      "url": "https://i.kfs.io/album/global/14253296,0v1/fit/500x500.jpg"
    },
    {
      "height": 1000,
      "width": 1000,
      "url": "https://i.kfs.io/album/global/14253296,0v1/fit/1000x1000.jpg"
    }
  ],
  "artist": {
    "id": "Cnv_K6i5Ft4y41SxLy",
    "name": "Perfume",
    "url": "https://www.kkbox.com/tw/tc/artist/-58YcxY7FdfNn.O0F0mWT08J-index-1.html",
    "images": [
      {
        "height": 160,
        "width": 160,
        "url": "https://i.kfs.io/artist/global/206877,0v22/fit/160x160.jpg"
      },
      {
        "height": 300,
        "width": 300,
        "url": "https://i.kfs.io/artist/global/206877,0v22/fit/300x300.jpg"
      }
    ]
  }
}

Path Params

album_id
string
required

專輯 ID

Query Params

territory
string
required

地區參數,取得該地區的專輯資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/albums/:album_id/tracks

使用 album_id 取得該專輯的歌曲列表。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/albums/album_id/tracks
curl --request GET \
  --url 'https://api.kkbox.com/v1.1/albums/KmRKnW5qmUrTnGRuxF/tracks?territory=TW&offset=0&limit=500' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer YOUR ACCESS TOKEN HERE'
require 'uri'
require 'net/http'

url = URI("https://api.kkbox.com/v1.1/albums/KmRKnW5qmUrTnGRuxF/tracks?territory=TW&offset=0&limit=500")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Bearer YOUR ACCESS TOKEN HERE'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "api.kkbox.com",
  "port": null,
  "path": "/v1.1/albums/KmRKnW5qmUrTnGRuxF/tracks?territory=TW&offset=0&limit=500",
  "headers": {
    "accept": "application/json",
    "authorization": "Bearer YOUR ACCESS TOKEN HERE"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.kkbox.com")

headers = {
    'accept': "application/json",
    'authorization': "Bearer YOUR ACCESS TOKEN HERE"
    }

conn.request("GET", "/v1.1/albums/KmRKnW5qmUrTnGRuxF/tracks?territory=TW&offset=0&limit=500", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.kkbox.com/v1.1/albums/KmRKnW5qmUrTnGRuxF/tracks?territory=TW&offset=0&limit=500",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Bearer YOUR ACCESS TOKEN HERE"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {

    url := "https://api.kkbox.com/v1.1/albums/KmRKnW5qmUrTnGRuxF/tracks?territory=TW&offset=0&limit=500"

    req, _ := http.NewRequest("GET", url, nil)

    req.Header.Add("accept", "application/json")
    req.Header.Add("authorization", "Bearer YOUR ACCESS TOKEN HERE")

    res, _ := http.DefaultClient.Do(req)

    defer res.Body.Close()
    body, _ := ioutil.ReadAll(res.Body)

    fmt.Println(res)
    fmt.Println(string(body))

}
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "data": [
    {
      "id": "KpnEGVHEsGgkoB0MBk",
      "name": "FLASH",
      "duration": 276224,
      "url": "https://www.kkbox.com/tw/tc/song/F0A00TI1X.1gosrpgosrp0XL-index.html",
      "track_number": 1,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY"
      ]
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 500,
    "previous": null,
    "next": null
  },
  "summary": {
    "total": 1
  }
}

Path Params

album_id
string
required

專輯 ID

Query Params

territory
string
required

地區參數,取得該地區的歌曲資料。可使用 TW, HK, SG, MY, JP

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

/tracks/:track_id

使用 track_id 取得該歌曲的資料。

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.kkbox.com/v1.1/tracks/track_id
curl --request GET \
  --url 'https://api.kkbox.com/v1.1/tracks/4kxvr3wPWkaL9_y3o_?territory=TW' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer YOUR ACCESS TOKEN HERE'
require 'uri'
require 'net/http'

url = URI("https://api.kkbox.com/v1.1/tracks/4kxvr3wPWkaL9_y3o_?territory=TW")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = 'Bearer YOUR ACCESS TOKEN HERE'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "api.kkbox.com",
  "port": null,
  "path": "/v1.1/tracks/4kxvr3wPWkaL9_y3o_?territory=TW",
  "headers": {
    "accept": "application/json",
    "authorization": "Bearer YOUR ACCESS TOKEN HERE"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api.kkbox.com")

headers = {
    'accept': "application/json",
    'authorization': "Bearer YOUR ACCESS TOKEN HERE"
    }

conn.request("GET", "/v1.1/tracks/4kxvr3wPWkaL9_y3o_?territory=TW", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.kkbox.com/v1.1/tracks/4kxvr3wPWkaL9_y3o_?territory=TW",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "authorization: Bearer YOUR ACCESS TOKEN HERE"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {

    url := "https://api.kkbox.com/v1.1/tracks/4kxvr3wPWkaL9_y3o_?territory=TW"

    req, _ := http.NewRequest("GET", url, nil)

    req.Header.Add("accept", "application/json")
    req.Header.Add("authorization", "Bearer YOUR ACCESS TOKEN HERE")

    res, _ := http.DefaultClient.Do(req)

    defer res.Body.Close()
    body, _ := ioutil.ReadAll(res.Body)

    fmt.Println(res)
    fmt.Println(string(body))

}
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "id": "4kxvr3wPWkaL9_y3o_",
  "name": "島嶼天光",
  "duration": 260493,
  "url": "https://www.kkbox.com/tw/tc/song/My5LTon3mEKTZ98eB98eB0P4-index.html",
  "track_number": 1,
  "explicitness": false,
  "available_territories": [
    "TW",
    "HK",
    "SG",
    "MY",
    "JP"
  ],
  "album": {
    "id": "WpTPGzNLeutVFHcFq6",
    "name": "島嶼天光",
    "url": "https://www.kkbox.com/tw/tc/album/Y4g5iyr9pCLRtx0FE5pr0091-index.html",
    "explicitness": false,
    "available_territories": [
      "TW",
      "HK",
      "SG",
      "MY",
      "JP"
    ],
    "release_date": "2014-03-28",
    "images": [
      {
        "height": 160,
        "width": 160,
        "url": "https://i.kfs.io/album/tw/3693943,0v1/fit/160x160.jpg"
      },
      {
        "height": 500,
        "width": 500,
        "url": "https://i.kfs.io/album/tw/3693943,0v1/fit/500x500.jpg"
      },
      {
        "height": 1000,
        "width": 1000,
        "url": "https://i.kfs.io/album/tw/3693943,0v1/fit/1000x1000.jpg"
      }
    ],
    "artist": {
      "id": "8q3_xzjl89Yakn_7GB",
      "name": "滅火器 (Fire EX.)",
      "url": "https://www.kkbox.com/tw/tc/artist/ozHoLIy-jPvlc1P0F06Sb08J-index-1.html",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/artist/global/26407,0v5/fit/160x160.jpg"
        },
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/artist/global/26407,0v5/fit/300x300.jpg"
        }
      ]
    }
  }
}
{
    "error": {
        "code": 0,
        "message": "Invalid Territory"
    }
}
{
  "error": {
    "message": "Invalid Authentication",
    "code": 0
  }
}

Path Params

track_id
string
required

歌曲 ID

Query Params

territory
string
required

地區參數,取得該地區的歌曲資料。可使用 TW, HK, SG, MY, JP

 
Suggest Edits

/users/:user_id

取得會員資料

 
get/users/user_id
GET /v1.1/users/CoiM4s7qXvCTQBLstX HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "id": "CoiM4s7qXvCTQBLstX",
  "url": "https://www.kkbox.com/tw/profile/CoiM4s7qXvCTQBLstX",
  "name": "澳門首家線上__",
  "description": "http://about.me/honglong",
  "images": [
    {
      "height": 75,
      "width": 75,
      "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/75x75.jpg"
    },
    {
      "height": 180,
      "width": 180,
      "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/180x180.jpg"
    },
    {
      "height": 300,
      "width": 300,
      "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/300x300.jpg"
    }
  ]
}

Path Params

user_id
string
required

會員 ID

 
Suggest Edits

/users/:user_id/album-collection

取得會員收藏專輯

 
get/users/user_id/album-collection
GET /v1.1/users/Gob75HEjI5a_d3m4LN/album-collection?territory=TW&limit=100 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "_aofdvr-DpNo6oxRQ3",
      "name": "Gravity Wall / Sh0ut",
      "url": "https://www.kkbox.com/tw/tc/album/27l.c6yIzPWlh0F1aoQc009H-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY"
      ],
      "release_date": "2017-07-14",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/global/26953384,1v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/global/26953384,1v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/global/26953384,1v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "9aweAy_q8L4Ikw7FVW",
        "name": "SawanoHiroyuki[nZk]",
        "url": "https://www.kkbox.com/tw/tc/artist/2NFh.QMB7qE88K0F0COYm08K-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/3246258,0v32/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/3246258,0v32/fit/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "8t7G5pNsZgqWffZ_y2",
      "name": "Orion",
      "url": "https://www.kkbox.com/tw/tc/album/TtoZUjqayRuN10F1LD5l009H-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY"
      ],
      "release_date": "2017-02-17",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/global/22335857,1v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/global/22335857,1v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/global/22335857,1v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "8oRs6ttmEEYzg2nyTU",
        "name": "Kenshi Yonezu (米津玄師)",
        "url": "https://www.kkbox.com/tw/tc/artist/cKnnfcAf1fNIQu0F0POTJ08K-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/6653779,0v5/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/6653779,0v5/fit/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "HZVs2VBSAsSpI5rGWZ",
      "name": "TOGETSUKYOU KIMI OMOU",
      "url": "https://www.kkbox.com/tw/tc/album/l7SCwcSw2RSFG0F1-1F2009H-index.html",
      "explicitness": false,
      "available_territories": [],
      "release_date": "2017-06-09",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/global/26219458,0v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/global/26219458,0v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/global/26219458,0v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "Crp-66x2Y7UDALinIc",
        "name": "Mai Kuraki (倉木麻衣)",
        "url": "https://www.kkbox.com/tw/tc/artist/LYZ7nAxqV4WMQEj0F01HQ08J-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/5210,0v5/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/5210,0v5/fit/300x300.jpg"
          }
        ]
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 3,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/users/Gob75HEjI5a_d3m4LN/album-collection?limit=3&territory=TW&offset=3"
  },
  "summary": {}
}

Path Params

user_id
string
required

會員 ID

Query Params

territory
string

地區參數,取得收藏專輯在該地區的資料。可使用 TW, HK, SG, MY, JP,未填則提供該帳號所屬地區的資料

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

/users/:user_id/playlist-collection

取得會員收藏歌單

 
get/users/user_id/playlist-collection
GET /v1.1/users/CoiM4s7qXvCTQBLstX/playlist-collection?territory=TW&limit=5 HTTP/1.1
Authorization: Bearer my_own_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "KmpQ9Wizu5MxEHFnBp",
      "title": "2017看見太陽原住民族音樂節 歌單搶先聽PART 1",
      "description": "2017看見‧太陽在高雄─原住民族音樂節」邀請超過15組國內優秀原住民族歌手團隊,以流行x創作音樂帶來絕佳的天籟饗宴!",
      "url": "https://www.kkbox.com/tw/tc/playlist/KmpQ9Wizu5MxEHFnBp",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/59595224v2/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/59595224v2/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/59595224v2/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2017-07-17T04:14:21+00:00",
      "owner": {
        "id": "4sr2MkSmWI-OwNsrJc",
        "url": "https://www.kkbox.com/tw/profile/4sr2MkSmWI-OwNsrJc",
        "name": "布萊德船長",
        "description": "跟著音樂一起酷,讓我們航向品牌的航道吧!",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/338065226046v1/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/338065226046v1/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/338065226046v1/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "5_chcV1Dg7hHIP9RHc",
      "title": "音樂從這裡開始!中英文經典兒歌永流傳。",
      "description": "不管時間的更替,有很多經典的童謠並不會隨著時間而被淘汰,反而是所有小朋友開始接觸音樂的起點,成長的共同記憶。",
      "url": "https://www.kkbox.com/tw/tc/playlist/5_chcV1Dg7hHIP9RHc",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/62305936v2/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/62305936v2/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/62305936v2/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2018-09-13T04:00:06+00:00",
      "owner": {
        "id": "4q9cRyYR5Kdk7K5GOV",
        "url": "https://www.kkbox.com/tw/profile/4q9cRyYR5Kdk7K5GOV",
        "name": "凱莉媽的音樂廚房",
        "description": "離開工作,開始當全職媽媽,如果沒有音樂,生活只有一種聲音,就是小孩的哭聲加上媽媽的嘆息聲,還好有音樂,讓日子還是可以可愛而愉快的過下去。",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/338077248343v1/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/338077248343v1/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/338077248343v1/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "GtZpZHP-D--03Pvc9P",
      "title": "2-4歲 ❤️中班 小班 英文兒歌",
      "description": "",
      "url": "https://www.kkbox.com/tw/tc/playlist/GtZpZHP-D--03Pvc9P",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/64295845v1/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/64295845v1/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/64295845v1/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-06-19T10:51:50+00:00",
      "owner": {
        "id": "1YYWDsmPnvrYPo9Kzo",
        "url": "https://www.kkbox.com/tw/profile/1YYWDsmPnvrYPo9Kzo",
        "name": "ABC線上幼兒園",
        "description": "",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/338092684890v3/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/338092684890v3/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/338092684890v3/cropresize/300x300.jpg"
          }
        ]
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 3,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/users/CoiM4s7qXvCTQBLstX/playlist-collection?limit=3&territory=TW&offset=3"
  },
  "summary": {}
}

Path Params

user_id
string
required

會員 ID

Query Params

territory
string

地區參數,取得該收藏歌單在地區的資料。可使用 TW, HK, SG, MY, JP,未填則提供該帳號所屬地區的資料

limit
int32

每一頁顯示的結果數,不得超過 100

offset
int32

跳過結果筆數

 
Suggest Edits

/users/:user_id/shared-playlists

取得會員公開分享歌單

 
get/users/user_id/shared-playlists
GET /v1.1/users/CoiM4s7qXvCTQBLstX/shared-playlists?limit=3 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "1-1rriQ-1E2cyIpk4i",
      "title": "9m88",
      "description": "有 9m88 參與演出的歌曲",
      "url": "https://www.kkbox.com/tw/tc/playlist/1-1rriQ-1E2cyIpk4i",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/61763703v1/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/61763703v1/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/61763703v1/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-07-03T03:15:11+00:00",
      "owner": {
        "id": "CoiM4s7qXvCTQBLstX",
        "url": "https://www.kkbox.com/tw/profile/CoiM4s7qXvCTQBLstX",
        "name": "澳門首家線上__",
        "description": "http://about.me/honglong",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "H_3M15VhX-E8PqP5-C",
      "title": "聲控音箱台語歌測試歌單",
      "description": "",
      "url": "https://www.kkbox.com/tw/tc/playlist/H_3M15VhX-E8PqP5-C",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/64765336v1/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/64765336v1/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/64765336v1/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-06-28T15:44:29+00:00",
      "owner": {
        "id": "CoiM4s7qXvCTQBLstX",
        "url": "https://www.kkbox.com/tw/profile/CoiM4s7qXvCTQBLstX",
        "name": "澳門首家線上__",
        "description": "http://about.me/honglong",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "Ct6b_guwcKhiRO8g1n",
      "title": "青峰參與詞曲創作音樂作品集 (2000 ~ 2018/6)",
      "description": "青峰除了幫蘇打綠寫歌,也幫其他音樂人寫了很多好作品,這張歌單收錄了 125 首,一起來聽聽看吧!\n青峰維基百科條目: http://bit.ly/29F79Aw",
      "url": "https://www.kkbox.com/tw/tc/playlist/Ct6b_guwcKhiRO8g1n",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/33135319v2/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/33135319v2/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/33135319v2/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-06-21T04:53:18+00:00",
      "owner": {
        "id": "CoiM4s7qXvCTQBLstX",
        "url": "https://www.kkbox.com/tw/profile/CoiM4s7qXvCTQBLstX",
        "name": "澳門首家線上__",
        "description": "http://about.me/honglong",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/34836681v2/cropresize/300x300.jpg"
          }
        ]
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 3,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/users/CoiM4s7qXvCTQBLstX/shared-playlists?limit=3&offset=3"
  },
  "summary": {}
}

Path Params

user_id
string
required

會員 ID

Query Params

limit
int32

每一頁顯示的結果數,不得超過 100

offset
int32

跳過結果筆數

 
Suggest Edits

/me

取得個人資料

 
get/me
GET /v1.1/me HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "id": "WtQLeP13mbPj29puyT",
  "territory": "TW",
  "url": "https://www.kkbox.com/tw/profile/WtQLeP13mbPj29puyT",
  "name": "神祕嘉賓",
  "description": "",
  "images": [
    {
      "height": 75,
      "width": 75,
      "url": "https://i.kfs.io/muser/global/noimg/cropresize/75x75.jpg"
    },
    {
      "height": 180,
      "width": 180,
      "url": "https://i.kfs.io/muser/global/noimg/cropresize/180x180.jpg"
    },
    {
      "height": 300,
      "width": 300,
      "url": "https://i.kfs.io/muser/global/noimg/cropresize/300x300.jpg"
    }
  ]
}
 
Suggest Edits

/me/favorite

取得我的收藏歌曲

 
get/me/favorite
GET /v1.1/me/favorite?limit=3 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "_Xg86EEe0EWg-iOos2",
      "name": "原來的我",
      "duration": 218671,
      "url": "https://www.kkbox.com/tw/tc/song/How00XmWN4no1Y7ho1Y7h0XL-index.html",
      "track_number": 1,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "HYIH67mAU1EtViBVDr",
        "name": "原來的我",
        "url": "https://www.kkbox.com/tw/tc/album/9KqJDy8UPsbdl0F24RWf009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2018-05-15",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/34715691,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/34715691,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/34715691,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "9Y0-6KZDWhowfz3ehD",
          "name": "吳卓源 (Julia Wu)",
          "url": "https://www.kkbox.com/tw/tc/artist/KFTwfNb8TCvto80F0BFyq08K-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/2949046,0v6/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/2949046,0v6/fit/300x300.jpg"
            }
          ]
        }
      }
    },
    {
      "id": "5-Xyx1EOi4L5qxmDTg",
      "name": "Only Love",
      "duration": 243069,
      "url": "https://www.kkbox.com/tw/tc/song/eR700CbA2KZJWUxRJWUxR0XL-index.html",
      "track_number": 1,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "JP"
      ],
      "album": {
        "id": "0ouVDE0Uu_GpB5a8gx",
        "name": "Only Love",
        "url": "https://www.kkbox.com/tw/tc/album/5u16aV0jsuCO00F213G.009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "JP"
        ],
        "release_date": "2016-07-29",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/33829925,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/33829925,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/33829925,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "4nHy29-K2KLL4RJLo4",
          "name": "Trademark",
          "url": "https://www.kkbox.com/tw/tc/artist/Se0Xi17QEF7And0F0bUKH08K-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/10347793,0v1/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/10347793,0v1/fit/300x300.jpg"
            }
          ]
        }
      }
    },
    {
      "id": "D-SGBtE2ldMikg-jqZ",
      "name": "情人節",
      "duration": 249417,
      "url": "https://www.kkbox.com/tw/tc/song/o2VX80m-YP.1x.kd1x.kd0PL-index.html",
      "track_number": 5,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "9Zm5zkgn_BzuO48A8i",
        "name": "我知道",
        "url": "https://www.kkbox.com/tw/tc/album/VgLvD9aph11Crk0FM0SS0091-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2015-02-09",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/tw/5768988,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/tw/5768988,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/tw/5768988,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "Kq9hNAJYQwYgkJwyP3",
          "name": "莊心妍",
          "url": "https://www.kkbox.com/tw/tc/artist/rrDF6wcLCl.R950F05BX-08K-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/1357924,0v3/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/1357924,0v3/fit/300x300.jpg"
            }
          ]
        }
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 3,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/me/favorite?limit=3&offset=3"
  },
  "summary": {
    "total": 5
  }
}

Query Params

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

/me/favorite

加入歌曲至我的收藏

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.kkbox.com/v1.1/me/favorite
POST /v1.1/me/favorite HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
Content-Type: application/json

{
    "track_id": "8sfmNa7NV0Zqk_J-3l"
}
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "message":"Success",
  "track_id":"8sfmNa7NV0Zqk_J-3l"
}
{
  "error":{
    "message":"track_id is required",
    "code":3
  }
}
{
  "error":{
    "message":"Invalid client",
    "code":1
  }
}
{
  "error":{
    "message":"Track does not exist",
    "code":2
  }
}

Form Data

track_id
string
required

歌曲的 ID

Headers

Content-Type
string
required
 
Suggest Edits

/me/album-collection

取得我的收藏專輯

 
get/me/album-collection
GET /v1.1/me/album-collection?territory=TW&limit=3 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "Kk-eq9UALfA_Ollzze",
      "name": "把悲傷留在這裡 (Leave Your Sorrows)",
      "url": "https://www.kkbox.com/tw/tc/album/jqfexwg49s55l0F1zsic009H-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "release_date": "2018-04-09",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/global/33524648,5v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/global/33524648,5v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/global/33524648,5v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "5-ZbBBV88AiCJaICLf",
        "name": "好樂團 (Good Band)",
        "url": "https://www.kkbox.com/tw/tc/artist/wxfJetpznRlkIo0F0PMaq08K-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/6646198,0v1/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/6646198,0v1/fit/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "8sHQwF6zI8uioYBKaI",
      "name": "我們一樣可惜",
      "url": "https://www.kkbox.com/tw/tc/album/qmxlHDqANdl3q0F2nyOl009H-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "release_date": "2019-01-28",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/tw/47179313,0v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/tw/47179313,0v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/tw/47179313,0v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "5-ZbBBV88AiCJaICLf",
        "name": "好樂團 (Good Band)",
        "url": "https://www.kkbox.com/tw/tc/artist/wxfJetpznRlkIo0F0PMaq08K-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/6646198,0v1/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/6646198,0v1/fit/300x300.jpg"
          }
        ]
      }
    },
    {
      "id": "OmUNQPgYP4HnBDQbCL",
      "name": "Are You Lonely",
      "url": "https://www.kkbox.com/tw/tc/album/2Hhqr3xcsx.KL0F2txZW009H-index.html",
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "release_date": "2019-02-22",
      "images": [
        {
          "height": 160,
          "width": 160,
          "url": "https://i.kfs.io/album/global/48748768,1v1/fit/160x160.jpg"
        },
        {
          "height": 500,
          "width": 500,
          "url": "https://i.kfs.io/album/global/48748768,1v1/fit/500x500.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/album/global/48748768,1v1/fit/1000x1000.jpg"
        }
      ],
      "artist": {
        "id": "DYGTQ3LLTDw-CTRRdN",
        "name": "Steve Aoki, Alan Walker",
        "url": "https://www.kkbox.com/tw/tc/artist/BdI8VkHBZmLI6t0F0s3cw08K-index-1.html",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/artist/global/14694972,0v1/fit/160x160.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/artist/global/14694972,0v1/fit/300x300.jpg"
          }
        ]
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 3,
    "previous": null,
    "next": null
  },
  "summary": {}
}

Query Params

territory
string

地區參數,取得收藏專輯在該地區的資料。可使用 TW, HK, SG, MY, JP,未填則提供該帳號所屬地區的資料

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

/me/playlist-collection

取得我的收藏歌單

 
get/me/playlist-collection
GET /v1.1/me/playlist-collection?territory=TW&limit=5 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "DZrC8m29ciOFY2JAm3",
      "title": "華語速爆新歌 (每週二五更新)",
      "description": "【封面人物:CHING G SQUAD(高爾宣、婁峻碩、芮德、ChrisFlow)】\n大受好評華語歌壇重量級速爆歌單,\n收藏一張歌單,流行最強音零時差搶先收聽。",
      "url": "https://www.kkbox.com/tw/tc/playlist/DZrC8m29ciOFY2JAm3",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/26541395v264/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/26541395v264/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/26541395v264/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-08-02T06:37:17+00:00",
      "owner": {
        "id": "Os-z4yYPRlzOAkzZm3",
        "url": "https://www.kkbox.com/tw/profile/Os-z4yYPRlzOAkzZm3",
        "name": "KKBOX 華語小編",
        "description": "這次我要播很多 華語 類別的歌曲,快來跟我一起聽音樂吧!",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/94562966v27/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/94562966v27/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/94562966v27/cropresize/300x300.jpg"
          }
        ]
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 5,
    "previous": null,
    "next": null
  },
  "summary": {}
}

Query Params

territory
string

地區參數,取得收藏歌單在該地區的資料。可使用 TW, HK, SG, MY, JP,未填則提供該帳號所屬地區的資料

limit
int32

每一頁顯示的結果數,不得超過 100

offset
int32

跳過結果筆數

 
Suggest Edits

/me/playlists

取得我的歌單

 
get/me/playlists
GET /v1.1/me/playlists?limit=10 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "WkHc0jh86TqZCrDEY8",
      "title": "歌手名稱測試"
    },
    {
      "id": "8puXXsO9KDwzoHUic1",
      "title": "愛情裡的一言難盡"
    },
    {
      "id": "L_zJghzmHK05KXrMnn",
      "title": "因為你聽過 山丘"
    },
    {
      "id": "LYPqInhFzwQRjY_-Kl",
      "title": "因為你聽過 陪妳過假日 (Weekends With You)"
    },
    {
      "id": "0pBNKU8-uhBM7ifhyj",
      "title": "Carpenters (木匠兄妹合唱團) - Carpenters Gold - 35th Anniversary Edition"
    },
    {
      "id": "Omgy9dx5i6NaQDnpQB",
      "title": "很熱的一個冬天"
    },
    {
      "id": "CsCTLuWpzJEmxwrqto",
      "title": "因為你聽過 被遺忘的時光 (Forgotten Time) - Remastered"
    },
    {
      "id": "D_AvOYvtnxzE45hz3T",
      "title": "林夕大全集"
    },
    {
      "id": "CkJKY0M3K_hI3XtY1c",
      "title": "因為你聽過 HOME Remix"
    },
    {
      "id": "SmuHM2cisDP4EkKN8c",
      "title": "KKLINX 測試歌單"
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 10,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/me/playlists?limit=10&offset=10"
  },
  "summary": {
    "total": 55
  }
}

Query Params

limit
int32

每一頁顯示的結果數,不得超過 100

offset
int32

跳過結果筆數

 
Suggest Edits

/me/playlists

創建新的歌單

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.kkbox.com/v1.1/me/playlists
POST /v1.1/me/playlists HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
Content-Type: application/json

{
    "name": "new_playlist"
}
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "playlist_id": "Lalk24yv8r0DfuNTwa"
}
{
  "error": {
    "message": "name is required",
    "code": 3
  }
}
{
  "error": {
    "message": "Internal Server Error",
    "code": 0
  }
}

Form Data

name
string
required

歌單的名稱

Headers

Content-Type
string
required
 
Suggest Edits

/me/playlists/:private_playlist_id

取得我的特定歌單資料

 
get/me/playlists/private_playlist_id
GET /v1.1/me/playlists/H_UG1vQDgWbBJWKg1x HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "id": "HY1yKpDSk2bkCXdo6f",
  "title": "自訂歌單",
  "tracks": {
    "data": [
      {
        "id": "OrNFBKSVf78HUl_UuO",
        "name": "真的傻 (Foolish Love)",
        "duration": 256000,
        "url": "https://www.kkbox.com/tw/tc/song/H7200W9Y6-4kHUIskHUIs0XL-index.html",
        "track_number": 1,
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "album": {
          "id": "KsykgdN-dkIB_1bOLR",
          "name": "真的傻 (Foolish Love)",
          "url": "https://www.kkbox.com/tw/tc/album/Nw8VbmDnGxNC20F2q.AT009H-index.html",
          "explicitness": false,
          "available_territories": [
            "TW",
            "HK",
            "SG",
            "MY",
            "JP"
          ],
          "release_date": "2019-02-01",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/global/47862429,0v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/global/47862429,0v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/global/47862429,0v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "Cm48MSnT1F5sOeBDmf",
            "name": "徐佳瑩 (LaLa Hsu)",
            "url": "https://www.kkbox.com/tw/tc/artist/tP8quSoSplyft8w0F07hn08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/31603,0v9/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/31603,0v9/fit/300x300.jpg"
              }
            ]
          }
        }
      },
      {
        "id": "WpQjDIV7aMOw-BgzGe",
        "name": "懦弱 (Weakness)",
        "duration": 262426,
        "url": "https://www.kkbox.com/tw/tc/song/Z6100-oP4Q2rhOjArhOjA0XL-index.html",
        "track_number": 1,
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "album": {
          "id": "LXrqBN4jKFATsgLjKe",
          "name": "懦弱 (Weakness)",
          "url": "https://www.kkbox.com/tw/tc/album/4y0joa.FfON6V0F1hv6L009H-index.html",
          "explicitness": false,
          "available_territories": [
            "TW",
            "HK",
            "SG",
            "MY",
            "JP"
          ],
          "release_date": "2017-09-13",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/global/28815765,1v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/global/28815765,1v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/global/28815765,1v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "D-6TOjbo3KbdhLjk6u",
            "name": "戴愛玲 (Ailing Tai)",
            "url": "https://www.kkbox.com/tw/tc/artist/GraYuNJ-vXlCjkG0F01zF08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/8143,0v7/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/8143,0v7/fit/300x300.jpg"
              }
            ]
          }
        }
      },
      {
        "id": "9Y2JnMButUrZ3o_hxH",
        "name": "耳朵",
        "duration": 241266,
        "url": "https://www.kkbox.com/tw/tc/song/AGl00O3QIXZZytwzZytwz0XL-index.html",
        "track_number": 6,
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "album": {
          "id": "4m2Bx_Fk2kVG5xa7Tk",
          "name": "耳朵",
          "url": "https://www.kkbox.com/tw/tc/album/2quaSoMU7Evpk0F2RvpY009H-index.html",
          "explicitness": false,
          "available_territories": [
            "TW",
            "HK",
            "SG",
            "MY",
            "JP"
          ],
          "release_date": "2018-10-17",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/global/40877410,0v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/global/40877410,0v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/global/40877410,0v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "D-0uSsbo3KbdjIQkWA",
            "name": "李榮浩",
            "url": "https://www.kkbox.com/tw/tc/artist/CQDrYPUT5Melly0F03wZo08K-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/1034484,0v11/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/1034484,0v11/fit/300x300.jpg"
              }
            ]
          }
        }
      },
      {
        "id": "9XUSDEmi3wYrBOFaxM",
        "name": "愛情怎麼了嗎 (Self-complacent)",
        "duration": 246439,
        "url": "https://www.kkbox.com/tw/tc/song/Y2q00AI.k8-HT.vkHT.vk0XL-index.html",
        "track_number": 1,
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "album": {
          "id": "8rPLKTQLLZoqOmCkBT",
          "name": "愛情怎麼了嗎 (Self-complacent)",
          "url": "https://www.kkbox.com/tw/tc/album/nUB3lzyny0Xwi0F2zfgz009H-index.html",
          "explicitness": false,
          "available_territories": [
            "TW",
            "HK",
            "SG",
            "MY",
            "JP"
          ],
          "release_date": "2019-03-12",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/album/global/50248511,0v1/fit/160x160.jpg"
            },
            {
              "height": 500,
              "width": 500,
              "url": "https://i.kfs.io/album/global/50248511,0v1/fit/500x500.jpg"
            },
            {
              "height": 1000,
              "width": 1000,
              "url": "https://i.kfs.io/album/global/50248511,0v1/fit/1000x1000.jpg"
            }
          ],
          "artist": {
            "id": "8qCONzjl89Yak9KFxZ",
            "name": "盧廣仲 (Crowd Lu)",
            "url": "https://www.kkbox.com/tw/tc/artist/GEnIj7lxx8laQwk0F07Zk08J-index-1.html",
            "images": [
              {
                "height": 160,
                "width": 160,
                "url": "https://i.kfs.io/artist/global/30960,0v4/fit/160x160.jpg"
              },
              {
                "height": 300,
                "width": 300,
                "url": "https://i.kfs.io/artist/global/30960,0v4/fit/300x300.jpg"
              }
            ]
          }
        }
      }
    ],
    "paging": {
      "offset": 0,
      "limit": 50,
      "previous": null,
      "next": "https://api.kkbox.com/v1.1/me/playlists/HY1yKpDSk2bkCXdo6f/tracks?limit=50&offset=50"
    },
    "summary": {
      "total": 105
    }
  }
}

Path Params

private_playlist_id
string
required

私人歌單 ID,可在 /me/playlists 中取得

 
Suggest Edits

/me/playlists/:private_playlist_id/tracks

取得我的特定歌單中的歌曲列表

 
get/me/playlists/private_playlist_id/tracks
GET /v1.1/me/playlists/H_UG1vQDgWbBJWKg1x/tracks?limit=3 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "OrNFBKSVf78HUl_UuO",
      "name": "真的傻 (Foolish Love)",
      "duration": 256000,
      "url": "https://www.kkbox.com/tw/tc/song/H7200W9Y6-4kHUIskHUIs0XL-index.html",
      "track_number": 1,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "KsykgdN-dkIB_1bOLR",
        "name": "真的傻 (Foolish Love)",
        "url": "https://www.kkbox.com/tw/tc/album/Nw8VbmDnGxNC20F2q.AT009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2019-02-01",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/47862429,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/47862429,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/47862429,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "Cm48MSnT1F5sOeBDmf",
          "name": "徐佳瑩 (LaLa Hsu)",
          "url": "https://www.kkbox.com/tw/tc/artist/tP8quSoSplyft8w0F07hn08J-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/31603,0v9/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/31603,0v9/fit/300x300.jpg"
            }
          ]
        }
      }
    },
    {
      "id": "WpQjDIV7aMOw-BgzGe",
      "name": "懦弱 (Weakness)",
      "duration": 262426,
      "url": "https://www.kkbox.com/tw/tc/song/Z6100-oP4Q2rhOjArhOjA0XL-index.html",
      "track_number": 1,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "LXrqBN4jKFATsgLjKe",
        "name": "懦弱 (Weakness)",
        "url": "https://www.kkbox.com/tw/tc/album/4y0joa.FfON6V0F1hv6L009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2017-09-13",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/28815765,1v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/28815765,1v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/28815765,1v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "D-6TOjbo3KbdhLjk6u",
          "name": "戴愛玲 (Ailing Tai)",
          "url": "https://www.kkbox.com/tw/tc/artist/GraYuNJ-vXlCjkG0F01zF08J-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/8143,0v7/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/8143,0v7/fit/300x300.jpg"
            }
          ]
        }
      }
    },
    {
      "id": "9Y2JnMButUrZ3o_hxH",
      "name": "耳朵",
      "duration": 241266,
      "url": "https://www.kkbox.com/tw/tc/song/AGl00O3QIXZZytwzZytwz0XL-index.html",
      "track_number": 6,
      "explicitness": false,
      "available_territories": [
        "TW",
        "HK",
        "SG",
        "MY",
        "JP"
      ],
      "album": {
        "id": "4m2Bx_Fk2kVG5xa7Tk",
        "name": "耳朵",
        "url": "https://www.kkbox.com/tw/tc/album/2quaSoMU7Evpk0F2RvpY009H-index.html",
        "explicitness": false,
        "available_territories": [
          "TW",
          "HK",
          "SG",
          "MY",
          "JP"
        ],
        "release_date": "2018-10-17",
        "images": [
          {
            "height": 160,
            "width": 160,
            "url": "https://i.kfs.io/album/global/40877410,0v1/fit/160x160.jpg"
          },
          {
            "height": 500,
            "width": 500,
            "url": "https://i.kfs.io/album/global/40877410,0v1/fit/500x500.jpg"
          },
          {
            "height": 1000,
            "width": 1000,
            "url": "https://i.kfs.io/album/global/40877410,0v1/fit/1000x1000.jpg"
          }
        ],
        "artist": {
          "id": "D-0uSsbo3KbdjIQkWA",
          "name": "李榮浩",
          "url": "https://www.kkbox.com/tw/tc/artist/CQDrYPUT5Melly0F03wZo08K-index-1.html",
          "images": [
            {
              "height": 160,
              "width": 160,
              "url": "https://i.kfs.io/artist/global/1034484,0v11/fit/160x160.jpg"
            },
            {
              "height": 300,
              "width": 300,
              "url": "https://i.kfs.io/artist/global/1034484,0v11/fit/300x300.jpg"
            }
          ]
        }
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 3,
    "previous": null,
    "next": "https://api.kkbox.com/v1.1/me/playlists/HY1yKpDSk2bkCXdo6f/tracks?limit=3&offset=3"
  },
  "summary": {
    "total": 105
  }
}

Path Params

private_playlist_id
string
required

私人歌單 ID,可在 /me/playlists 中取得

Query Params

limit
int32

每一頁顯示的結果數,不得超過 500

offset
int32

跳過結果筆數

 
Suggest Edits

/me/playlists/:private_playlist_id/tracks

將歌曲加入至特定歌單

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.kkbox.com/v1.1/me/playlists/private_playlist_id/tracks
POST /v1.1/me/playlists/Lalk24yv8r0DfuNTwa HTTP/1.1
Authorization: Bearer my_own_access_token
Host: api.kkbox.com
Content-Type: application/json

{
    "track_ids": ["Kn9Aw92cKmKv6tCogT"]
}
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "message": "Ok"
}
{
  "error": {
    "message": "track_ids is required array and cannot be empty",
    "code": 3
  }
}
{
  "error": {
    "message": "Internal Server Error",
    "code": 0
  }
}

Path Params

private_playlist_id
string
required

私人歌單 ID,可在 /me/playlists 中取得

Form Data

track_ids
array of strings
required

歌曲 ID 的字串陣列

Headers

Content-Type
string
required
 
Suggest Edits

/me/shared-playlists

取得我的公開分享歌單

 
get/me/shared-playlists
GET /v1.1/me/shared-playlists?limit=5 HTTP/1.1
Authorization: Bearer my_access_token
Host: api.kkbox.com
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "8raR43OT0-n8TiZWOy",
      "title": "自訂歌單",
      "description": "",
      "url": "https://www.kkbox.com/tw/tc/playlist/8raR43OT0-n8TiZWOy",
      "images": [
        {
          "height": 300,
          "width": 300,
          "url": "https://i.kfs.io/playlist/global/65095510v1/cropresize/300x300.jpg"
        },
        {
          "height": 600,
          "width": 600,
          "url": "https://i.kfs.io/playlist/global/65095510v1/cropresize/600x600.jpg"
        },
        {
          "height": 1000,
          "width": 1000,
          "url": "https://i.kfs.io/playlist/global/65095510v1/cropresize/1000x1000.jpg"
        }
      ],
      "updated_at": "2019-08-02T07:07:10+00:00",
      "owner": {
        "id": "WtQLeP13mbPj29puyT",
        "territory": "TW",
        "url": "https://www.kkbox.com/tw/profile/WtQLeP13mbPj29puyT",
        "name": "神祕嘉賓",
        "description": "",
        "images": [
          {
            "height": 75,
            "width": 75,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/75x75.jpg"
          },
          {
            "height": 180,
            "width": 180,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/180x180.jpg"
          },
          {
            "height": 300,
            "width": 300,
            "url": "https://i.kfs.io/muser/global/noimg/cropresize/300x300.jpg"
          }
        ]
      }
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 5,
    "previous": null,
    "next": null
  },
  "summary": {}
}

Query Params

territory
string

地區參數,取得公開分享歌單在該地區的資料。可使用 TW, HK, SG, MY, JP,未填則提供該帳號所屬地區的資料

limit
int32

每一頁顯示的結果數,不得超過 100

offset
int32

跳過結果筆數