Serialized Form

Package xyz.felh.okx.v5.entity

Package xyz.felh.okx.v5.entity.rest

Exception Class xyz.felh.okx.v5.entity.rest.OkeHttpException

class OkeHttpException extends RuntimeException implements Serializable

Serialized Fields

okxRestError

OkxRestError okxRestError

Class xyz.felh.okx.v5.entity.rest.OkxRestError

class OkxRestError extends Object implements Serializable

Serialized Fields

code

Integer code

msg

String msg

Class xyz.felh.okx.v5.entity.rest.OkxRestResponse

class OkxRestResponse extends Object implements Serializable

Serialized Fields

code

Integer code

结果代码，0表示成功

data

List<T extends IOkxRestRsp> data

inTime

Long inTime

REST网关接收请求时的时间戳，Unix时间戳的微秒数格式，如 1597026383085123 返回的时间是请求验证后的时间。

msg

String msg

错误信息，代码为0时，该字段为空

outTime

Long outTime

REST网关发送响应时的时间戳，Unix时间戳的微秒数格式，如 1597026383085123

Package xyz.felh.okx.v5.entity.rest.account

Class xyz.felh.okx.v5.entity.rest.account.Balance

class Balance extends Object implements Serializable

Serialized Fields

adjEq

BigDecimal adjEq

美金层面有效保证金 适用于跨币种保证金模式/组合保证金模式

borrowFroz

BigDecimal borrowFroz

账户美金层面潜在借币占用保证金 仅适用于跨币种保证金模式/组合保证金模式。在其他账户模式下为""。

details

List<Balance.Detail> details

各币种资产详细信息

imr

BigDecimal imr

美金层面占用保证金 适用于跨币种保证金模式/组合保证金模式

isoEq

BigDecimal isoEq

美金层面逐仓仓位权益 适用于单币种保证金模式/跨币种保证金模式/组合保证金模式

mgnRatio

BigDecimal mgnRatio

美金层面保证金率 适用于跨币种保证金模式/组合保证金模式

mmr

BigDecimal mmr

美金层面维持保证金 适用于跨币种保证金模式/组合保证金模式

notionalUsd

BigDecimal notionalUsd

以美金价值为单位的持仓数量，即仓位美金价值 适用于跨币种保证金模式/组合保证金模式

ordFroz

BigDecimal ordFroz

美金层面全仓挂单占用保证金 仅适用于跨币种保证金模式

totalEq

BigDecimal totalEq

美金层面权益

upl

BigDecimal upl

账户层面全仓未实现盈亏（美元单位） 适用于跨币种保证金模式/组合保证金模式

uTime

Long uTime

账户信息的更新时间，Unix时间戳的毫秒数格式，如 1597026383085

Package xyz.felh.okx.v5.entity.ws

Package xyz.felh.okx.v5.entity.ws.biz

Class xyz.felh.okx.v5.entity.ws.biz.DepositInfo

class DepositInfo extends Object implements Serializable

Serialized Fields

actualDepBlkConfirm

Integer actualDepBlkConfirm

最新的充币网络确认数

amt

BigDecimal amt

充值数量

areaCodeFrom

String areaCodeFrom

如果from为手机号，该字段为该手机号的区号

ccy

String ccy

币种名称，如 BTC

chain

String chain

币种链信息 有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20多个链

depId

String depId

充值记录 ID

from

String from

充值账户，只显示内部账户转账地址，不显示区块链充值地址

fromWdId

String fromWdId

内部转账发起者提币申请 ID 如果该笔充值来自于内部转账，则该字段展示内部转账发起者的提币申请 ID，其他情况返回""

pTime

Long pTime

推送时间，Unix时间戳的毫秒数格式，如 1597026383085

state

Integer state

账充值状态 0：等待确认 1：确认到账 2：充值成功 8：因该币种暂停充值而未到账，恢复充值后自动到账 11：命中地址黑名单 12：账户或充值被冻结 13：子账户充值拦截 14：KYC限额

subAcct

String subAcct

子账户名称 如果是母账户产生的数据，该字段返回""

to

String to

到账地址

ts

Long ts

充值记录创建时间，Unix 时间戳的毫秒数格式，如 1655251200000

txId

String txId

区块转账哈希记录

uid

String uid

(产生数据者的）用户标识

Class xyz.felh.okx.v5.entity.ws.biz.EconomicCalendar

class EconomicCalendar extends Object implements Serializable

Serialized Fields

actual

BigDecimal actual

事件实际值

calendarId

String calendarId

经济日历ID

category

String category

类别名

ccy

String ccy

事件实际值对应的货币

date

Long date

actual字段值的预期发布时间，Unix时间戳的毫秒数格式，如 1597026383085

event

String event

事件名

forecast

BigDecimal forecast

由权威经济学家共同得出的预测值

importance

Integer importance

重要性 1: 低 2: 中等 3: 高

prevInitial

BigDecimal prevInitial

该事件上一周期的初始值 仅在修正发生时有值

previous

BigDecimal previous

当前事件上个周期的最新实际值 若发生数据修正，该字段存储上个周期修正后的实际值

refDate

Long refDate

当前事件指向的日期

region

String region

国家，地区或实体

ts

Long ts

推送时间，Unix 时间戳的毫秒数格式，如 1655251200000

unit

String unit

事件实际值对应的单位

Class xyz.felh.okx.v5.entity.ws.biz.IndexCandlesticks

class IndexCandlesticks extends Object implements Serializable

Serialized Fields

c

BigDecimal c

收盘价格

confirm

Boolean confirm

K线状态

h

BigDecimal h

最高价格

l

BigDecimal l

最低价格

o

BigDecimal o

开盘价格

ts

Long ts

开始时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.biz.MarkPriceCandlesticks

class MarkPriceCandlesticks extends Object implements Serializable

Serialized Fields

c

BigDecimal c

收盘价格

confirm

Boolean confirm

K线状态

h

BigDecimal h

最高价格

l

BigDecimal l

最低价格

o

BigDecimal o

开盘价格

ts

Long ts

开始时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.biz.WithdrawalInfo

class WithdrawalInfo extends Object implements Serializable

Serialized Fields

addrEx

Object addrEx

提币地址备注。如币种TONCOIN的提币地址备注标签名为comment,则该字段返回：{'comment':'123456'}

amt

BigDecimal amt

数量

areaCodeFrom

String areaCodeFrom

如果from为手机号，该字段为该手机号的区号

areaCodeTo

String areaCodeTo

如果to为手机号，该字段为该手机号的区号

ccy

String ccy

币种

chain

String chain

币种链信息 有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20多个链

clientId

String clientId

客户自定义ID

fee

BigDecimal fee

提币手续费数量

feeCcy

String feeCcy

提币手续费币种，如 USDT > state String

from

String from

提币账户 可以是邮箱/手机号/子账户名

memo

String memo

部分币种提币需要此字段

nonTradableAsset

Boolean nonTradableAsset

是否为不可交易资产 true：不可交易资产，false：可交易资产

pmtId

String pmtId

部分币种提币需要此字段（payment_id）

pTime

Long pTime

推送时间，Unix时间戳的毫秒数格式，如 1597026383085

state

Integer state

提币状态

阶段1：等待提币 10：等待划转 0：等待提币 4/5/6/8/9/12：等待客服审核 7：审核通过

阶段2：提币处理中（适用于链上提币，内部转账无此阶段） 1：正在将您的交易广播到链上 15：交易待确认 16：根据当地法律法规，您的提币最多可能需要 24 小时才能到账 -3：撤销中

最终阶段 -2：已撤销 -1：失败 2：提币成功

subAcct

String subAcct

子账户名称 如果是母账户产生的数据，该字段返回""

tag

String tag

部分币种提币需要标签

to

String to

收币地址

ts

Long ts

提币申请时间，Unix 时间戳的毫秒数格式，如 1655251200000

txId

String txId

提币哈希记录 内部转账该字段返回""

uid

String uid

(产生数据者的）用户标识

wdId

String wdId

提币申请ID

Package xyz.felh.okx.v5.entity.ws.pri

Class xyz.felh.okx.v5.entity.ws.pri.Account

class Account extends Object implements Serializable

Serialized Fields

adjEq

BigDecimal adjEq

美金层面有效保证金 适用于跨币种保证金模式/组合保证金模式

borrowFroz

BigDecimal borrowFroz

账户美金层面潜在借币占用保证金 仅适用于跨币种保证金模式/组合保证金模式。在其他账户模式下为""。

details

List<Account.Detail> details

各币种资产详细信息

imr

BigDecimal imr

美金层面占用保证金 适用于跨币种保证金模式/组合保证金模式

isoEq

BigDecimal isoEq

美金层面逐仓仓位权益 适用于单币种保证金模式/跨币种保证金模式/组合保证金模式

mgnRatio

BigDecimal mgnRatio

美金层面保证金率 适用于跨币种保证金模式/组合保证金模式

mmr

BigDecimal mmr

美金层面维持保证金 适用于跨币种保证金模式/组合保证金模式

notionalUsd

BigDecimal notionalUsd

以美金价值为单位的持仓数量，即仓位美金价值 适用于跨币种保证金模式/组合保证金模式

ordFroz

BigDecimal ordFroz

美金层面全仓挂单占用保证金 仅适用于跨币种保证金模式

totalEq

BigDecimal totalEq

美金层面权益

upl

BigDecimal upl

账户层面全仓未实现盈亏（美元单位） 适用于跨币种保证金模式/组合保证金模式

uTime

Long uTime

获取账户信息的最新时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pri.AccountGreeks

class AccountGreeks extends Object implements Serializable

Serialized Fields

ccy

String ccy

币种

deltaBS

BigDecimal deltaBS

美金本位账户资产delta

deltaPA

BigDecimal deltaPA

币本位账户资产delta

gammaBS

BigDecimal gammaBS

美金本位账户资产gamma，仅适用于期权

gammaPA

BigDecimal gammaPA

币本位账户资产gamma，仅适用于期权

thetaBS

BigDecimal thetaBS

美金本位账户资产theta，仅适用于期权

thetaPA

BigDecimal thetaPA

币本位账户资产theta，仅适用于期权

ts

Long ts

获取greeks的时间，Unix时间戳的毫秒数格式，如 1597026383085

vegaBS

BigDecimal vegaBS

美金本位账户资产vega，仅适用于期权

vegaPA

BigDecimal vegaPA

币本位账户资产vega，仅适用于期权

Class xyz.felh.okx.v5.entity.ws.pri.BalanceAndPosition

class BalanceAndPosition extends Object implements Serializable

Serialized Fields

balData

List<BalanceAndPosition.BalanceData> balData

余额数据

eventType

EventType eventType

事件类型

posData

List<BalanceAndPosition.PositionData> posData

持仓数据

pTime

Long pTime

推送时间，Unix时间戳的毫秒数格式，如 1597026383085

trades

List<BalanceAndPosition.Trade> trades

成交数据

Class xyz.felh.okx.v5.entity.ws.pri.BalanceAndPosition.BalanceData

class BalanceData extends Object implements Serializable

Serialized Fields

cashBal

BigDecimal cashBal

币种余额

ccy

String ccy

币种

uTime

Long uTime

币种余额信息的更新时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pri.BalanceAndPosition.PositionData

class PositionData extends Object implements Serializable

Serialized Fields

avgPx

BigDecimal avgPx

开仓平均价

ccy

String ccy

占用保证金的币种

instId

String instId

交易产品ID，如 BTC-USD-180213

instType

InstrumentType instType

交易产品类型

mgnMode

MgnMode mgnMode

保证金模式

pos

BigDecimal pos

持仓数量，逐仓自主划转模式下，转入保证金后会产生pos为0的仓位

posCcy

String posCcy

持仓数量币种 只适用于币币杠杆仓位。当是交割、永续、期权持仓时，该字段返回“”

posId

String posId

持仓ID

posSide

PositionsSide posSide

持仓方向

tradeId

String tradeId

最新成交ID

uTime

Long uTime

仓位信息的更新时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pri.BalanceAndPosition.Trade

class Trade extends Object implements Serializable

Serialized Fields

instId

String instId

产品ID，如 BTC-USDT

tradeId

String tradeId

最新成交ID

Class xyz.felh.okx.v5.entity.ws.pri.LiquidationWarning

class LiquidationWarning extends Object implements Serializable

Serialized Fields

ccy

String ccy

占用保证金的币种

cTime

Long cTime

持仓创建时间，Unix时间戳的毫秒数格式，如 1597026383085

instId

String instId

产品ID，如 BTC-USD-180216

instType

InstrumentType instType

产品类型

lever

BigDecimal lever

杠杆倍数，不适用于期权卖方

markPx

BigDecimal markPx

标记价格

mgnMode

MgnMode mgnMode

保证金模式

mgnRatio

BigDecimal mgnRatio

保证金率

pos

BigDecimal pos

持仓数量

posCcy

String posCcy

持仓数量币种，仅适用于币币杠杆

posId

String posId

持仓ID

posSide

PositionsSide posSide

持仓方向

pTime

Long pTime

持仓信息的推送时间，Unix时间戳的毫秒数格式，如 1597026383085

uTime

Long uTime

最近一次持仓更新时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pri.Order

class Order extends Object implements Serializable

Serialized Fields

accFillSz

BigDecimal accFillSz

累计成交数量 对于币币和杠杆，单位为交易货币，如 BTC-USDT, 单位为 BTC；对于市价单，无论tgtCcy是base_ccy，还是quote_ccy，单位均为交易货币； 对于交割、永续以及期权，单位为张。

algoClOrdId

String algoClOrdId

客户自定义策略订单ID。策略订单触发，且策略单有algoClOrdId时有值，否则为"",

algoId

String algoId

策略委托单ID，策略订单触发时有值，否则为""

amendResult

Integer amendResult

修改订单的结果 -1：失败 0：成功 1：自动撤单（修改请求返回成功但最终改单失败导致自动撤销） 2: 自动改单成功，仅适用于期权pxUsd和pxVol订单的自动改单 通过API修改订单时，如果cxlOnFail设置为true且修改返回结果为失败时，则返回 "" 通过API修改订单时，如果修改返回结果为成功但修改最终失败后，当cxlOnFail设置为false时返回 -1;当cxlOnFail设置为true时则返回1 通过Web/APP修改订单时，如果修改失败后，则返回-1

amendSource

Integer amendSource

订单修改的来源 1: 用户主动改单，改单成功 2: 用户主动改单，并且当前这笔订单被只减仓修改，改单成功 3: 用户主动下单，并且当前这笔订单被只减仓修改，改单成功 4: 用户当前已存在的挂单（非当前操作的订单），被只减仓修改，改单成功 5：期权 px, pxVol 或 pxUsd 的跟随变动导致的改单，比如 iv=60，usd，px 锚定iv=60 时，usd, px 产生变动时的改单

attachAlgoClOrdId

String attachAlgoClOrdId

下单附带止盈止损时，客户自定义的策略订单ID

attachAlgoOrds

List<Order.AttachAloOrder> attachAlgoOrds

下单附带止盈止损信息

avgPx

BigDecimal avgPx

成交均价，如果成交数量为0，该字段也为0

cancelSource

Integer cancelSource

订单取消的来源 有效值及对应的含义是： 0: 已撤单：系统撤单 1: 用户主动撤单 2: 已撤单：预减仓撤单，用户保证金不足导致挂单被撤回 3: 已撤单：风控撤单，用户保证金不足有爆仓风险，导致挂单被撤回 4: 已撤单：币种借币量达到平台硬顶，系统已撤回该订单 6: 已撤单：触发 ADL 撤单，用户保证金率较低且有爆仓风险，导致挂单被撤回 7: 已撤单：交割合约到期 9: 已撤单：扣除资金费用后可用余额不足，系统已撤回该订单 13: 已撤单：FOK 委托订单未完全成交，导致挂单被完全撤回 14: 已撤单：IOC 委托订单未完全成交，仅部分成交，导致部分挂单被撤回 15: 已撤单：该订单委托价不在限价范围内 17: 已撤单：平仓单被撤单，由于仓位已被市价全平 20: 系统倒计时撤单 21: 已撤单：相关仓位被完全平仓，系统已撤销该止盈止损订单 22, 23: 已撤单：只减仓订单仅允许减少仓位数量，系统已撤销该订单 27: 成交滑点超过5%，触发成交差价保护导致系统撤单 31: 当前只挂单订单 (Post only) 将会吃掉挂单深度 32: 自成交保护 33: 当前 taker 订单匹配的订单数量超过最大限制 36: 关联止损被触发，撤销限价止盈 37: 关联止损被撤销，撤销限价止盈 38: 您已撤销做市商保护 (MMP) 类型订单 39: 因做市商保护 (MMP) 被触发，该类型订单已被撤销

category

OrderCategory category

订单种类分类

ccy

String ccy

保证金币种，仅适用于单币种保证金账户下的全仓币币杠杆订单

clOrdId

String clOrdId

由用户设置的订单ID来识别您的订单

code

Integer code

错误码，默认为0

cTime

Long cTime

订单创建时间，Unix时间戳的毫秒数格式，如 1597026383085

execType

ExecType execType

最新一笔成交的流动性方向 T：taker M：maker

fee

BigDecimal fee

订单交易累计的手续费与返佣 对于币币和杠杆，为订单交易累计的手续费，平台向用户收取的交易手续费，为负数。如： -0.01 对于交割、永续和期权，为订单交易累计的手续费和返佣

feeCcy

String feeCcy

交易手续费币种 币币/币币杠杆：如果是买的话，收取的就是交易币；如果是卖的话，收取的就是计价币。 交割/永续/期权 收取的就是保证金

fillFee

BigDecimal fillFee

最新一笔成交的手续费金额或者返佣金额： 手续费扣除 为 ‘负数’，如 -0.01 ； 手续费返佣 为 ‘正数’，如 0.01

fillFeeCcy

String fillFeeCcy

最新一笔成交的手续费币种或者返佣币种。 如果fillFee小于0，为手续费币种；如果fillFee大于等于0，为返佣币种

fillFwdPx

BigDecimal fillFwdPx

成交时的远期价格，仅适用于期权，其他业务线返回空字符串""

fillMarkPx

BigDecimal fillMarkPx

成交时的标记价格，仅适用于 交割/永续/期权

fillMarkVol

BigDecimal fillMarkVol

成交时的标记波动率，仅适用于期权，其他业务线返回空字符串""

fillNotionalUsd

BigDecimal fillNotionalUsd

委托单已成交的美元价值

fillPnl

BigDecimal fillPnl

最新成交收益，适用于有成交的平仓订单。其他情况均为0。

fillPx

BigDecimal fillPx

最新成交价格

fillPxUsd

BigDecimal fillPxUsd

成交时的期权价格，以USD为单位仅适用于期权，其他业务线返回空字符串""

fillPxVol

BigDecimal fillPxVol

成交时的隐含波动率仅适用于期权，其他业务线返回空字符串""

fillSz

BigDecimal fillSz

最新成交数量 对于币币和杠杆，单位为交易货币，如 BTC-USDT, 单位为 BTC；对于市价单，无论tgtCcy是base_ccy，还是quote_ccy，单位均为交易货币； 对于交割、永续以及期权，单位为张。

fillTime

Long fillTime

最新成交时间

instId

String instId

产品ID

instType

InstrumentType instType

产品类型

isTpLimit

Boolean isTpLimit

是否为限价止盈，true 或 false.

lastPx

BigDecimal lastPx

最新成交价

lever

BigDecimal lever

杠杆倍数，0.01到125之间的数值，仅适用于 币币杠杆/交割/永续

msg

String msg

错误消息，默认为""

notionalUsd

BigDecimal notionalUsd

委托单预估美元价值

ordId

String ordId

订单ID

ordType

OrderType ordType

订单类型 market：市价单 limit：限价单 post_only：只做maker单 fok：全部成交或立即取消单 ioc：立即成交并取消剩余单 optimal_limit_ioc：市价委托立即成交并取消剩余（仅适用交割、永续） mmp：做市商保护(仅适用于组合保证金账户模式下的期权订单) mmp_and_post_only：做市商保护且只做maker单(仅适用于组合保证金账户模式下的期权订单) op_fok：期权简选（全部成交或立即取消）

pnl

BigDecimal pnl

收益，适用于有成交的平仓订单，其他情况均为0 对于合约全仓爆仓，将包含相应强平惩罚金

posSide

PositionsSide posSide

持仓方向 long：开平仓模式开多 short：开平仓模式开空 net：买卖模式

px

BigDecimal px

委托价格，对于期权，以币(如BTC, ETH)为单位

pxType

PriceType pxType

期权的价格类型 px：代表按价格下单，单位为币 (请求参数 px 的数值单位是BTC或ETH) pxVol：代表按pxVol下单 pxUsd：代表按照pxUsd下单，单位为USD (请求参数px 的数值单位是USD)

pxUsd

BigDecimal pxUsd

期权价格，以USD为单位 仅适用于期权，其他业务线返回空字符串""

pxVol

BigDecimal pxVol

期权订单的隐含波动率 仅适用于期权，其他业务线返回空字符串""

quickMgnType

QuickMgnType quickMgnType

一键借币类型，仅适用于杠杆逐仓的一键借币模式 manual：手动，auto_borrow：自动借币，auto_repay：自动还币

rebate

BigDecimal rebate

返佣累计金额，仅适用于币币和杠杆，平台向达到指定lv交易等级的用户支付的挂单奖励（返佣），如果没有返佣金，该字段为“”

rebateCcy

String rebateCcy

返佣金币种 ，如果没有返佣金，该字段为“”

reduceOnly

Boolean reduceOnly

是否只减仓，true 或 false

reqId

String reqId

修改订单时使用的request ID，如果没有修改，该字段为""

side

Side side

订单方向，buy sell

slOrdPx

BigDecimal slOrdPx

止损委托价，止损委托价格为-1时，执行市价止损

slTriggerPx

BigDecimal slTriggerPx

止损触发价

slTriggerPxType

TriggerPxType slTriggerPxType

止损触发价类型

source

Integer source

订单来源 6：计划委托策略触发后的生成的普通单 7：止盈止损策略触发后的生成的普通单 13：策略委托单触发后的生成的普通单 24：移动止盈止损策略触发后的生成的普通单

state

OrderState state

订单状态 canceled：撤单成功 live：等待成交 partially_filled：部分成交 filled：完全成交 mmp_canceled：做市商保护机制导致的自动撤单

stpMode

StpMode stpMode

自成交保护模式

sz

BigDecimal sz

原始委托数量，币币/币币杠杆，以币为单位；交割/永续/期权 ，以张为单位

tag

String tag

订单标签

tdMode

TdMode tdMode

交易模式 保证金模式 isolated：逐仓 cross：全仓 非保证金模式 cash：现金

tgtCcy

String tgtCcy

市价单委托数量sz的单位 base_ccy: 交易货币 quote_ccy：计价货币

tpOrdPx

BigDecimal tpOrdPx

止盈委托价，止盈委托价格为-1时，执行市价止盈

tpTriggerPx

BigDecimal tpTriggerPx

止盈触发价

tpTriggerPxType

TriggerPxType tpTriggerPxType

止盈触发价类型

tradeId

String tradeId

最新成交ID

uTime

Long uTime

订单更新时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pri.Positions

class Positions extends Object implements Serializable

Serialized Fields

adl

Integer adl

信号区，分为5档，从1到5，数字越小代表adl强度越弱

availPos

BigDecimal availPos

可平仓数量，适用于 币币杠杆,交割/永续（开平仓模式），期权 对于杠杆仓位，平仓时，杠杆还清负债后，余下的部分会视为币币交易，如果想要减少币币交易的数量，可通过"获取最大可用数量"接口获取只减仓的可用数量。

avgPx

BigDecimal avgPx

开仓平均价

bePx

BigDecimal bePx

盈亏平衡价

bizRefId

String bizRefId

外部业务id，e.g. 体验券id

bizRefType

String bizRefType

外部业务类型

ccy

String ccy

占用保证金的币种

closeOrderAlgo

List<Positions.CloseOrderAlgo> closeOrderAlgo

平仓策略委托订单。调用策略委托下单，且closeFraction=1 时，该数组才会有值。

cTime

Long cTime

持仓创建时间，Unix时间戳的毫秒数格式，如 1597026383085

deltaBS

BigDecimal deltaBS

美金本位持仓仓位delta，仅适用于期权

deltaPA

BigDecimal deltaPA

币本位持仓仓位delta，仅适用于期权

fee

BigDecimal fee

累计手续费金额，正数代表平台返佣 ，负数代表平台扣除

fundingFee

BigDecimal fundingFee

累计资金费用

gammaBS

BigDecimal gammaBS

美金本位持仓仓位gamma，仅适用于期权

gammaPA

BigDecimal gammaPA

币本位持仓仓位gamma，仅适用于期权

idxPx

BigDecimal idxPx

最新指数价格

imr

BigDecimal imr

初始保证金，仅适用于全仓

instId

String instId

产品ID，如 BTC-USD-180216

instType

InstrumentType instType

产品类型

interest

BigDecimal interest

利息，已经生成未扣利息

last

BigDecimal last

最新成交价

lever

BigDecimal lever

杠杆倍数，不适用于期权卖方

liab

BigDecimal liab

负债额，仅适用于币币杠杆

liabCcy

String liabCcy

负债币种，仅适用于币币杠杆

liqPenalty

BigDecimal liqPenalty

累计爆仓罚金，有值时为负数。

liqPx

BigDecimal liqPx

预估强平价 不适用于期权

margin

BigDecimal margin

保证金余额，仅适用于逐仓，可增减

markPx

BigDecimal markPx

最新标记价格

mgnMode

MgnMode mgnMode

保证金模式

mgnRatio

BigDecimal mgnRatio

保证金率

mmr

BigDecimal mmr

维持保证金

notionalUsd

BigDecimal notionalUsd

以美金价值为单位的持仓数量

optVal

BigDecimal optVal

期权价值，仅适用于期权

pendingCloseOrdLiabVal

BigDecimal pendingCloseOrdLiabVal

逐仓杠杆负债对应平仓挂单的数量

pnl

BigDecimal pnl

平仓订单累计收益额

pos

BigDecimal pos

持仓数量，逐仓自主划转模式下，转入保证金后会产生pos为0的仓位

posCcy

String posCcy

持仓数量币种，仅适用于币币杠杆

posId

String posId

持仓ID

posSide

PositionsSide posSide

持仓方向

pTime

Long pTime

持仓信息的推送时间，Unix时间戳的毫秒数格式，如 1597026383085

realizedPnl

BigDecimal realizedPnl

已实现收益

spotInUseAmt

BigDecimal spotInUseAmt

现货对冲占用数量 适用于组合保证金模式

spotInUseCcy

String spotInUseCcy

现货对冲占用币种，如 BTC 适用于组合保证金模式

thetaBS

BigDecimal thetaBS

美金本位持仓仓位theta，仅适用于期权

thetaPA

BigDecimal thetaPA

币本位持仓仓位theta，仅适用于期权

tradeId

String tradeId

最新成交ID

upl

BigDecimal upl

未实现收益（以标记价格计算）

uplLastPx

BigDecimal uplLastPx

以最新成交价格计算的未实现收益，主要做展示使用，实际值还是 upl

uplRatio

BigDecimal uplRatio

未实现收益率（以标记价格计算

uplRatioLastPx

BigDecimal uplRatioLastPx

以最新成交价格计算的未实现收益率

usdPx

BigDecimal usdPx

美金价格

uTime

Long uTime

最近一次持仓更新时间，Unix时间戳的毫秒数格式，如 1597026383085

vegaBS

BigDecimal vegaBS

美金本位持仓仓位vega，仅适用于期权

vegaPA

BigDecimal vegaPA

币本位持仓仓位vega，仅适用于期权

Class xyz.felh.okx.v5.entity.ws.pri.Positions.CloseOrderAlgo

class CloseOrderAlgo extends Object implements Serializable

Serialized Fields

algoId

String algoId

策略委托单ID

closeFraction

BigDecimal closeFraction

策略委托触发时，平仓的百分比。1 代表100%

slTriggerPx

BigDecimal slTriggerPx

止损触发价

slTriggerPxType

TriggerPxType slTriggerPxType

止损触发价类型

tpTriggerPx

BigDecimal tpTriggerPx

止盈委托价

tpTriggerPxType

TriggerPxType tpTriggerPxType

止盈触发价类型

Package xyz.felh.okx.v5.entity.ws.pub

Class xyz.felh.okx.v5.entity.ws.pub.AdlWarning

class AdlWarning extends Object implements Serializable

Serialized Fields

adlBal

BigDecimal adlBal

触发自动减仓的风险准备金余额

adlRate

BigDecimal adlRate

触发自动减仓的风险准备金下降率

adlRecBal

BigDecimal adlRecBal

自动减仓结束的风险准备金余额

adlRecRate

BigDecimal adlRecRate

自动减仓结束的风险准备金下降率

adlType

AdlWarning.Type adlType

关于自动减仓的事件 rate_adl_start：由于风险准备金下降率过高造成的自动减仓开始 bal_adl_start：由于风险准备金余额下降过高造成的自动减仓开始 adl_end：自动减仓结束 两个开启条件同时触发时，仅推送bal_adl_start

bal

BigDecimal bal

实时风险准备金余额

ccy

String ccy

风险准备金余额对应币种

decRate

BigDecimal decRate

风险准备金实时下降率（bal与maxBal相比较） 仅在状态为warning及adl时推送，状态为normal时推送空字符串""

instFamily

String instFamily

交易品种

instType

InstrumentType instType

产品类型

maxBal

BigDecimal maxBal

过去八小时内的风险准备金余额最大值 仅在状态为warning及adl时推送，状态为normal时推送空字符串""

maxBalTs

Long maxBalTs

过去八小时内风险准备金余额最大值对应的时间戳，Unix时间戳的毫秒数格式，如 1597026383085

state

AdlWarningState state

状态 normal：普通状态 warning：预警状态 adl：已开启自动减仓

ts

Long ts

数据更新时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pub.EstimatedPrice

class EstimatedPrice extends Object implements Serializable

Serialized Fields

instId

String instId

产品ID，如 BTC-USD-170310

instType

InstrumentType instType

产品类型

settlePx

BigDecimal settlePx

预估交割/行权价

ts

Long ts

数据更新时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pub.FundingRate

class FundingRate extends Object implements Serializable

Serialized Fields

fundingRate

BigDecimal fundingRate

资金费率

fundingTime

Long fundingTime

最新的到期结算的资金费时间，Unix时间戳的毫秒数格式，如 1597026383085

instId

String instId

产品ID，如 LTC-USD-SWAP

instType

InstrumentType instType

产品类型，SWAP

maxFundingRate

BigDecimal maxFundingRate

下一期的预测资金费率上限

method

FundingRateMethod method

资金费收取逻辑

minFundingRate

BigDecimal minFundingRate

下一期的预测资金费率下限

nextFundingRate

BigDecimal nextFundingRate

下一期预测资金费率

nextFundingTime

Long nextFundingTime

下一期资金费时间，Unix时间戳的毫秒数格式，如 1622851200000

premium

BigDecimal premium

溢价，为合约的中间价和指数价格的差异

settFundingRate

BigDecimal settFundingRate

若 settState = processing，该字段代表用于本轮结算的资金费率；若 settState = settled，该字段代表用于上轮结算的资金费率

settState

FundingRateSettleState settState

资金费率结算状态 processing：结算中 settled：已结算

ts

Long ts

数据更新时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pub.IndexTickers

class IndexTickers extends Object implements Serializable

Serialized Fields

high24h

BigDecimal high24h

24小时指数最高价格

idxPx

BigDecimal idxPx

最新指数价格

instId

String instId

指数，以USD、USDT、BTC 为计价货币的指数，如 BTC-USDT

low24h

BigDecimal low24h

24小时指数最低价格

open24h

BigDecimal open24h

24小时开盘价

sodUtc0

BigDecimal sodUtc0

UTC 0 时开盘价

sodUtc8

BigDecimal sodUtc8

UTC+8 时开盘价

ts

Long ts

指数价格更新时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pub.Instruments

class Instruments extends Object implements Serializable

Serialized Fields

instId

String instId

产品ID，如 LTC-USD-SWAP

instType

InstrumentType instType

产品类型

Class xyz.felh.okx.v5.entity.ws.pub.LiquidationOrders

class LiquidationOrders extends Object implements Serializable

Serialized Fields

details

List<LiquidationOrders.Detail> details

详细内容

instId

String instId

产品ID，如 LTC-USD-SWAP

instType

InstrumentType instType

产品类型

uly

String uly

标的指数，仅适用于交割/永续/期权

Class xyz.felh.okx.v5.entity.ws.pub.MarkPrice

class MarkPrice extends Object implements Serializable

Serialized Fields

instId

String instId

产品ID

instType

InstrumentType instType

产品类型

markPx

BigDecimal markPx

标记价格

ts

Long ts

标记价格数据更新时间 ，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pub.OpenInterest

class OpenInterest extends Object implements Serializable

Serialized Fields

instId

String instId

产品ID，如 LTC-USD-SWAP

instType

InstrumentType instType

产品类型

openInterest

BigDecimal openInterest

持仓量，按张为单位，open interest

openInterestCcy

BigDecimal openInterestCcy

持仓量，按币为单位

timestamp

Long timestamp

数据更新的时间，Unix时间戳的毫秒数格式，如 1597026383085

Class xyz.felh.okx.v5.entity.ws.pub.OptionSummary

class OptionSummary extends Object implements Serializable

Serialized Fields

askVol

BigDecimal askVol

ask波动率

bidVol

BigDecimal bidVol

bid波动率

delta

BigDecimal delta

期权价格对uly价格的敏感度

deltaBS

BigDecimal deltaBS

BS模式下期权价格对uly价格的敏感度

fwdPx

BigDecimal fwdPx

远期价格

gamma

BigDecimal gamma

delta对uly价格的敏感度

gammaBS

BigDecimal gammaBS

BS模式下delta对uly价格的敏感度

instId

String instId

产品ID

instType

InstrumentType instType

产品类型， OPTION

lever

BigDecimal lever

杠杆倍数

markVol

BigDecimal markVol

标记波动率

realVol

BigDecimal realVol

theta

BigDecimal theta

期权价格对剩余期限的敏感度

thetaBS

BigDecimal thetaBS

BS模式下期权价格对剩余期限的敏感度

ts

Long ts

数据更新时间，Unix时间戳的毫秒数格式，如 1597026383085

uly

String uly

标的指数

vega

BigDecimal vega

期权价格对隐含波动率的敏感度

vegaBS

BigDecimal vegaBS

BS模式下期权价格对隐含波动率的敏感度

volLv

BigDecimal volLv

Class xyz.felh.okx.v5.entity.ws.pub.PriceLimit

class PriceLimit extends Object implements Serializable

Serialized Fields

buyLmt

BigDecimal buyLmt

最高买价 当enabled为false时，返回""

enabled

Boolean enabled

限价是否生效 true：限价生效 false：限价不生效

instId

String instId

产品ID，如 LTC-USD-SWAP

instType

InstrumentType instType

产品类型

sellLmt

BigDecimal sellLmt

最低卖价 当enabled为false时，返回""

ts

Long ts

限价数据更新时间 ，Unix时间戳的毫秒数格式，如 1597026383085