bybit-connector-ruby 0.1.0

data/lib/bybit/rest_api/position_service.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module Bybit
+  module RestApi
+    class PositionService < BaseService
+      # Manually add or reduce margin for an isolated margin position
+      #
+      # POST /v5/position/add-margin
+      #
+      # @param category [String] Product type
+      # @param symbol [String] Symbol name
+      # @param margin [String] Add or reduce. To add, then 10; to reduce, then -10
+      # @option kwargs [Integer] :position_idx Used to identify positions in different position modes
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position/manual-add-margin
+      def add_reduce_margin(category:, symbol:, margin:, **kwargs)
+        params = kwargs.merge(category: category, symbol: symbol, margin: margin)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/position/add-margin', body: params)
+      end
+
+      # Confirm new risk limit to remove reduce-only restriction
+      #
+      # POST /v5/position/confirm-pending-mmr
+      #
+      # @param category [String] Product type
+      # @param symbol [String] Symbol name
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position/confirm-mmr
+      def confirm_new_risk_limit(category:, symbol:, **kwargs)
+        params = kwargs.merge(category: category, symbol: symbol)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/position/confirm-pending-mmr', body: params)
+      end
+
+      # Get closed option position records
+      #
+      # GET /v5/position/get-closed-positions
+      #
+      # @param category [String] Product type
+      # @option kwargs [String] :symbol Symbol name
+      # @option kwargs [Integer] :start_time Start timestamp in ms
+      # @option kwargs [Integer] :end_time End timestamp in ms
+      # @option kwargs [Integer] :limit Limit for data size per page
+      # @option kwargs [String] :cursor Cursor for pagination
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position/close-position
+      def get_closed_positions(category:, **kwargs)
+        params = kwargs.merge(category: category)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/position/get-closed-positions', params: params)
+      end
+
+      # Get closed profit and loss records
+      #
+      # GET /v5/position/closed-pnl
+      #
+      # @param category [String] Product type
+      # @option kwargs [String] :symbol Symbol name
+      # @option kwargs [Integer] :start_time Start timestamp in ms
+      # @option kwargs [Integer] :end_time End timestamp in ms
+      # @option kwargs [Integer] :limit Limit for data size per page
+      # @option kwargs [String] :cursor Cursor for pagination
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position/close-pnl
+      def get_closed_pnl(category:, **kwargs)
+        params = kwargs.merge(category: category)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/position/closed-pnl', params: params)
+      end
+
+      # Get move position (block trade) history
+      #
+      # GET /v5/position/move-history
+      #
+      # @option kwargs [String] :category Product type
+      # @option kwargs [String] :symbol Symbol name
+      # @option kwargs [Integer] :start_time Start timestamp in ms
+      # @option kwargs [Integer] :end_time End timestamp in ms
+      # @option kwargs [String] :status Move position status
+      # @option kwargs [String] :block_trade_id Block trade ID
+      # @option kwargs [String] :limit Limit for data size per page
+      # @option kwargs [String] :cursor Cursor for pagination
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position/move-position-history
+      def get_move_position_history(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/position/move-history', params: params)
+      end
+
+      # Get position info (real-time)
+      #
+      # GET /v5/position/list
+      #
+      # @param category [String] Product type
+      # @option kwargs [String] :symbol Symbol name
+      # @option kwargs [String] :base_coin Base coin
+      # @option kwargs [String] :settle_coin Settle coin
+      # @option kwargs [Integer] :limit Limit for data size per page
+      # @option kwargs [String] :cursor Cursor for pagination
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position
+      def get_positions(category:, **kwargs)
+        params = kwargs.merge(category: category)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/position/list', params: params)
+      end
+
+      # Move positions between UIDs via block trade
+      #
+      # POST /v5/position/move-positions
+      #
+      # @param from_uid [String] Original UID (from which the position is moved)
+      # @param to_uid [String] Target UID (to which the position is moved)
+      # @param list [Array] Positions to move (array of objects)
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position/move-position
+      def move_position(from_uid:, to_uid:, list:, **kwargs)
+        params = kwargs.merge(from_uid: from_uid, to_uid: to_uid, list: list)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/position/move-positions', body: params)
+      end
+
+      # Enable or disable auto-add-margin for a position
+      #
+      # POST /v5/position/set-auto-add-margin
+      #
+      # @param category [String] Product type
+      # @param symbol [String] Symbol name
+      # @param auto_add_margin [Integer] 0: disable, 1: enable
+      # @option kwargs [Integer] :position_idx Used to identify positions in different position modes
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position/auto-add-margin
+      def set_auto_add_margin(category:, symbol:, auto_add_margin:, **kwargs)
+        params = kwargs.merge(category: category, symbol: symbol, auto_add_margin: auto_add_margin)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/position/set-auto-add-margin', body: params)
+      end
+
+      # Set leverage for a position
+      #
+      # POST /v5/position/set-leverage
+      #
+      # @param category [String] Product type
+      # @param symbol [String] Symbol name
+      # @param buy_leverage [String] Buy leverage
+      # @param sell_leverage [String] Sell leverage
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position/leverage
+      def set_leverage(category:, symbol:, buy_leverage:, sell_leverage:, **kwargs)
+        params = kwargs.merge(category: category, symbol: symbol, buy_leverage: buy_leverage, sell_leverage: sell_leverage)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/position/set-leverage', body: params)
+      end
+
+      # Set take profit, stop loss, and trailing stop for a position
+      #
+      # POST /v5/position/trading-stop
+      #
+      # @param category [String] Product type
+      # @param symbol [String] Symbol name
+      # @param tpsl_mode [String] TP/SL mode: Full or Partial
+      # @param position_idx [Integer] Used to identify positions in different position modes
+      # @option kwargs [String] :take_profit Take profit price
+      # @option kwargs [String] :stop_loss Stop loss price
+      # @option kwargs [String] :trailing_stop Trailing stop
+      # @option kwargs [String] :tp_trigger_by Take profit trigger price type
+      # @option kwargs [String] :sl_trigger_by Stop loss trigger price type
+      # @option kwargs [String] :active_price Trailing stop trigger price
+      # @option kwargs [String] :tp_size Take profit size (Partial mode)
+      # @option kwargs [String] :sl_size Stop loss size (Partial mode)
+      # @option kwargs [String] :tp_limit_price The limit order price when take profit price is triggered
+      # @option kwargs [String] :sl_limit_price The limit order price when stop loss price is triggered
+      # @option kwargs [String] :tp_order_type Take profit order type: Market or Limit
+      # @option kwargs [String] :sl_order_type Stop loss order type: Market or Limit
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position/trading-stop
+      def set_trading_stop(category:, symbol:, tpsl_mode:, position_idx:, **kwargs)
+        params = kwargs.merge(category: category, symbol: symbol, tpsl_mode: tpsl_mode, position_idx: position_idx)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/position/trading-stop', body: params)
+      end
+
+      # Switch position mode between one-way and hedge mode
+      #
+      # POST /v5/position/switch-mode
+      #
+      # @param category [String] Product type
+      # @param mode [Integer] Position mode: 0 (Merged Single), 3 (Both Sides)
+      # @option kwargs [String] :symbol Symbol name
+      # @option kwargs [String] :coin Coin
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/position/position-mode
+      def switch_position_mode(category:, mode:, **kwargs)
+        params = kwargs.merge(category: category, mode: mode)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/position/switch-mode', body: params)
+      end
+    end
+  end
+end

data/lib/bybit/rest_api/rfq_service.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module Bybit
+  module RestApi
+    class RfqService < BaseService
+      # Accept a non-LP quote for an RFQ.
+      #
+      # POST /v5/rfq/accept-other-quote
+      #
+      # @param rfq_id [String] RFQ ID
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def accept_non_lp_quote(rfq_id:, **kwargs)
+        params = kwargs.merge(rfq_id: rfq_id)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/rfq/accept-other-quote', body: params)
+      end
+
+      # Cancel all active quotes.
+      #
+      # POST /v5/rfq/cancel-all-quotes
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def cancel_all_quotes(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/rfq/cancel-all-quotes', body: params)
+      end
+
+      # Cancel all active RFQs.
+      #
+      # POST /v5/rfq/cancel-all-rfq
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def cancel_all_rfqs(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/rfq/cancel-all-rfq', body: params)
+      end
+
+      # Cancel a specific quote by quote ID, RFQ ID, or quote link ID.
+      #
+      # POST /v5/rfq/cancel-quote
+      #
+      # @option kwargs [String] :quote_id Quote ID
+      # @option kwargs [String] :rfq_id RFQ ID
+      # @option kwargs [String] :quote_link_id User-defined quote link ID
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def cancel_quote(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/rfq/cancel-quote', body: params)
+      end
+
+      # Cancel a specific RFQ by RFQ ID or RFQ link ID.
+      #
+      # POST /v5/rfq/cancel-rfq
+      #
+      # @option kwargs [String] :rfq_id RFQ ID
+      # @option kwargs [String] :rfq_link_id User-defined RFQ link ID
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def cancel_rfq(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/rfq/cancel-rfq', body: params)
+      end
+
+      # Create a quote in response to an RFQ.
+      #
+      # POST /v5/rfq/create-quote
+      #
+      # @param rfq_id [String] RFQ ID
+      # @option kwargs [String] :quote_link_id User-defined quote link ID
+      # @option kwargs [Boolean] :anonymous Whether to submit the quote anonymously
+      # @option kwargs [Integer] :expire_in Expiration time in seconds
+      # @option kwargs [Array] :quote_buy_list Buy side quote entries
+      # @option kwargs [Array] :quote_sell_list Sell side quote entries
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def create_quote(rfq_id:, **kwargs)
+        params = kwargs.merge(rfq_id: rfq_id)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/rfq/create-quote', body: params)
+      end
+
+      # Create a new RFQ (Request for Quote).
+      #
+      # POST /v5/rfq/create-rfq
+      #
+      # @param counterparties [Array] List of counterparties to receive the RFQ
+      # @param list [Array] List of legs for the RFQ
+      # @option kwargs [String] :rfq_link_id User-defined RFQ link ID
+      # @option kwargs [Boolean] :anonymous Whether to submit the RFQ anonymously
+      # @option kwargs [String] :strategy_type Strategy type
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def create_rfq(counterparties:, list:, **kwargs)
+        params = kwargs.merge(counterparties: counterparties, list: list)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/rfq/create-rfq', body: params)
+      end
+
+      # Execute a quote to complete the trade.
+      #
+      # POST /v5/rfq/execute-quote
+      #
+      # @param rfq_id [String] RFQ ID
+      # @param quote_id [String] Quote ID
+      # @param quote_side [String] Quote side (Buy or Sell)
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def execute_quote(rfq_id:, quote_id:, quote_side:, **kwargs)
+        params = kwargs.merge(rfq_id: rfq_id, quote_id: quote_id, quote_side: quote_side)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/rfq/execute-quote', body: params)
+      end
+
+      # Query public RFQ trades.
+      #
+      # GET /v5/rfq/public-trades
+      #
+      # @option kwargs [Integer] :start_time Start timestamp in milliseconds
+      # @option kwargs [Integer] :end_time End timestamp in milliseconds
+      # @option kwargs [Integer] :limit Maximum number of records to return
+      # @option kwargs [String] :cursor Pagination cursor
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def get_public_trades(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/rfq/public-trades', params: params)
+      end
+
+      # Query historical quotes.
+      #
+      # GET /v5/rfq/quote-list
+      #
+      # @option kwargs [String] :rfq_id RFQ ID
+      # @option kwargs [String] :quote_id Quote ID
+      # @option kwargs [String] :quote_link_id User-defined quote link ID
+      # @option kwargs [String] :trader_type Trader type (Taker or Maker)
+      # @option kwargs [String] :status Quote status filter
+      # @option kwargs [Integer] :limit Maximum number of records to return
+      # @option kwargs [String] :cursor Pagination cursor
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def get_quotes(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/rfq/quote-list', params: params)
+      end
+
+      # Query realtime (active) quotes.
+      #
+      # GET /v5/rfq/quote-realtime
+      #
+      # @option kwargs [String] :rfq_id RFQ ID
+      # @option kwargs [String] :quote_id Quote ID
+      # @option kwargs [String] :quote_link_id User-defined quote link ID
+      # @option kwargs [String] :trader_type Trader type (Taker or Maker)
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def get_quotes_realtime(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/rfq/quote-realtime', params: params)
+      end
+
+      # Query RFQ configuration information.
+      #
+      # GET /v5/rfq/config
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def get_config(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/rfq/config', params: params)
+      end
+
+      # Query historical RFQs.
+      #
+      # GET /v5/rfq/rfq-list
+      #
+      # @option kwargs [String] :rfq_id RFQ ID
+      # @option kwargs [String] :rfq_link_id User-defined RFQ link ID
+      # @option kwargs [String] :trader_type Trader type (Taker or Maker)
+      # @option kwargs [String] :status RFQ status filter
+      # @option kwargs [Integer] :limit Maximum number of records to return
+      # @option kwargs [String] :cursor Pagination cursor
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def get_rfqs(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/rfq/rfq-list', params: params)
+      end
+
+      # Query realtime (active) RFQs.
+      #
+      # GET /v5/rfq/rfq-realtime
+      #
+      # @option kwargs [String] :rfq_id RFQ ID
+      # @option kwargs [String] :rfq_link_id User-defined RFQ link ID
+      # @option kwargs [String] :trader_type Trader type (Taker or Maker)
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def get_rfqs_realtime(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/rfq/rfq-realtime', params: params)
+      end
+
+      # Query RFQ trade history.
+      #
+      # GET /v5/rfq/trade-list
+      #
+      # @option kwargs [String] :rfq_id RFQ ID
+      # @option kwargs [String] :rfq_link_id User-defined RFQ link ID
+      # @option kwargs [String] :quote_id Quote ID
+      # @option kwargs [String] :quote_link_id User-defined quote link ID
+      # @option kwargs [String] :trader_type Trader type (Taker or Maker)
+      # @option kwargs [String] :status Trade status filter
+      # @option kwargs [Integer] :limit Maximum number of records to return
+      # @option kwargs [String] :cursor Pagination cursor
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def get_trade_history(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/rfq/trade-list', params: params)
+      end
+    end
+  end
+end

data/lib/bybit/rest_api/spot_margin_service.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Bybit
+  module RestApi
+    class SpotMarginService < BaseService
+      # Get historical interest rate for spot margin trading.
+      #
+      # GET /v5/spot-margin-trade/interest-rate-history
+      #
+      # @param currency [String] Currency
+      # @option kwargs [String] :vip_level VIP level
+      # @option kwargs [Integer] :start_time Start time in milliseconds
+      # @option kwargs [Integer] :end_time End time in milliseconds
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spot-margin-uta/historical-interest
+      def get_historical_interest_rate(currency:, **kwargs)
+        params = kwargs.merge(currency: currency)
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/spot-margin-trade/interest-rate-history', params: params)
+      end
+
+      # Get spot margin position tiers.
+      #
+      # GET /v5/spot-margin-trade/position-tiers
+      #
+      # @option kwargs [String] :currency Currency
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spot-margin-uta/position-tiers
+      def get_position_tiers(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :get, path: '/v5/spot-margin-trade/position-tiers', params: params)
+      end
+
+      # Get tiered collateral ratio for spot margin trading.
+      #
+      # GET /v5/spot-margin-trade/collateral
+      #
+      # @option kwargs [String] :currency Currency
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      def get_tiered_collateral_ratio(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.public_request(path: '/v5/spot-margin-trade/collateral', params: params)
+      end
+
+      # Get VIP margin data for spot margin trading.
+      #
+      # GET /v5/spot-margin-trade/data
+      #
+      # @option kwargs [String] :vip_level VIP level
+      # @option kwargs [String] :currency Currency
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spot-margin-uta/vip-margin
+      def get_vip_margin_data(**kwargs)
+        params = kwargs.dup
+        params = Bybit::Utils::WireKeys.camelize(params)
+        @session.public_request(path: '/v5/spot-margin-trade/data', params: params)
+      end
+    end
+  end
+end