Package xyz.felh.okx.v5.enumeration.ws

Enum Class Channel

java.lang.Object
java.lang.Enum<Channel>
xyz.felh.okx.v5.enumeration.ws.Channel
All Implemented Interfaces:
Serializable, Comparable<Channel>, Constable
public enum Channel extends Enum<Channel>

  • Enum Constant Details

    • INSTRUMENTS

      public static final Channel INSTRUMENTS
      当有产品状态变化时（如期货交割、期权行权、新合约/币对上线、人工暂停/恢复交易等），推送产品的增量数据。 (2022年12月28日起不再推送全量数据，点此查看详情)；

    • OPEN_INTEREST

      public static final Channel OPEN_INTEREST
      获取持仓总量，每3s有数据更新推送一次数据

    • FUNDING_RATE

      public static final Channel FUNDING_RATE
      资金费率频道 获取永续合约资金费率，30秒到90秒内推送一次数据

    • PRICE_LIMIT

      public static final Channel PRICE_LIMIT
      限价频道 获取交易产品的最高买价和最低卖价。限价有变化时，每秒推送一次数据，限价没变化时，不推送数据

    • OPT_SUMMARY

      public static final Channel OPT_SUMMARY
      期权定价频道 获取所有期权合约详细定价信息，一次性推送所有

    • ESTIMATED_PRICE

      public static final Channel ESTIMATED_PRICE
      预估交割/行权价格频道 获取永续合约，交割合约和期权预估交割/行权价。交割/行权预估价只有交割/行权前一小时开始推送预估交割/行权价，有价格变化就推送

    • MARK_PRICE

      public static final Channel MARK_PRICE
      标记价格频道 获取标记价格，标记价格有变化时，每200ms推送一次数据，标记价格没变化时，每10s推送一次数据

    • INDEX_TICKERS

      public static final Channel INDEX_TICKERS
      指数行情频道 获取指数的行情数据。每100ms有变化就推送一次数据，否则一分钟推一次。

    • LIQUIDATION_ORDERS

      public static final Channel LIQUIDATION_ORDERS
      平台公共爆仓单频道 获取爆仓单信息。产品ID维度最多一秒推一条爆仓单信息。

    • ADL_WARNINGS

      public static final Channel ADL_WARNINGS
      自动减仓预警频道 普通状态（normal）下，每分钟推送一次，展示风险准备金的余额等信息。 预警状态下或有自动减仓风险（warning/adl）时，每1秒推送一次数据，展示风险准备金的实时下降率等信息。 更多自动减仓细节，请见自动减仓机制介绍

    • ACCOUNT

      public static final Channel ACCOUNT
      获取账户信息，首次订阅按照订阅维度推送数据，此外，当下单、撤单、成交等事件触发时，推送数据以及按照订阅维度定时推送数据 系统将限制订阅 WebSocket 频道的最大并发连接数。 1、如果同时成交多个订单，那么将对账户频道的推送尽量进行聚合。 2、首次推送，只推用户币种层面资产不为0的账户信息。币种层面资产不为0的定义：eq、availEq、availBal 中任意一个字段不为0，即币种层面资产不为0。如果数据太大无法在单个推送消息中发送，它将被分成多个消息发送。 3、定时推送，只推用户币种层面资产不为0的账户信息。币种层面资产不为0的定义：eq、availEq、availBal 中任意一个字段不为0，即币种层面资产不为0。 例：按照所有币种订阅且有5个币种的余额或者权益都不为0，首次和定时推全部5个；账户下有一个币种余额或者权益改变，那么账户变更的触发只推这一个。

      币种余额小于 1e-8 的币种信息，会在 details 中过滤掉不返回。

    • POSITIONS

      public static final Channel POSITIONS
      获取持仓信息，首次订阅按照订阅维度推送数据，此外，当下单、撤单等事件触发时，推送数据以及按照订阅维度定时推送数据 系统将限制订阅 WebSocket 频道的最大并发连接数。

    • BALANCE_AND_POSITION

      public static final Channel BALANCE_AND_POSITION
      获取账户余额和持仓信息，首次订阅按照订阅维度推送数据，此外，当成交、资金划转等事件触发时，推送数据。

      该频道适用于尽快获取账户现金余额和仓位资产变化的信息。 系统将限制订阅 WebSocket 频道的最大并发连接数。详情在限制 WebSocket 私有频道对应连接数量

    • LIQUIDATION_WARNING

      public static final Channel LIQUIDATION_WARNING
      此推送频道仅作为风险提示，不建议作为策略交易的风险判断。 在行情剧烈波动的情况下，可能会出现此消息推送的同时仓位已经被强平的可能性。 预警会在某一个逐仓仓位有风险时推送。预警会在所有全仓仓位有风险时推送。 系统将限制订阅 WebSocket 频道的最大并发连接数。详情在限制 WebSocket 私有频道对应连接数量

    • ACCOUNT_GREEKS

      public static final Channel ACCOUNT_GREEKS
      获取账户资产的greeks信息，首次订阅按照订阅维度推送数据，此外，当增加或者减少币种余额、持仓数量等事件触发时，推送数据以及按照订阅维度定时推送数据 系统将限制订阅 WebSocket 频道的最大并发连接数。详情在限制 WebSocket 私有频道对应连接数量

    • ORDERS

      public static final Channel ORDERS
      获取订单信息，首次订阅不推送，只有当下单、撤单等事件触发时，推送数据 系统将限制订阅 WebSocket 频道的最大并发连接数。详情在限制 WebSocket 私有频道对应连接数量

    • DEPOSIT_INFO

      public static final Channel DEPOSIT_INFO
      当发起充值或者充值状态发生变化时会触发消息推送。 支持母账户或者子账户的订阅

      如果是母账户订阅，可以同时接受母账户与子账户的充值信息的推送 如果是子账户订阅，则仅支持子账户充值信息的推送

    • WITHDRAWAL_INFO

      public static final Channel WITHDRAWAL_INFO
      当发起提币或者提币状态发生变化时会触发消息推送。 支持母账户或者子账户的订阅

      如果是母账户订阅，可以同时接受母账户与子账户的提币信息的推送 如果是子账户订阅，则仅支持子账户提币信息的推送

    • MARK_PRICE_CANDLE_3MON

      public static final Channel MARK_PRICE_CANDLE_3MON
      标记价格K线频道 获取标记价格的K线数据，推送频率最快是间隔1秒推送一次数据。

    • MARK_PRICE_CANDLE_1MON

      public static final Channel MARK_PRICE_CANDLE_1MON

    • MARK_PRICE_CANDLE_1W

      public static final Channel MARK_PRICE_CANDLE_1W

    • MARK_PRICE_CANDLE_1D

      public static final Channel MARK_PRICE_CANDLE_1D

    • MARK_PRICE_CANDLE_2D

      public static final Channel MARK_PRICE_CANDLE_2D

    • MARK_PRICE_CANDLE_3D

      public static final Channel MARK_PRICE_CANDLE_3D

    • MARK_PRICE_CANDLE_5D

      public static final Channel MARK_PRICE_CANDLE_5D

    • MARK_PRICE_CANDLE_12H

      public static final Channel MARK_PRICE_CANDLE_12H

    • MARK_PRICE_CANDLE_6H

      public static final Channel MARK_PRICE_CANDLE_6H

    • MARK_PRICE_CANDLE_4H

      public static final Channel MARK_PRICE_CANDLE_4H

    • MARK_PRICE_CANDLE_2H

      public static final Channel MARK_PRICE_CANDLE_2H

    • MARK_PRICE_CANDLE_1H

      public static final Channel MARK_PRICE_CANDLE_1H

    • MARK_PRICE_CANDLE_30M

      public static final Channel MARK_PRICE_CANDLE_30M

    • MARK_PRICE_CANDLE_15M

      public static final Channel MARK_PRICE_CANDLE_15M

    • MARK_PRICE_CANDLE_5M

      public static final Channel MARK_PRICE_CANDLE_5M

    • MARK_PRICE_CANDLE_3M

      public static final Channel MARK_PRICE_CANDLE_3M

    • MARK_PRICE_CANDLE_1M

      public static final Channel MARK_PRICE_CANDLE_1M

    • MARK_PRICE_CANDLE_3M_UTC

      public static final Channel MARK_PRICE_CANDLE_3M_UTC

    • MARK_PRICE_CANDLE_1M_UTC

      public static final Channel MARK_PRICE_CANDLE_1M_UTC

    • MARK_PRICE_CANDLE_1W_UTC

      public static final Channel MARK_PRICE_CANDLE_1W_UTC

    • MARK_PRICE_CANDLE_1D_UTC

      public static final Channel MARK_PRICE_CANDLE_1D_UTC

    • MARK_PRICE_CANDLE_2D_UTC

      public static final Channel MARK_PRICE_CANDLE_2D_UTC

    • MARK_PRICE_CANDLE_3D_UTC

      public static final Channel MARK_PRICE_CANDLE_3D_UTC

    • MARK_PRICE_CANDLE_5D_UTC

      public static final Channel MARK_PRICE_CANDLE_5D_UTC

    • MARK_PRICE_CANDLE_2H_UTC

      public static final Channel MARK_PRICE_CANDLE_2H_UTC

    • MARK_PRICE_CANDLE_6H_UTC

      public static final Channel MARK_PRICE_CANDLE_6H_UTC

    • INDEX_CANDLE_3MON

      public static final Channel INDEX_CANDLE_3MON
      指数K线频道 获取指数的K线数据，推送频率最快是间隔1秒推送一次数据。

    • INDEX_CANDLE_1MON

      public static final Channel INDEX_CANDLE_1MON

    • INDEX_CANDLE_1W

      public static final Channel INDEX_CANDLE_1W

    • INDEX_CANDLE_1D

      public static final Channel INDEX_CANDLE_1D

    • INDEX_CANDLE_2D

      public static final Channel INDEX_CANDLE_2D

    • INDEX_CANDLE_3D

      public static final Channel INDEX_CANDLE_3D

    • INDEX_CANDLE_5D

      public static final Channel INDEX_CANDLE_5D

    • INDEX_CANDLE_12H

      public static final Channel INDEX_CANDLE_12H

    • INDEX_CANDLE_6H

      public static final Channel INDEX_CANDLE_6H

    • INDEX_CANDLE_4H

      public static final Channel INDEX_CANDLE_4H

    • INDEX_CANDLE_2H

      public static final Channel INDEX_CANDLE_2H

    • INDEX_CANDLE_1H

      public static final Channel INDEX_CANDLE_1H

    • INDEX_CANDLE_30M

      public static final Channel INDEX_CANDLE_30M

    • INDEX_CANDLE_15M

      public static final Channel INDEX_CANDLE_15M

    • INDEX_CANDLE_5M

      public static final Channel INDEX_CANDLE_5M

    • INDEX_CANDLE_3M

      public static final Channel INDEX_CANDLE_3M

    • INDEX_CANDLE_1M

      public static final Channel INDEX_CANDLE_1M

    • INDEX_CANDLE_3M_UTC

      public static final Channel INDEX_CANDLE_3M_UTC

    • INDEX_CANDLE_1M_UTC

      public static final Channel INDEX_CANDLE_1M_UTC

    • INDEX_CANDLE_1W_UTC

      public static final Channel INDEX_CANDLE_1W_UTC

    • INDEX_CANDLE_1D_UTC

      public static final Channel INDEX_CANDLE_1D_UTC

    • INDEX_CANDLE_2D_UTC

      public static final Channel INDEX_CANDLE_2D_UTC

    • INDEX_CANDLE_3D_UTC

      public static final Channel INDEX_CANDLE_3D_UTC

    • INDEX_CANDLE_5D_UTC

      public static final Channel INDEX_CANDLE_5D_UTC

    • INDEX_CANDLE_2H_UTC

      public static final Channel INDEX_CANDLE_2H_UTC

    • INDEX_CANDLE_6H_UTC

      public static final Channel INDEX_CANDLE_6H_UTC

    • ECONOMIC_CALENDAR

      public static final Channel ECONOMIC_CALENDAR
      经济日历频道 获取最新经济日历数据。 该频道仅开放给交易费等级VIP1及以上的用户。

  • Method Details

    • values

      public static Channel[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Channel valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • value

      public String value()

    • fromValue

      public static Channel fromValue(String value)