KUCOIN API
主頁更新日誌API DOC V1
語言
  • English
主頁更新日誌API DOC V1
語言
  • English
SDK
Telegram
Kucoin
  1. API 經紀商
  • 簡介
  • 驗證
  • 枚舉定義
  • 術語定義
  • SDK
  • 速率限制
  • 更新日誌
  • 用戶服務
    • 做市獎勵計劃
    • 貴賓快速通道
    • 經紀商計劃
  • 統一REST
    • 介紹
    • 市場數據
      • 取得公告
      • 取得幣種列表
      • 取得交易對詳情
      • 取得行情
      • 取得訂單簿
      • 取得最近交易歷史
      • 取得K線數據
      • 取得目前資金費率
      • 取得歷史資金費率
      • 取得全倉保證金配置
      • 取得服務器狀態
  • 統一Websocket
    • 基礎資訊
      • 簡介
    • 新增/撤銷 訂單
      • 新增訂單
      • 撤銷訂單
  • 經典REST
    • 帳戶資訊
      • 帳戶與資金
        • 取得帳戶摘要資訊
        • 取得KYC區域信息
        • 取得 Apikey 資訊
        • 取得帳戶類型-幣幣
        • 取得帳戶清單- 幣幣
        • 取得帳戶詳細資料- 幣幣
        • 取得帳戶- 全倉
        • 取得帳戶- 逐倉槓桿
        • 取得帳戶- 合約
        • 取得流水記錄- 幣幣/保證金
        • 取得流水記錄- 現貨高頻
        • 取得流水記錄- 槓桿高頻
        • 取得流水記錄- 合約
      • 子帳戶
        • 新增子帳戶
        • 新增子帳戶保證金權限
        • 新增子帳戶合約權限
        • 取得所有子帳戶信息
        • 取得單個子賬戶資產信息
        • 取得子帳戶清單- 幣幣餘額 (V2)
        • 取得子帳戶清單- 合約餘額 (V2)
      • 子帳戶 API
        • 取得子帳戶API列表
        • 新增子帳戶 API
        • 修改子帳戶 API
        • 刪除子帳戶 API
      • 存款
        • 新增存款地址 (V3)
        • 取得存款地址 (V3)
        • 取得存款記錄
      • 提款
        • 取得提款額度
        • 提款 (V3)
        • 取消提款
        • 取得提款紀錄
        • 按 ID 取得提款紀錄
      • 轉移
        • 取得轉移配額
        • 萬向劃轉
      • 交易費用
        • 取得基本費用- 幣幣/保證金
        • 取得實際費用- 幣幣/保證金
        • 取得實際費用- 合約
    • 幣幣交易
      • 市場數據
        • 取得公告
        • 取得幣種列表
        • 取得所有幣種詳情
        • 取得交易對詳情
        • 取得所有交易對詳情
        • 取得行情
        • 取得全部行情
        • 取得交易歷史
        • 取得K線數據
        • 取得部分訂單簿
        • 取得完整訂單簿
        • 取得集合競價部分訂單簿
        • 取得集合競價資訊
        • 取得法幣換算價格
        • 取得 24 小時統計資料
        • 取得市場清單
        • 取得用戶端 IP 位址
        • 取得伺服器時間
        • 取得服務狀態
      • 訂單
        • 新增訂單
        • 新增訂單同步
        • 新增訂單測試
        • 批次新增訂單
        • 批次新增訂單同步
        • 按 OrderId 取消訂單
        • 按 OrderId 取消訂單同步
        • 按 ClientOid 取消訂單
        • 按 clientOid 取消訂單同步
        • 取消部分訂單
        • 按交易對取消所有訂單
        • 取消所有訂單
        • 修改訂單
        • 按 OrderId 取得訂單
        • 按 ClientOid 取得訂單
        • 取得活躍訂單的交易對
        • 取得活躍訂單
        • 按頁面取得開放訂單
        • 取得已完成訂單
        • 取得交易歷史
        • 取得 DCP
        • 設定 DCP
        • 新增止損單
        • 按 ClientOid 取消止損單
        • 按 OrderId 取消止損單
        • 批次取消止損單
        • 取得止損單清單
        • 按 OrderId 取得止損單
        • 按 ClientOid 取得止損單
        • 新增 OCO 訂單
        • 按 OrderId 取消 OCO 訂單
        • 按 ClientOid 取消 OCO 訂單
        • 批次取消 OCO 訂單
        • 按 OrderId 取得 OCO 訂單
        • 按 ClientOid 取得 OCO 訂單
        • 按 OrderId 取得 OCO 訂單的詳細資料
        • 取得 OCO 訂單清單
    • 槓桿交易
      • 市場數據
        • 取得交易對 - 全倉槓桿
        • 取得交易對 - 逐倉槓桿
        • 取得 ETF 資訊
        • 獲取標記價格詳情
        • 取得保證金配置
        • 取得標記價格價目表
        • 查詢槓桿幣種階梯質押率
      • 訂單
        • 新增訂單
        • 新增訂單測試
        • 按 OrderId 取消訂單
        • 按 ClientOid 取消訂單
        • 按交易對取消所有訂單
        • 取得開放訂單的交易對
        • 取得開放訂單
        • 取得已結束訂單
        • 取得交易歷史
        • 按 OrderId 取得訂單
        • 按 ClientOid 取得訂單
        • 新增止損單
        • 按 OrderId 取消止損單
        • 按 ClientOid 取消止損單
        • 批次取消止損單
        • 取得止損單清單
        • 按 OrderId 取得止損單
        • 按 ClientOid 取得止損單
        • 新增 OCO 訂單
        • 按 OrderId 取消 OCO 訂單
        • 按 ClientOid 取消 OCO訂單
        • 批次取消 OCO 訂單
        • 按 OrderId 取得 OCO 訂單
        • 按 ClientOid 取得 OCO 訂單
        • 按 OrderId 取得 OCO 訂單的詳細資料
        • 取得 OCO 訂單清單
      • 借記
        • 取得借貸利率
        • 借幣
        • 取得借貸記錄
        • 還幣
        • 取得還幣記錄
        • 取得利息記錄
        • 修改槓桿
      • 信貸
        • 取得貸款市場
        • 取得貸款市場利率
        • 購買
        • 修改購買
        • 取得購買訂單
        • 贖回
        • 取得贖回訂單
      • 風險上限
        • 取得保證金風險限額
    • 合約交易
      • 簡介
      • 市場數據
        • 取得交易對詳情
        • 取得所有交易對詳情
        • 取得行情
        • 取得全合約最新行情
        • 取得完整買賣盤
        • 取得部分買賣盤
        • 取得交易歷史
        • 取得K線數據
        • 獲取標記價格
        • 取得幣幣指數價格
        • 取得利率指數
        • 取得溢價指數
        • 取得 24 小時統計資料
        • 取得伺服器時間
        • 取得服務狀態
      • 訂單
        • 新增訂單
        • 新增訂單測試
        • 批次新增訂單
        • 新增獲利止損單
        • 按 OrderId 取消訂單
        • 按 ClientOid 取消訂單
        • 批次取消訂單
        • 取消所有訂單
        • 取消所有止損單
        • 按 OrderId 取得訂單
        • 按 ClientOid 取得訂單
        • 取得訂單清單
        • 取得最近的已結訂單
        • 取得止損單清單
        • 取得開放訂單總價值
        • 取得最近的交易歷史
        • 取得交易歷史
      • 倉位
        • 取得槓桿模式
        • 切換槓桿模式
        • 批量切換槓桿模式
        • 取得倉位模式
        • 切換持倉模式
        • 取得最大可開倉量
        • 取得倉位詳情
        • 取得倉位列表
        • 取得持倉歷史
        • 取得最大可提取保證金
        • 取得全倉槓桿
        • 修改全倉槓桿
        • 新增逐倉槓桿
        • 移除逐倉槓桿
        • 取得全倉槓桿風險限額
        • 獲取全倉保證金要求
        • 取得逐倉槓桿風險限額
        • 修改逐倉槓桿風險限額
      • 資金費用
        • 取得目前資金費率
        • 取得歷史資金費率
        • 取得私人資金費用歷史記錄
    • 賺幣
      • 簡單賺幣
        • 購買
        • 取得贖回預覽
        • 贖回
        • 獲取餘幣寶產品
        • 獲取促銷產品
        • 取得質押產品
        • 取得 KCS 質押產品
        • 取得 ETH 質押產品
        • 取得帳戶持有
      • 結構性產品
        • 結構化產品購買
        • 獲取雙幣盈產品清單
        • 獲取結構化產品訂單
    • VIP 借貸
      • 簡介
      • 取得抵押率
      • 取得貸款資訊
      • 取得帳戶
    • 合夥人
      • 簡介
      • 取得邀請
      • 取得佣金
      • 取得歷史交易
      • 取得交易紀錄
      • 取得Kumining交易明細
    • 經紀商
      • 簡介
      • 經紀商申請
      • 說明
      • API 經紀商
        • 簡介
        • Fast API服務
        • 取得經紀返傭
          GET
        • 查詢我的傭金
          GET
        • 查詢用戶列表
          GET
        • 查詢用戶交易明細
          GET
      • 交易所經紀商
        • 簡介
        • 提交 KYC
        • 取得 KYC 狀態
        • 取得 KYC 狀態列表
        • 取得經紀資訊
        • 新增子帳戶
        • 取得子帳戶
        • 新增子帳戶 API
        • 取得子帳戶 API
        • 修改子帳戶 API
        • 刪除子帳戶 API
        • 轉移
        • 取得轉移記錄
        • 取得存款清單
        • 取得存款明細
        • 取得提款明細
        • 取得經紀返傭
    • 跟單交易
      • 簡介
      • 新增訂單
      • 新增訂單測試
      • 新增獲利止損單
      • 按 OrderId 取消訂單
      • 按 ClientOid 取消訂單
      • 取得最大可開倉量
      • 取得最大可提取保證金
      • 新增逐倉槓桿
      • 移除逐倉槓桿
      • 修改逐倉槓桿風險限額
      • 修改逐倉槓桿自動存款狀態
      • 切換槓桿模式
      • 修改全倉槓桿
      • 獲取全倉保證金要求
      • 切換持倉模式
    • 閃兌
      • 簡介
      • 查詢閃兌交易對
      • 查詢閃兌幣種列表
      • 查詢閃兌市價單價格
      • 新增閃兌市價單
      • 查詢閃兌市價單訂單詳情
      • 查詢閃兌市價單訂單歷史
      • 查詢閃兌限價單保護價格
      • 新增閃兌限價單
      • 取消閃兌限價單
      • 查詢閃兌限價單訂單詳情
      • 查詢閃兌限價單活躍訂單和歷史訂單
  • 經典Websocket
    • 基礎資訊
      • 簡介
      • 取得公開Token- 幣幣/槓桿
      • 取得私人槓桿- 幣幣/槓桿
      • 取得公開Token- 合約
      • 取得私人Token- 合約
    • 幣幣交易
      • 公共頻道
        • Ticker
        • Trade
        • 訂單簿 - Level1
        • 訂單簿 - Level5
        • 訂單簿 - Level50
        • 訂單簿 - Increment
        • 集合競價訂單簿 - Level50
        • K線
        • 交易數據
        • 交易對快照數據
        • 市場快照數據
      • 私人頻道
        • 訂單 V2
        • 訂單 V1
        • 餘額
        • 止損單
    • 槓桿交易
      • 公共頻道
        • 指數價格
        • 標記價格
      • 私人頻道
        • 逐倉杠桿倉位推送
        • 全倉槓桿倉位推送
    • 合約交易
      • 公共頻道
        • 行情數據 V2
        • 行情數據 V1
        • 訂單簿 - Level5
        • 訂單簿 - Level50
        • 訂單簿- 增量
        • K線
        • 交易數據
        • 產品行情數據
        • 資金費率結算
        • 交易對快照
      • 私人頻道
        • 訂單
        • 餘額
        • 持倉
        • 保證金模式
        • 全倉模式杠桿修改推送
        • 止損單生命週期監聽事件
  • 錯誤代碼
    • HTTP
    • 幣幣
    • 槓桿
    • 合約
    • 賺取
    • 經紀
    • 跟單交易
    • Websocket
  • 棄用的接口
    • 簡介
    • 帳戶與資金
      • 取得子帳戶清單- 摘要資訊 (V1)
      • 取得子帳戶清單- 幣幣餘額 (V1)
      • 取得存款地址 (V2)
      • 取得存款地址- V1
      • 子帳戶劃轉
      • 取得存款記錄- 舊
      • 內部劃轉
      • 取得合約帳戶轉出帳簿
      • 取得提款記錄- 舊
      • 合約帳戶轉出
      • 合約帳戶轉入
      • 新增存款地址- V1
      • 取款- V1
    • 幣幣交易
      • 訂單
        • 新增訂單- 舊
        • 新增訂單測試- 舊
        • 批次新增訂單- 舊訂單
        • Cancel Order By OrderId- Old
        • 按 ClientOid 取消訂單 - Old
        • 批次取消訂單- 舊
        • 取得訂單清單- 舊
        • 取得最近訂單清單- 舊
        • 按 OrderId 取得訂單- Old
        • 按客戶代碼取得訂單- Old
        • 獲取交易歷史- 舊
        • 獲取最近的交易歷史- 舊
    • 槓桿交易
      • 取得帳戶詳細資料- 保證金
      • 新增訂單- V1
      • 新增訂單測試- V1
      • 取得帳戶清單- 逐倉槓桿- V1
      • 取得帳戶明細- 逐倉槓桿- V1
    • 合約交易
      • 取得倉位詳情- V1
      • 修改逐倉槓桿自動存款狀態
      • 取消所有訂單- V1
    • 合夥人
      • 取得帳戶
    • 經紀商
      • API經紀商
        • 取得經紀返傭
  • 開發中
    • 簡介
  1. API 經紀商

Fast API服務

1. 簡介#

KuCoin 將推出 Fast API 服務,允許經紀商用戶通過 KuCoin OAuth2.0 登錄,一鍵授權連接到第三方應用程序。 快速 API 服務的重大改進在於增強交易的安全性並簡化連接 KuCoin 和經紀商的方式。
不需要額外的密碼短語或 API 密鑰 (版本3) 來手動綁定經紀商的機器人。OAuth 連接將自動創建 API 密鑰並自動連接到經紀商。該密鑰具有默認權限,包括現貨交易、期貨交易,以及獲取 KuCoin Earn 的訪問權限。

2. 整合前的準備#

要使用 KuCoin Fast API 服務,經紀商合作夥伴需要準備以下三個部分並通過此表格提交.
經紀商請求 Fast API 服務的完整 IP 列表。這是經紀商伺服器向我們的 KuCoin Fast API 服務伺服器請求的 IP。
經紀商的完整交易 IP 列表。
重定向 URL
一旦經紀商提供上述三個,KuCoin 將會發送經紀商的唯一client_id

3. Fast API 服務#

經紀人用戶可以使用 KuCoin Oauth 登入授權經紀人獲取他們的交易和一般交易相關資訊。未經授權不得進行提現。

4. OpenAPI Demo#

URL :https://www.kucoin.com/_oauth/resource/ucenter/outer/api-key/add
method:POST
content-type:application/json
header: "Authorization":"bearer {token}"
parameter: no parameter needed
response:
{
	"success": true,
	"code": "200",
	"msg": "success",
	"retry": false,
	"data": {
    	"apiName": "",
    	"apiKey": "",
    	"secret": "",
    	"passphrase": "",
    	"brokerId": "",
    	"authGroup":         API_COMMON,API_FUTURES,API_SPOT,API_EARN,API_TRANSFER,API_MARGIN,
    	"ipWhiteList": ""
	}
}
常見錯誤:
1.
重複的 apiName
2.
使用者的 apiKey 數量達到了最大限制

5. 授權碼模式#

KuCoin 只提供授權碼模式。通過授權,經紀商提供 client_secret 來獲取授權碼。可以根據授權碼獲取訪問令牌Access token 和 Refresh token。經紀商保存密鑰並與 KuCoin OAuth2.0 服務器交互。
image.png

6. Token的使用#

6.1 不同Token的分別#

在經紀商通過授權碼調用 Token API 接口後,將會有兩種類型的 Token。
Access token: 用於經紀商調用 KuCoin OpenAPI 接口。
Refresh token: 用於在前一個 Access token 過期時獲取一個新的。

6.2 如何使用 Token#

在經紀商完成授權並獲得token後,它將能夠通過 access token 調用 KuCoin OpenAPI 接口。在請求時,經紀商需要在請求標頭中攜帶以下信息:
請求標頭參數是否必須描述
AuthorizationYes請將 Access Token 填寫到此欄位中。

6.3 Token 有效性#

access token : 1小時內有效
refresh token : 3天內有效
如果 access token 過期,該接口將不再可訪問。如果 refresh token 仍在有效期限內,經紀商需要調用 refresh token 接口以獲取一對新的 access token 和 refresh token。新的 access token 可以繼續使用。當通過 refresh token 獲取新的access token 時,舊的access token 無論是否過期都不能使用。

7. OAuth 控制器 API 設計#

7.1 OAuth 登入頁面#

image.png
URL: http://www.kucoin.com/oauth?response_type=code&client_id=XXXX&redirect_uri=XXX&scope=OAUTH_CREATE_API&state=123
Method: GET
Params
Response Type請使用授權碼模式
Client_id經紀商的 ID
Redirect_url經紀商的 URL
Scopeaccess_token 的範圍
State經紀商可以在這裡確定你的需求。但這是一個必填字段。你可以在這裡放入你系統的用戶 ID
Response : 
{ 
    "success": true, 
    "code": "668*********c711", 
    "msg": "success.", 
    "retry": false, 
    "data": null
    "state": XXX
}
請不要編碼重定向URL。

7.2 請求一個 Token#

URL: https://www.kucoin.com/_oauth/access-token?grant_type=authorization_code&code=xxxxxxxxxx&redirect_uri=https://www.xxxxxxxxxxxxx.com&client_id=xxxxxxxxx
Method: GET
參數是否必須描述
Grant_typeYesgrant_type=authorization_code
CodeYes
Redirect_urlYes
Client_idYes經紀商的 ID
Response : 
{
    "access_token":"",  	//access token received from user authorization
    "token_type":"bearer"       //token type, extension point to facilitate the   
                                  addition of more secure tokens in the future
    "expires_in":3600,  	//token expiration time, in seconds
    "refresh_token":,   	//token used to obtain a new access token after                                    
                                  the access token expires  
    "scope": ["", ""]   	//scope of permissions for the access token
}

請不要編碼重定向URL。

7.3 刷新一個 Token#

URL: https://www.kucoin.com/_oauth/refresh-token
Method: POST
Paramsis_requiredDescription
Grant_typeYesgrant_type=authorization_code
Refresh_tokenYes用於刷新身份驗證的 Token
ScopeYes
Response : 
{
    "access_token":"",        //token used to access resources
    "token_type":"bearer",    //token type, an extension point to facilitate the 
                                addition of more secure tokens in the future, such                                 
                                as MAC (Message Authentication Code). Bearer                                       
                                indicates a token that does not contain any        
                                information
    "expires_in":3600,        //token expiration time, in seconds
    "refresh_token":,         //token used to obtain a new access token after the 
                                access token expires
    "scope": [""OAUTH_CREATE_API""]   	//scope of permissions for the access token
}
Modified at 2025-11-14 03:10:47
Previous
簡介
Next
取得經紀返傭