跳到主要内容

获取万能金余额

API说明

此接口提供万能金余额信息,允许用户根据时间范围和状态筛选数据。它提供万能金余额、状态和有效期等关键详情,实现高效的资产管理。此外,此接口帮助用户确定使用时是否需要高级身份验证。

有关万能金的更多信息,请参考 https://coinw.zendesk.com/hc/en-us/articles/23111150445977-Introduction-to-Futures-Mega-Coupon

注意:万能金余额数据可通过RESTful和Websocket接口获取。本页是RESTful接口的描述。如需了解Websocket接口,请参见 跳转

注意事项

认证

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

请求方法

GET

接口地址

/v1/perpum/account/almightyGoldInfo

频率限制

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

请求参数

参数必填类型描述
startTimefalseLong有效期开始时间
endTimefalseLong有效期截止时间
typetrueInteger万能金状态:0:待生效,1:未使用,2:已使用,3:已过期,4:发放失败

响应参数

参数类型描述
idLong万能金ID
assetsOutInteger转出的资产是否无效:1:是,0:否
agRecordIdInteger发放记录ID
kycInteger是否需要高级KYC:1:是,0:否
currentAmountBigDecimal剩余金额
totalAmountBigDecimal万能金总额
typeInteger状态:0:待生效,1:未使用,2:已使用,3:已过期,4:发放失败
startTimelong有效期开始的时间戳
endTimelong有效期结束的时间戳
remarkString备注
createdDatelong创建日期的时间戳
updateDatelong最后更新的时间戳
userIdLong用户ID

请求示例

以下Python代码展示了如何获取万能金余额信息。

注意:完整代码示例请参考简介 > 认证和代码示例 > 合约 > RESTful私有接口。

params = {
# "startTime" : "1740467460000",
# "endTime" : "1740467430000",
"type" : 3,
}
api_url = "/v1/perpum/account/almightyGoldInfo"
method = "GET"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key). # the function FuturesRestfulPrivate() is defined in section (Introduction > Authentication & Code Snippet > Futures > RESTful Private Interface)

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

响应示例

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

{'code': 0,
'data': [{'agRecordId': 4004,
'assetsOut': 0,
'backAmount': 0,
'backMark': 0,
'createdDate': 1740555154000,
'currentAmount': 5,
'endTime': 1742918400000,
'id': 800149683,
'kyc': 0,
'name': '万能金',
'processStatus': 0,
'remark': '产品测试 Aimen Malik',
'startTime': 1740555125000,
'totalAmount': 5,
'transferExpire': 0,
'type': 1,
'updateDate': 1740555154000,
'userId': 1162061}],
'msg': ''}