账户接口

1. 查询账户信息

查询当前账户下专业合约资产的相关信息。

HTTP请求

    # Request
    POST api/v1/user/getBalance

请求方式

POST

请求参数

参数名	参数类型	必填	字段描述	描述
apiKey	String	是	接口秘钥
timestamp	String	是	发起请求的时间戳，单位为毫秒
currency	String	是	合约资产

返回值说明

参数名	参数类型	描述
code	Int64	错误码，0表示成功，不为0表示异常失败
msg	String	错误信息提示
userId	String	用户ID
currency	String	用户资产
balance	Float64	资产余额
equity	Float64	资产净值
unrealisedPNL	Float64	未实现盈亏
realisedPNL	Float64	已实现盈亏
availableMargin	Float64	可用保证金
usedMargin	Float64	已用保证金
freezedMargin	Float64	冻结保证金
longLeverage	Float64	做多杠杆
shortLeverage	Float64	做空杠杆

# Response
    {
        "code": 0,
        "msg": "",
        "data": {
            "userId": "123",
            "currency": "USDT",
            "balance": 123.33,
            "equity": 128.99,
            "unrealisedPNL": 1.22,
            "realisedPNL": 8.1,
            "availableMargin": 123.33,
            "usedMargin": 2.2,
            "freezedMargin": 3.3,
            "longLeverage": 10,
            "shortLeverage": 10,
        }
    }

2. 查询持仓信息

查询当前账户下专业合约的持仓信息与盈亏情况。

HTTP请求

    # Request
    POST api/v1/user/getPositions

请求方式

POST

请求参数

参数名	参数类型	必填	字段描述
symbol	String	是	合约名称中需有"-"，如BTC-USDT，为空则表示全部都返回
apiKey	String	是
timestamp	String	是	发起请求的时间戳，单位为毫秒

返回值说明

参数名	参数类型	描述
code	Int64	错误码，0表示成功，不为0表示异常失败
msg	String	错误信息提示
symbol	String	合约品种
currency	String	资产类型
positionId	String	仓位ID
positionSide	String	仓位方向 Long/Short 多/空
marginMode	String	保证金模式 Cross/Isolated 全仓/逐仓
volume	Float64	持仓数量
availableVolume	Float64	可平仓数量
unrealisedPNL	Float64	未实现盈亏
realisedPNL	Float64	已实现盈亏
margin	Float64	保证金
avgPrice	Float64	开仓均价
liquidatedPrice	Float64	预估强平价
leverage	Float64	杠杆

# Response
    {
       "code": 0,
       "msg": "",
       "data": {
            "positions": [
                {
                    "symbol": "BTC-USDT",
                    "positionId": "12345678",
                    "currency": "USDT",
                    "positionSide": "Long",
                    "marginMode": "Cross",
                    "volume": 123.33,
                    "availableVolume": 128.99,
                    "unrealisedPNL": 1.22,
                    "realisedPNL": 8.1,
                    "margin": 123.33,
                    "avgPrice": 2.2,
                    "liquidatedPrice": 2.2,
                    "leverage": 10,
                },
                {
                    "symbol": "ETH-USDT",
                    "currency": "USDT",
                    "positionSide": "Short",
                    "marginMode": "Isolated",
                    "volume": 123.33,
                    "availableVolume": 128.99,
                    "unrealisedPNL": 1.22,
                    "realisedPNL": 8.1,
                    "margin": 123.33,
                    "avgPrice": 2.2,
                    "liquidatedPrice": 2.2,
                    "leverage": 10,
                },
            ]
        }
    }