REST API

使用者與帳號

以 Markdown 格式查看

除非另有說明，以下端點可使用 JWT 或 API Key 簽名。

使用者資訊

1GET /v1/private/user/info

回應欄位：

場地類型描述
userInfo.userIdstring外部使用者識別碼
userInfo.usernamestring用戶名
userInfo.agentIdint64代理識別碼
userInfo.vipLevelint64VIP 層
userInfo.lastLoginAtint64最後一次登入時間
userInfo.lastLoginIpstring最後登入 IP

使用者資產

1GET /v1/private/user/asset

回應欄位：

場地類型描述
userAsset.userIdstring外部使用者識別碼
userAsset.assetTypestring資產類型
userAsset.walletBalancestring錢包餘額
userAsset.frozenMarginstring因待處理訂單而凍結的邊界
userAsset.usedMarginstring倉位所使用的邊距

創造 listenKey

1POST /v1/private/user/listen-key

為私有 WebSocket 串流建立認證金鑰。

續約 listenKey

1PUT /v1/private/user/listen-key

這也 listenKey 有效性。

接近的 listenKey

1DELETE /v1/private/user/listen-key

閉合指定的 listenKey。

帳號變更日誌

1GET /v1/private/user/account-change-log?assetType=USDT&page=1&pageSize=20

請求參數：

參數類型必修描述
assetTypestring不資產類型，例如 USDT
changeTypestring不變更類型
startTimeint64不開賽時間
endTimeint64不終結時間
pageint32不頁碼，預設 1
pageSizeint32不每頁項目數，預設 20

回應欄位：

場地類型描述
list[].assetTypestring資產類型
list[].amountstring金額變更
list[].walletBalanceBeforestring找零前的錢包餘額
list[].walletBalanceAfterstring找零後的錢包餘額
list[].frozenBalanceBeforestring變動前凍結餘額
list[].frozenBalanceAfterstring變動後凍結餘額
list[].changeTypestring變更類型
list[].referenceIdstring相關商業識別
list[].createdAtint64創作時間
totalint64總計數

30天成交量統計

1GET /v1/private/user/volume-stats

回應欄位：

場地類型描述
volume30dstring過去30天累計交易量
feeTotal30dstring過去30天累積費用

平衡歷史

1GET /v1/private/user/balance-history?period=1D&limit=30

請求參數：

參數類型必修描述
periodstring是的1D / 1W / 1M
limit智力不退回物品數量，預設 30

回應欄位：

場地類型描述
items[].datestring合併日期
items[].balancestring錢包餘額
items[].pnlstring當時實現的PnL

貿易概覽

1GET /v1/private/user/trade-overview?type=1M

請求參數：

參數類型必修描述
typestring是的趨勢範圍： 1D、 1W、 1M、 3M、 6M、 1Y

回應欄位：

場地類型描述
todayPnlstring今日實現的PnL
todayVolumestring今日合約交易量
totalVolumestring累積合約交易量
totalPnlstring累積實現PnL
maxDrawdown30dstring過去30天的最大提領金額
maxDrawdown30dRatestring過去30天的最大回撤率，從0到1按小數排列
transferInstring累積轉入資金
transferOutstring累積轉出資金
items[]array資產趨勢資料

資產概覽摘要

1GET /v1/private/user/asset/overview/summary

回應欄位與交易概覽摘要欄位相同，但不包含 items[]。

資產概覽趨勢

1GET /v1/private/user/asset/overview/trend?type=1M

請求參數：

參數類型必修描述
typestring是的趨勢範圍： 1D、 1W、 1M、 3M、 6M、 1Y

回應欄位：

場地類型描述
items[].snapshotTimeint64快照時間
items[].balancestring經常帳餘額
items[].pnlstringPnL 現行時期
items[].pnlRatestring本期PnL利率
items[].totalPnlstring累積損益

最喜愛的象徵

存檔

1POST /v1/private/user/favorite-symbols
2Content-Type: application/json

請求正文：

1{
2  "symbols": ["BTCUSDT", "ETHUSDT"]
3}

查詢

1GET /v1/private/user/favorite-symbols

回應欄位：

場地類型描述
symbols弦[]最喜愛的符號列表