Class: Bybit::RestApi::PreUpgradeService

Inherits:

BaseService

• Object
• BaseService
• Bybit::RestApi::PreUpgradeService

Defined in:

lib/bybit/rest_api/pre_upgrade_service.rb

Overview

/v5/pre-upgrade/* — historical queries scoped to activity that occurred BEFORE a Classic → UTA account upgrade. These records live in the legacy partition and never merge into the UTA tables, so callers upgrading from older SDKs need a dedicated namespace to fetch them.

Instance Method Summary

• #get_closed_pnl(category:, **kwargs) ⇒ Hash

  Get Pre-upgrade Closed PnL.

• #get_option_delivery_record(category:, **kwargs) ⇒ Hash

  Get Pre-upgrade Option Delivery Record.

• #get_order_history(category:, **kwargs) ⇒ Hash

  Get Pre-upgrade Order History.

• #get_trade_history(category:, **kwargs) ⇒ Hash

  Get Pre-upgrade Trade (Execution) History.

• #get_transaction_log(category:, **kwargs) ⇒ Hash

  Get Pre-upgrade Transaction Log (USDC Derivatives wallet).

• #get_usdc_session_settlement(category:, **kwargs) ⇒ Hash

  Get Pre-upgrade USDC Session Settlement Record.

Methods inherited from BaseService

#initialize

Constructor Details

This class inherits a constructor from Bybit::RestApi::BaseService

Instance Method Details

#get_closed_pnl(category:, **kwargs) ⇒ Hash

Get Pre-upgrade Closed PnL

GET /v5/pre-upgrade/position/closed-pnl

Bybit V5 only requires symbol when category is inverse; for linear it's optional. Keep it as an optional kwarg here — callers querying inverse pass it, callers on linear can omit it.

Parameters:

• category (String) —

  Product type: linear, inverse

• kwargs (Hash) —

  a customizable set of options

Options Hash (**kwargs):

• :symbol (String) —

  Symbol name (required for inverse)

• :start_time (Integer) —

  Start ms timestamp

• :end_time (Integer) —

  End ms timestamp

• :limit (Integer) —

  Records per page

• :cursor (String) —

  Pagination cursor

Returns:

• (Hash) —

  Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).

See Also:

• https://bybit-exchange.github.io/docs/v5/pre-upgrade/close-pnl

# File 'lib/bybit/rest_api/pre_upgrade_service.rb', line 71

def get_closed_pnl(category:, **kwargs)
  params = kwargs.merge(category: category)
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :get, path: '/v5/pre-upgrade/position/closed-pnl', params: params)
end

#get_option_delivery_record(category:, **kwargs) ⇒ Hash

Get Pre-upgrade Option Delivery Record

GET /v5/pre-upgrade/asset/delivery-record

Parameters:

• category (String) —

  Product type: option

• kwargs (Hash) —

  a customizable set of options

Options Hash (**kwargs):

• :symbol (String) —

  Symbol filter

• :expiry_date (Integer) —

  Delivery expiry date (YYYYMMDD)

• :limit (Integer) —

  Records per page

• :cursor (String) —

  Pagination cursor

Returns:

• (Hash) —

  Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).

See Also:

• https://bybit-exchange.github.io/docs/v5/pre-upgrade/delivery

# File 'lib/bybit/rest_api/pre_upgrade_service.rb', line 107

def get_option_delivery_record(category:, **kwargs)
  params = kwargs.merge(category: category)
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :get, path: '/v5/pre-upgrade/asset/delivery-record', params: params)
end

#get_order_history(category:, **kwargs) ⇒ Hash

Get Pre-upgrade Order History

GET /v5/pre-upgrade/order/history

Parameters:

• category (String) —

  Product type: linear, inverse, option

• kwargs (Hash) —

  a customizable set of options

Options Hash (**kwargs):

• :symbol (String) —

  Symbol filter

• :base_coin (String) —

  Base coin filter

• :order_id (String) —

  Order ID filter

• :order_link_id (String) —

  User-side order link ID

• :order_filter (String) —

  Order-type filter

• :order_status (String) —

  Order status filter

• :start_time (Integer) —

  Start ms timestamp

• :end_time (Integer) —

  End ms timestamp

• :limit (Integer) —

  Records per page

• :cursor (String) —

  Pagination cursor

Returns:

• (Hash) —

  Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).

See Also:

• https://bybit-exchange.github.io/docs/v5/pre-upgrade/order-list

# File 'lib/bybit/rest_api/pre_upgrade_service.rb', line 27

def get_order_history(category:, **kwargs)
  params = kwargs.merge(category: category)
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :get, path: '/v5/pre-upgrade/order/history', params: params)
end

#get_trade_history(category:, **kwargs) ⇒ Hash

Get Pre-upgrade Trade (Execution) History

GET /v5/pre-upgrade/execution/list

Parameters:

• category (String) —

  Product type: linear, inverse, option

• kwargs (Hash) —

  a customizable set of options

Options Hash (**kwargs):

• :symbol (String) —

  Symbol filter

• :order_id (String) —

  Order ID filter

• :order_link_id (String) —

  User-side order link ID

• :base_coin (String) —

  Base coin filter

• :start_time (Integer) —

  Start ms timestamp

• :end_time (Integer) —

  End ms timestamp

• :exec_type (String) —

  Execution type filter

• :limit (Integer) —

  Records per page

• :cursor (String) —

  Pagination cursor

Returns:

• (Hash) —

  Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).

See Also:

• https://bybit-exchange.github.io/docs/v5/pre-upgrade/execution

# File 'lib/bybit/rest_api/pre_upgrade_service.rb', line 49

def get_trade_history(category:, **kwargs)
  params = kwargs.merge(category: category)
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :get, path: '/v5/pre-upgrade/execution/list', params: params)
end

#get_transaction_log(category:, **kwargs) ⇒ Hash

Get Pre-upgrade Transaction Log (USDC Derivatives wallet)

GET /v5/pre-upgrade/account/transaction-log

Parameters:

• category (String) —

  Product type: linear, option

• kwargs (Hash) —

  a customizable set of options

Options Hash (**kwargs):

• :base_coin (String) —

  Base coin filter

• :type (String) —

  Transaction type filter

• :start_time (Integer) —

  Start ms timestamp

• :end_time (Integer) —

  End ms timestamp

• :limit (Integer) —

  Records per page

• :cursor (String) —

  Pagination cursor

Returns:

• (Hash) —

  Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).

See Also:

• https://bybit-exchange.github.io/docs/v5/pre-upgrade/transaction-log

# File 'lib/bybit/rest_api/pre_upgrade_service.rb', line 90

def get_transaction_log(category:, **kwargs)
  params = kwargs.merge(category: category)
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :get, path: '/v5/pre-upgrade/account/transaction-log', params: params)
end

#get_usdc_session_settlement(category:, **kwargs) ⇒ Hash

Get Pre-upgrade USDC Session Settlement Record

GET /v5/pre-upgrade/asset/settlement-record

Parameters:

• category (String) —

  Product type: linear

• kwargs (Hash) —

  a customizable set of options

Options Hash (**kwargs):

• :symbol (String) —

  Symbol filter

• :limit (Integer) —

  Records per page

• :cursor (String) —

  Pagination cursor

Returns:

• (Hash) —

  Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).

See Also:

• https://bybit-exchange.github.io/docs/v5/pre-upgrade/settlement

# File 'lib/bybit/rest_api/pre_upgrade_service.rb', line 123

def get_usdc_session_settlement(category:, **kwargs)
  params = kwargs.merge(category: category)
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :get, path: '/v5/pre-upgrade/asset/settlement-record', params: params)
end