bybit-connector-ruby 0.1.0 → 0.1.3

data/lib/bybit/rest_api/spread_trade_service.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module Bybit
+  module RestApi
+    class SpreadTradeService < BaseService
+      # Get Trade History
+      #
+      # GET /v5/spread/execution/list
+      #
+      # @option kwargs [String] :symbol Spread combination symbol name.
+      # @option kwargs [String] :order_id Spread combination order ID.
+      # @option kwargs [String] :order_link_id User-defined custom order ID.
+      # @option kwargs [Integer] :start_time Start timestamp in milliseconds. See time range logic in description.
+      # @option kwargs [Integer] :end_time End timestamp in milliseconds. See time range logic in description.
+      # @option kwargs [Integer] :limit Number of results per page. Range `[1, 50]`. Default `20`.
+      # @option kwargs [String] :cursor Pagination cursor token from `nextPageCursor` in a previous response.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/trade/trade-history
+      def get_history(**kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs)
+        @session.sign_request(method: :get, path: '/v5/spread/execution/list', params: params)
+      end
+
+      # Get Spread Instruments Info
+      #
+      # GET /v5/spread/instrument
+      #
+      # @option kwargs [String] :symbol Spread combination symbol name, e.g. `SOLUSDT_SOL/USDT`
+      # @option kwargs [String] :base_coin Base coin in uppercase, e.g. `SOL`
+      # @option kwargs [Integer] :limit Number of records per page, range `[1, 500]`. Default is `200`
+      # @option kwargs [String] :cursor Pagination cursor; use `nextPageCursor` from the previous response
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/market/instrument
+      def get_spread_instruments_info(**kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs)
+        @session.public_request(path: '/v5/spread/instrument', params: params)
+      end
+
+      # Get Spread Wallet Balance
+      #
+      # GET /v5/spread/max-qty
+      #
+      # @param symbol [String] Spread trading pair.
+      # @param side [String] Order side:
+      #   - `1`: Buy
+      #   - `2`: Sell
+      # @param order_price [String] Order price.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/trade/max-qty
+      def get_spread_max_qty(symbol:, side:, order_price:)
+        params = Bybit::Utils::WireKeys.camelize({ symbol: symbol, side: side, orderPrice: order_price })
+        @session.sign_request(method: :get, path: '/v5/spread/max-qty', params: params)
+      end
+
+      # Amend Order
+      #
+      # POST /v5/spread/order/amend
+      #
+      # @param symbol [String] Spread combination symbol name.
+      # @option kwargs [String] :order_id Spread combination order ID. Either `orderId` or `orderLinkId` is required.
+      # @option kwargs [String] :order_link_id User-defined custom order ID. Either `orderId` or `orderLinkId` is required.
+      # @option kwargs [String] :qty New order quantity after modification (string-formatted number).
+      #   At least one of `qty` or `price` must be provided.
+      # @option kwargs [String] :price New order price after modification (string-formatted number).
+      #   At least one of `qty` or `price` must be provided.
+      #   - `""` (empty string): keeps the existing price unchanged.
+      #   - `"0"`: updates the price to zero.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/trade/amend-order
+      def amend_spread_order(symbol:, **kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs.merge(symbol: symbol))
+        @session.sign_request(method: :post, path: '/v5/spread/order/amend', body: params)
+      end
+
+      # Cancel Order
+      #
+      # POST /v5/spread/order/cancel
+      #
+      # @option kwargs [String] :order_id Spread combination order ID. Either `orderId` or `orderLinkId` is required.
+      # @option kwargs [String] :order_link_id User-defined custom order ID. Either `orderId` or `orderLinkId` is required.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/trade/cancel-order
+      def cancel_spread_order(**kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs)
+        @session.sign_request(method: :post, path: '/v5/spread/order/cancel', body: params)
+      end
+
+      # Cancel All Orders
+      #
+      # POST /v5/spread/order/cancel-all
+      #
+      # @option kwargs [String] :symbol Spread combination symbol name. When specified, all orders for this symbol
+      #   are cancelled and `cancelAll` is ignored.
+      # @option kwargs [Boolean] :cancel_all Set to `true` to cancel all open orders across all symbols.
+      #   Ignored when `symbol` is provided.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/trade/cancel-all
+      def cancel_all_spread_orders(**kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs)
+        @session.sign_request(method: :post, path: '/v5/spread/order/cancel-all', body: params)
+      end
+
+      # Create Order
+      #
+      # POST /v5/spread/order/create
+      #
+      # @param symbol [String] Spread combination symbol name.
+      # @param side [String] Order direction.
+      # @param order_type [String] Order type.
+      # @param qty [String] Order quantity (string-formatted number).
+      # @option kwargs [String] :price Order price (string-formatted number). Required for Limit orders.
+      #   Not required for Market orders.
+      # @option kwargs [String] :order_link_id User-defined custom order identifier. Maximum 45 characters.
+      #   Supports alphanumeric characters, dashes, and underscores.
+      # @option kwargs [String] :time_in_force Time-in-force strategy for order execution.
+      #   - `GTC`: Good Till Cancel (default for Limit).
+      #   - `IOC`: Immediate or Cancel.
+      #   - `FOK`: Fill or Kill.
+      #   - `PostOnly`: Maker-only; rejected if it would take liquidity.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/trade/create-order
+      def create_spread_order(symbol:, side:, order_type:, qty:, **kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs.merge(symbol: symbol, side: side, orderType: order_type, qty: qty))
+        @session.sign_request(method: :post, path: '/v5/spread/order/create', body: params)
+      end
+
+      # Get Order History
+      #
+      # GET /v5/spread/order/history
+      #
+      # @option kwargs [String] :symbol Spread combination symbol name.
+      # @option kwargs [String] :base_coin Base coin to filter by.
+      # @option kwargs [String] :order_id Spread combination order ID. Has higher priority than time-based filters.
+      # @option kwargs [String] :order_link_id User-defined custom order ID. Has higher priority than time-based filters.
+      # @option kwargs [Integer] :start_time Start timestamp in milliseconds. See time range logic in description.
+      # @option kwargs [Integer] :end_time End timestamp in milliseconds. See time range logic in description.
+      # @option kwargs [Integer] :limit Number of results per page. Range `[1, 50]`. Default `20`.
+      # @option kwargs [String] :cursor Pagination cursor token from `nextPageCursor` in a previous response.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/trade/order-history
+      def get_spread_order_history(**kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs)
+        @session.sign_request(method: :get, path: '/v5/spread/order/history', params: params)
+      end
+
+      # Get Open Orders
+      #
+      # GET /v5/spread/order/realtime
+      #
+      # @option kwargs [String] :symbol Spread combination symbol name.
+      # @option kwargs [String] :base_coin Base coin to filter by.
+      # @option kwargs [String] :order_id Spread combination order ID.
+      # @option kwargs [String] :order_link_id User-defined custom order ID.
+      # @option kwargs [Integer] :limit Number of results per page. Range `[1, 50]`. Default `20`.
+      # @option kwargs [String] :cursor Pagination cursor token from `nextPageCursor` in a previous response.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/trade/open-order
+      def get_spread_open_orders(**kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs)
+        @session.sign_request(method: :get, path: '/v5/spread/order/realtime', params: params)
+      end
+
+      # Get Spread Orderbook
+      #
+      # GET /v5/spread/orderbook
+      #
+      # @param symbol [String] Spread combination symbol name, e.g. `SOLUSDT_SOL/USDT`
+      # @option kwargs [Integer] :limit Number of bid/ask levels per side, range `[1, 25]`. Default is `1`
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/market/orderbook
+      def get_spread_orderbook(symbol:, **kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs.merge(symbol: symbol))
+        @session.public_request(path: '/v5/spread/orderbook', params: params)
+      end
+
+      # Get Spread Recent Public Trades
+      #
+      # GET /v5/spread/recent-trade
+      #
+      # @param symbol [String] Spread combination symbol name, e.g. `SOLUSDT_SOL/USDT`
+      # @option kwargs [Integer] :limit Number of records per page, range `[1, 1000]`. Default is `500`
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/market/recent-trade
+      def get_spread_recent_trades(symbol:, **kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs.merge(symbol: symbol))
+        @session.public_request(path: '/v5/spread/recent-trade', params: params)
+      end
+
+      # Get Spread Tickers
+      #
+      # GET /v5/spread/tickers
+      #
+      # @param symbol [String] Spread combination symbol name, e.g. `SOLUSDT_SOL/USDT`
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/spread/market/tickers
+      def get_spread_tickers(symbol:)
+        params = Bybit::Utils::WireKeys.camelize({ symbol: symbol })
+        @session.public_request(path: '/v5/spread/tickers', params: params)
+      end
+    end
+  end
+end

data/lib/bybit/rest_api/strategy_service.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Bybit
+  module RestApi
+    class StrategyService < BaseService
+      # Create a strategy order
+      #
+      # POST /v5/strategy/create
+      #
+      # @param params [Hash] Request payload. strategy_type: chaseOrder | iceberg | pov | twap.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/strategy/create-strategy
+      def create_strategy(**params)
+        body = Bybit::Utils::WireKeys.camelize(params)
+        @session.sign_request(method: :post, path: '/v5/strategy/create', body: body)
+      end
+
+      # Query trading strategy list with filters
+      #
+      # GET /v5/strategy/list
+      #
+      # @option kwargs [String] :strategy_id Strategy ID for exact lookup (UUID format).
+      #   If provided, returns only this specific strategy.
+      #   Useful for checking status of a known strategy.
+      # @option kwargs [String] :status Filter by strategy status.
+      #   - "2": Running (currently executing)
+      #   - "3" or "4": Terminated (stopped)
+      #   - "5": Paused (temporarily halted)
+      #   - "6": Untriggered (waiting for trigger price)
+      #   Can provide multiple values separated by comma.
+      # @option kwargs [String] :symbol Filter by trading pair symbol.
+      #   Case-sensitive, must match exactly.
+      #   Example: "BTCUSDT", "ETHUSDT"
+      # @option kwargs [String] :category Filter by product category.
+      #   Useful to separate spot from derivatives strategies.
+      # @option kwargs [String] :strategy_type Filter by strategy type.
+      #   Useful to view only specific algorithm strategies.
+      # @option kwargs [Integer] :begin_time_e0 Start time filter (Unix timestamp in seconds).
+      #   Returns strategies created on or after this time.
+      #   Example: 1673214964 (Jan 9, 2023)
+      # @option kwargs [Integer] :end_time_e0 End time filter (Unix timestamp in seconds).
+      #   Returns strategies created before this time.
+      #   Must be greater than beginTimeE0 if both provided.
+      # @option kwargs [Integer] :page_size Number of results per page.
+      #   Default: 20
+      #   Maximum: 50
+      # @option kwargs [String] :cursor Pagination cursor from previous response.
+      #   Use nextCursor value from previous query to get next page.
+      #   Empty for first page.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/strategy/strategy-list
+      def query_list(**kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs)
+        @session.sign_request(method: :get, path: '/v5/strategy/list', params: params)
+      end
+
+      # Query orders created by a specific strategy
+      #
+      # GET /v5/strategy/order-list
+      #
+      # @param strategy_id [String] Strategy ID to query orders for (UUID format).
+      #   This is the parent strategy whose child orders you want to retrieve.
+      #   Obtain from strategy creation response or strategy list query.
+      # @option kwargs [String] :status Filter by order status.
+      #   - "1": Created (active, not filled yet)
+      #   - "2": PartiallyFilled (some quantity executed)
+      #   - "3": Filled (fully executed)
+      #   - "4": Cancelled (order canceled)
+      #   - "5": Rejected (order rejected by exchange)
+      #   Can filter by multiple statuses.
+      # @option kwargs [String] :symbol Filter by trading pair symbol.
+      #   Useful if strategy could trade multiple symbols.
+      # @option kwargs [Integer] :begin_time_e0 Start time filter (Unix timestamp in seconds).
+      #   Returns orders created on or after this time.
+      # @option kwargs [Integer] :end_time_e0 End time filter (Unix timestamp in seconds).
+      #   Returns orders created before this time.
+      # @option kwargs [Integer] :page_size Number of results per page.
+      #   Default: 20, Maximum: 50
+      # @option kwargs [String] :cursor Pagination cursor from previous response.
+      #   Use nextCursor from previous query for next page.
+      # @option kwargs [String] :strategy_type Filter by strategy type.
+      #   Should match the parent strategy type.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/strategy/order-list
+      def query_order_list(strategy_id:, **kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs.merge(strategyId: strategy_id))
+        @session.sign_request(method: :get, path: '/v5/strategy/order-list', params: params)
+      end
+
+      # Stop a running strategy
+      #
+      # POST /v5/strategy/stop
+      #
+      # @param strategy_id [String] Strategy ID to stop (UUID format).
+      #   Obtained from strategy creation response or strategy list query.
+      #   Only Running or Untriggered strategies can be stopped.
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/strategy/stop-strategy
+      def stop_strategy(strategy_id:)
+        params = Bybit::Utils::WireKeys.camelize({ strategyId: strategy_id })
+        @session.sign_request(method: :post, path: '/v5/strategy/stop', body: params)
+      end
+    end
+  end
+end

data/lib/bybit/rest_api/tax_service.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Bybit
+  module RestApi
+    class TaxService < BaseService
+      # Batch create tax report files
+      #
+      # POST /v5/fht/compliance/tax/private/batch_create
+      #
+      # @param start_time [Integer] Tax report start time (Unix timestamp, seconds)
+      # @param end_time [Integer] Tax report end time (Unix timestamp, seconds); interval must not exceed 12 months
+      # @param items [Array] Non-empty list of tax report export items
+      # @option kwargs [String] :source_institution Optional source institution identifier
+      # @option kwargs [String] :export_file_type Export file format:
+      #   - `csv` — CSV text format
+      #   - `orc` — ORC columnar format (default)
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @note Generated from the Bybit OpenAPI specification; no public documentation page is currently available.
+      def batch_create_tax_reports(start_time:, end_time:, items:, **kwargs)
+        params = Bybit::Utils::WireKeys.camelize(kwargs.merge(startTime: start_time, endTime: end_time, items: items))
+        @session.sign_request(method: :post, path: '/v5/fht/compliance/tax/private/batch_create', body: params)
+      end
+
+      # Query batch tax report status
+      #
+      # GET /v5/fht/compliance/tax/private/batch_query
+      #
+      # @param batch_id [String] Batch ID returned by `batch_create`
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @note Generated from the Bybit OpenAPI specification; no public documentation page is currently available.
+      def batch_query_tax_reports(batch_id:)
+        params = Bybit::Utils::WireKeys.camelize({ batchId: batch_id })
+        @session.sign_request(method: :get, path: '/v5/fht/compliance/tax/private/batch_query', params: params)
+      end
+    end
+  end
+end

data/lib/bybit/rest_api/user_service.rb

@@ -249,6 +249,16 @@ module Bybit
         params[:permissions] = permissions unless permissions.nil?
         @session.sign_request(method: :post, path: '/v5/user/update-sub-api', body: params)
       end
+
+      # Query Referral Code
+      #
+      # GET /v5/user/invitation/code
+      #
+      # @return [Hash] Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).
+      # @see https://bybit-exchange.github.io/docs/v5/user/referral-code
+      def query_referral_code
+        @session.sign_request(method: :get, path: '/v5/user/invitation/code')
+      end
     end
   end
 end

data/lib/bybit/session.rb

@@ -21,7 +21,8 @@ module Bybit
 
     def initialize(config)
       @config = config
-      @conn = config.faraday_connection || build_connection
+      @conn = config.faraday_connection ? config.faraday_connection.dup : build_connection
+      @conn.options.params_encoder = Faraday::FlatParamsEncoder
     end
 
     # Public unsigned endpoint — no X-BAPI-* headers attached.
@@ -52,9 +53,9 @@ module Bybit
       headers = build_headers(signed: signed, method: method, query_str: query_str, body_str: body_str)
 
       # Build URL manually with our own query_str so the wire bytes match
-      # what we signed. `req.params =` would re-serialize through
-      # Faraday::NestedParamsEncoder which key-orders and array-brackets
-      # differently, breaking the signature.
+      # what we signed. Faraday still parses URLs passed to `req.url`, so use
+      # its flat encoder to preserve repeated keys instead of collapsing them
+      # or adding array brackets.
       full_url = if !query_str.empty? && PAYLOAD_QUERY_METHODS.include?(method)
                    "#{path}?#{query_str}"
                  else
@@ -126,11 +127,21 @@ module Bybit
       body   = normalize_legacy_body(body) if body.is_a?(Hash)
 
       # HTTP status wins over retCode when the body isn't a valid ApiResponse.
-      # 5xx / non-auth 4xx get their own class so retries and pager logic can
-      # tell them apart from client / auth errors.
+      # 401/403/429 get their promised AuthError / RateLimitError classes even
+      # when a CDN/WAF returns HTML (no retCode); the README documents this
+      # contract. 5xx / other non-auth 4xx keep their generic Server/Client
+      # buckets so retry and pager logic can tell them apart.
       if !body.is_a?(Hash) || !body['retCode'].is_a?(Integer)
         preview = truncate_for_error(raw)
-        if status >= 500
+        if [401, 403].include?(status)
+          raise Bybit::AuthError.new(
+            "Bybit auth error (status=#{status}): #{preview}", http_status: status
+          )
+        elsif status == 429
+          raise Bybit::RateLimitError.new(
+            "Bybit rate limit (status=#{status}): #{preview}", http_status: status
+          )
+        elsif status >= 500
           raise Bybit::ServerError, "Bybit server error (status=#{status}): #{preview}"
         elsif status >= 400
           raise Bybit::ClientError, "Bybit client error (status=#{status}): #{preview}"

data/lib/bybit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bybit
-  VERSION = '0.1.0'
+  VERSION = '0.1.3'
 end