跳到主要内容

获取合约账户资产

API说明​

此接口允许用户查询合约账户资产信息，包括可用保证金、USDT/USDC 余额和冻结资产等。

注意：合约账户资产数据可通过RESTful和Websocket接口获取。本页是RESTful接口的描述。如需了解Websocket接口，请参见 跳转

注意事项​

  1. 响应参数"availableMargin"在已成交订单的情况下可能具有误导性，因为它包括"alMargin"（当前分配给已成交订单的保证金），而不仅仅是自由可用的保证金。更多说明请参考官方网站。

认证​

这是一个私有接口，需要认证。有关使用RESTful API的详细信息，请参考公共 > 认证和代码示例 > 合约 > RESTful私有接口。

请求方法​

GET

接口地址​

/v1/perpum/account/getUserAssets

频率限制​

该接口的调用频率限制为：每个 IP 和用户 ID 每2秒最多请求5次。
此外，该接口还受到全局频率限制的约束。
有关"全局速率限制"和"API限频策略"的详细信息，请参阅“频率限制”部分，跳转

请求参数​

参数必填类型描述
quotefalseString结算币种。可选值：usdt、usdc。
当传入 usdc 时返回 USDC 资产；不传时默认返回 USDT 资产。

响应参数​

参数类型描述
availableMarginBigDecimal可用保证金余额（包括万能金）
userIdLong合约账户用户ID
almightyGoldBigDecimal可用万能金余额
availableUsdtBigDecimal可用USDT / USDC余额
alMarginBigDecimal持有资产（用于已成交订单）
alFreezeBigDecimal冻结资产（用于未成交订单）
timeLong检索响应数据的时间戳
data.tsLong时间戳（毫秒）

请求示例​

以下Python代码展示了如何获取用户的合约账户资产信息。

注意：完整代码示例请参考公共 > 认证和代码示例 > 合约 > RESTful私有接口。

params = {
  "quote": "usdc",   # optional
}
api_url = "/v1/perpum/account/getUserAssets"
method = "GET"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key) # the function FuturesRestfulPrivate() is defined in section (Common > Authentication & Code Snippet > Futures > RESTful Private Interface)

注意：完整Java代码示例请参考公共 > 认证和代码示例 > 合约 > RESTful私有接口。

响应示例​

以下是上述Python请求返回的示例响应：

{'code': 0,
 'data': {'alFreeze': 0,
  'alMargin': 0.14311,
  'almightyGold': 4.64407693,
  'availableMargin': 499.71964459000003,
  'availableUsdt': 495.07556766,
  'time': 1742374984772,
  'ts': 1775443378356,
  'userId': 1162061},
 'msg': ''}