Account¶
- class base.MarketConnection.Account(url, credentials: Dict, callbacks: Optional[Dict[str, Callable]] = None)¶
Bases:
object
账户类. 在建立连接后维护一个<balance>字典保存账户余额等信息, 维护<orders>字典保存订单信息, 维护<position>字典保存仓位信息. :param url: 连接的url, 通常为WS_PRIVATE_API_URL, 或WS_PRIVATE_API_URL_CN :param credentials: 字典, 包含了<api_key>, <api_secret_key>, <passphrase> :param callbacks: 字典, 包含了各类事件触发函数:
on_balance_update(hist_balance, balance)
on_position_update(hist_position, position)
on_orders_update(hist_orders, orders)
- <balance>结构
uTime String 获取账户信息的最新时间,Unix时间戳的毫秒数格式,如 1597026383085 totalEq String 美金层面权益 isoEq String 美金层面逐仓仓位权益
details Dict 各币种资产详细信息 - key String 币种 - value Dict 该币种相关账户信息
ccy String 币种
eq String 币种总权益
cashBal String 币种余额
uTime String 币种余额信息的更新时间,Unix时间戳的毫秒数格式,如 1597026383085
isoEq String 币种逐仓仓位权益
availEq String 可用保证金
disEq String 美金层面币种折算权益
frozenBal String 币种占用金额
ordFrozen String 挂单冻结数量
upl String Unrealized Gain/Loss 未实现盈亏
mgnRatio String 保证金率
twap String 当前负债币种触发系统自动换币的风险,仅适用于跨币种账户,通常为0:0、1、2、3、4、5其中之一,数字越大代表您的负债币种触发自动换币概率越高
<position>结构 - key String 币种 - value Dict
key String 持仓ID
- value Dict
instType String 产品类型,如 FUTURES
instId String 产品ID,如 BTC-USD-180216
posId String 持仓ID,如 1204952083528
mgnMode String 保证金模式, cross:全仓 isolated:逐仓
- posSide String 持仓方向
long:双向持仓多头 short:双向持仓空头 net:单向持仓
交割/永续/期权:pos为正代表多头,pos为负代表空头。 币币杠杆:posCcy为交易货币时,代表多头;posCcy为计价货币时,代表空头。
pos String 持仓数量
posCcy String 持仓数量币种,仅适用于币币杠杆
- availPos String 可平仓数量,适用于
币币杠杆,交割/永续(开平仓模式),期权(交易账户及保证金账户逐仓)。
- liab String 负债额
仅适用于币币杠杆
- liabCcy String 负债币种
仅适用于币币杠杆
ccy String 占用保证金的币种
avgPx String 开仓平均价
upl String 未实现收益
uplRatio String 未实现收益率
- lever String 杠杆倍数
不适用于期权卖方
- liqPx String 预估强平价
不适用于期权
- imr String 初始保证金
仅适用于全仓
- margin String 保证金余额
仅适用于逐仓,可增减
mgnRatio String 保证金率
mmr String 维持保证金
interest String 利息,已经生成未扣利息
adl String 信号区,分为5档,从1到5,数字越小代表adl强度越弱
last String 最新成交价
tradeId String 最新成交ID
optVal String 期权价值,仅适用于期权
deltaBS String 美金本位持仓仓位delta,仅适用于期权
deltaPA String 币本位持仓仓位delta,仅适用于交割、永续、期权
gammaBS String 美金本位持仓仓位gamma,仅适用于期权
gammaPA String 币本位持仓仓位gamma,仅适用于期权
thetaBS String 美金本位持仓仓位theta,仅适用于期权
thetaPA String 币本位持仓仓位theta,仅适用于期权
vegaBS String 美金本位持仓仓位vega,仅适用于期权
vegaPA String 币本位持仓仓位vega,仅适用于期权
cTime String 持仓创建时间,Unix时间戳的毫秒数格式,如 1597026383085
uTime String 最近一次持仓更新时间,Unix时间戳的毫秒数格式,如 1597026383085
pTime String 持仓信息的推送时间,Unix时间戳的毫秒数格式,如 1597026383085
<orders>结构 - key String 用户订单Id + “:-:” + 订单Id, 即 clOrdId + “:-:” + ordId - value Dict
instType String 产品类型
instId String 产品ID
ccy String 保证金币种,仅适用于单币种保证金账户下的全仓币币杠杆订单
ordId String 订单ID
clOrdId String 由用户设置的订单ID来识别您的订单
tag String 订单标签
px String 委托价格
sz String 原始委托数量,币币/币币杠杆,以币为单位;交割/永续/期权 ,以张为单位
- ordType String 订单类型
market:市价单 limit:限价单 post_only: 只做maker单 fok:全部成交或立即取消单 ioc:立即成交并取消剩余单
side String 订单方向,buy sell
- posSide String 持仓方向
long:双向持仓多头 short:双向持仓空头 net:单向持仓
- tdMode String 交易模式
保证金模式 isolated:逐仓 cross:全仓 非保证金模式 cash:现金
fillPx String 最新成交价格
tradeId String 最新成交ID
fillSz String 最新成交数量
fillTime String 最新成交时间
fillFee String 最新一笔成交的手续费
fillFeeCcy String 最新一笔成交的手续费币种
execType String 最新一笔成交的流动性方向 T:taker M maker
accFillSz String 累计成交数量
avgPx String 成交均价,如果成交数量为0,该字段也为0
- state String 订单状态
canceled:撤单成功 live:等待成交 partially_filled: 部分成交 filled:完全成交
lever String 杠杆倍数,0.01到125之间的数值,仅适用于 币币杠杆/交割/永续
tpTriggerPx String 止盈触发价
tpOrdPx String 止盈委托价,止盈委托价格为-1时,执行市价止盈
slTriggerPx String 止损触发价
slOrdPx String 止损委托价,止损委托价格为-1时,执行市价止损
- feeCcy String 交易手续费币种
币币/币币杠杆:如果是买的话,收取的就是BTC;如果是卖的话,收取的就是USDT 交割/永续/期权 收取的就是保证金
fee String 订单交易手续费,平台向用户收取的交易手续费
rebateCcy String 返佣金币种 ,如果没有返佣金,该字段为“”
rebate String 返佣金额,平台向达到指定lv交易等级的用户支付的挂单奖励(返佣),如果没有返佣金,该字段为“”
pnl String 收益
- category String 订单种类分类
normal:普通委托订单种类 twap:TWAP订单种类 adl:ADL订单种类 full_liquidation:爆仓订单种类 partial_liquidation:减仓订单种类
uTime String 订单更新时间, Unix时间戳的毫秒数格式,如 1597026383085
cTime String 订单创建时间, Unix时间戳的毫秒数格式,如 1597026383085
reqId String 修改订单时使用的request ID,如果没有修改,该字段为””
- amendResult String 修改订单的结果
-1: 失败 0:成功 1:自动撤单(因为修改成功导致订单自动撤销) 通过API修改订单时,如果cxlOnFail设置为false且修改失败后,则amendResult返回 -1 通过API修改订单时,如果cxlOnFail设置为true且修改失败后,则amendResult返回1 通过Web/APP修改订单时,如果修改失败后,则amendResult返回-1
code String 错误码,默认为0
msg String 错误消息,默认为””
Attributes Summary
Attributes Documentation
- balance: Dict¶
- orders: Dict¶
- position: Dict¶