REST API

ユーザーとアカウント

Markdownとして表示

特に指定がない限り、以下のエンドポイントは JWT 署名または API Key 署名を使用できます。

ユーザー情報

1GET /v1/private/user/info

応答フィールド:

フィールド種類概要
userInfo.userIdstring外部ユーザーID
userInfo.usernamestringユーザー名
userInfo.agentIdint64エージェントID
userInfo.vipLevelint64VIP レベル
userInfo.lastLoginAtint64最終ログイン時間
userInfo.lastLoginIpstring最後のログイン IP

ユーザー資産

1GET /v1/private/user/asset

応答フィールド:

フィールド種類概要
userAsset.userIdstring外部ユーザーID
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関連事業ID
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[].pnlstring現在の期間のPnL
items[].pnlRatestring現在期間のPnLレート
items[].totalPnlstring累積PnL

お気に入りのシンボル

セーブ

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

要請本体:

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

クエリ

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

応答フィールド:

フィールド種類概要
symbolsストリング[]お気に入りのシンボルリスト