snaptrade 2.0.169 → 2.0.170

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33929c4087a970521fd6adb8f82040f71eb532bcc70751fdf4bcd303eaccf2ac
-  data.tar.gz: 557c3746dc1ed4bbf09071f7266aa97e409706915107cf394c44504ec2ca0eff
+  metadata.gz: cba7ac2910a591d8ceb393ac6c1450830c2d7cde69dc82fa0907330084fe4cd8
+  data.tar.gz: af955f64bc6f941a5fdf8ccad68d28d59a8ddbb0d82b68019ad4d1ecab7261ee
 SHA512:
-  metadata.gz: a9f79a985b83dd4f6a23bd484a4a7bd5a5f0a50babb27d6d59517e5d062ba5f7e8b6809a3627c832199cc9cbd2adf22c43d1a998059f9e6383151cf909a19c11
-  data.tar.gz: c1b9a555fa7b3c738ad81ac6146ab7d1cb37de1734099bc1b241e691b59dde636e0cb5dcc08ab9cd685989a989b8e8e282ff845d9650576f9592eed2d9b6fdb9
+  metadata.gz: 62a57f7eb1345276c02a04b41d15295e5a7b567782fbb432ae300f62ce03e6e710ba9f804c962a51cc41744d8e9edbfad7c2bd87b326f152cac02e5126fd562d
+  data.tar.gz: c510aabcaa1e03e3c732a2cbceddf828b068270325c053ce288c74b0d44f79c87bfb689f001b89212f9f148f75cf21abcf7782d23f2c4cb3d98589159a72e9e7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.169)
+    snaptrade (2.0.170)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.169-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.169)
+[![npm](https://img.shields.io/badge/gem-v2.0.170-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.170)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -87,7 +87,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.169'
+gem 'snaptrade', '~> 2.0.170'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1336,9 +1336,7 @@ false to retrieve non executed orders as well
 
 ### `snaptrade.options.get_option_quote`<a id="snaptradeoptionsget_option_quote"></a>
 
-Returns a real-time quote for a single option contract. The option contract is specified using an OCC-formatted symbol.
-
-OCC format: `AAPL  251219C00150000` (underlying padded to 6 characters with spaces, followed by date, put/call, and strike).
+Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1347,6 +1345,7 @@ OCC format: `AAPL  251219C00150000` (underlying padded to 6 characters with spac
 result = snaptrade.options.get_option_quote(
   user_id: "snaptrade-user-123",
   user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   symbol: "AAPL  251219C00150000",
 )
 p result
@@ -1356,6 +1355,7 @@ p result
 
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
+##### account_id: `String`<a id="account_id-string"></a>
 ##### symbol: `String`<a id="symbol-string"></a>
 The OCC-formatted option symbol.
 
@@ -1365,7 +1365,7 @@ The OCC-formatted option symbol.
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/marketData/options/quotes` `GET`
+`/accounts/{accountId}/quotes/options` `GET`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)
 
@@ -1871,7 +1871,7 @@ p result
 ### `snaptrade.trading.get_option_impact`<a id="snaptradetradingget_option_impact"></a>
 
 Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it.
-Only supported for certain brokerages. Please refer to https://support.snaptrade.com/brokerages for more information on brokerage trading support.
+Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1920,10 +1920,11 @@ immediately will be canceled.
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
 ##### limit_price: `Float`<a id="limit_price-float"></a>
-The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
+The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`.
 
 ##### stop_price: `Float`<a id="stop_price-float"></a>
-The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+The stop price. Required if the order type is `STOP_LOSS_MARKET`,
+`STOP_LOSS_LIMIT`.
 
 ##### price_effect: [`MlegPriceEffectStrict`](./lib/snaptrade/models/mleg_price_effect_strict.rb)<a id="price_effect-mlegpriceeffectstrictlibsnaptrademodelsmleg_price_effect_strictrb"></a>
 #### 🔄 Return<a id="🔄-return"></a>
@@ -2208,19 +2209,19 @@ The amount of the base currency to buy or sell.
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
 ##### limit_price: `Float`<a id="limit_price-float"></a>
-The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or
-TAKE_PROFIT_LIMIT.
+The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or
+`TAKE_PROFIT_LIMIT`.
 
 ##### stop_price: `Float`<a id="stop_price-float"></a>
-The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT,
-TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
+The stop price. Required if the order type is `STOP_LOSS_MARKET`,
+`STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
 
 ##### post_only: `Boolean`<a id="post_only-boolean"></a>
-Valid and required only for order type LIMIT. If true orders that would be
+Valid and required only for order type `LIMIT`. If true orders that would be
 filled immediately are rejected to avoid incurring TAKER fees.
 
 ##### expiration_date: `Time`<a id="expiration_date-time"></a>
-The expiration date of the order. Required if the time_in_force is GTD.
+The expiration date of the order. Required if the time_in_force is `GTD`.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -2384,10 +2385,11 @@ immediately will be canceled.
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
 ##### limit_price: `Float`<a id="limit_price-float"></a>
-The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
+The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`.
 
 ##### stop_price: `Float`<a id="stop_price-float"></a>
-The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+The stop price. Required if the order type is `STOP_LOSS_MARKET`,
+`STOP_LOSS_LIMIT`.
 
 ##### price_effect: [`MlegPriceEffectStrict`](./lib/snaptrade/models/mleg_price_effect_strict.rb)<a id="price_effect-mlegpriceeffectstrictlibsnaptrademodelsmleg_price_effect_strictrb"></a>
 #### 🔄 Return<a id="🔄-return"></a>
@@ -2503,19 +2505,19 @@ The amount of the base currency to buy or sell.
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
 ##### limit_price: `Float`<a id="limit_price-float"></a>
-The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or
-TAKE_PROFIT_LIMIT.
+The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or
+`TAKE_PROFIT_LIMIT`.
 
 ##### stop_price: `Float`<a id="stop_price-float"></a>
-The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT,
-TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
+The stop price. Required if the order type is `STOP_LOSS_MARKET`,
+`STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
 
 ##### post_only: `Boolean`<a id="post_only-boolean"></a>
-Valid and required only for order type LIMIT. If true orders that would be
+Valid and required only for order type `LIMIT`. If true orders that would be
 filled immediately are rejected to avoid incurring TAKER fees.
 
 ##### expiration_date: `Time`<a id="expiration_date-time"></a>
-The expiration date of the order. Required if the time_in_force is GTD.
+The expiration date of the order. Required if the time_in_force is `GTD`.
 
 #### 🔄 Return<a id="🔄-return"></a>
 

data/lib/snaptrade/api/options_api.rb

@@ -19,53 +19,53 @@ module SnapTrade
 
     # Get option quote
     #
-    # Returns a real-time quote for a single option contract. The option contract is specified using an OCC-formatted symbol.
-    # 
-    # OCC format: `AAPL  251219C00150000` (underlying padded to 6 characters with spaces, followed by date, put/call, and strike).
+    # Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
     #
     # @param user_id [String] 
     # @param user_secret [String] 
+    # @param account_id [String] 
     # @param symbol [String] The OCC-formatted option symbol.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_option_quote(user_id:, user_secret:, symbol:, extra: {})
-      data, _status_code, _headers = get_option_quote_with_http_info_impl(user_id, user_secret, symbol, extra)
+    def get_option_quote(user_id:, user_secret:, account_id:, symbol:, extra: {})
+      data, _status_code, _headers = get_option_quote_with_http_info_impl(user_id, user_secret, account_id, symbol, extra)
       data
     end
 
     # Get option quote
     #
-    # Returns a real-time quote for a single option contract. The option contract is specified using an OCC-formatted symbol.
-    # 
-    # OCC format: `AAPL  251219C00150000` (underlying padded to 6 characters with spaces, followed by date, put/call, and strike).
+    # Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
     #
     # @param user_id [String] 
     # @param user_secret [String] 
+    # @param account_id [String] 
     # @param symbol [String] The OCC-formatted option symbol.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_option_quote_with_http_info(user_id:, user_secret:, symbol:, extra: {})
-      get_option_quote_with_http_info_impl(user_id, user_secret, symbol, extra)
+    def get_option_quote_with_http_info(user_id:, user_secret:, account_id:, symbol:, extra: {})
+      get_option_quote_with_http_info_impl(user_id, user_secret, account_id, symbol, extra)
     end
 
     # Get option quote
-    # Returns a real-time quote for a single option contract. The option contract is specified using an OCC-formatted symbol.  OCC format: `AAPL  251219C00150000` (underlying padded to 6 characters with spaces, followed by date, put/call, and strike). 
+    # Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) 
     # @param user_id [String] 
     # @param user_secret [String] 
+    # @param account_id [String] 
     # @param symbol [String] The OCC-formatted option symbol.
     # @param [Hash] opts the optional parameters
     # @return [OptionQuote]
-    private def get_option_quote_impl(user_id, user_secret, symbol, opts = {})
-      data, _status_code, _headers = get_option_quote_with_http_info(user_id, user_secret, symbol, opts)
+    private def get_option_quote_impl(user_id, user_secret, account_id, symbol, opts = {})
+      data, _status_code, _headers = get_option_quote_with_http_info(user_id, user_secret, account_id, symbol, opts)
       data
     end
 
     # Get option quote
-    # Returns a real-time quote for a single option contract. The option contract is specified using an OCC-formatted symbol.  OCC format: `AAPL  251219C00150000` (underlying padded to 6 characters with spaces, followed by date, put/call, and strike). 
+    # Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) 
     # @param user_id [String] 
     # @param user_secret [String] 
+    # @param account_id [String] 
     # @param symbol [String] The OCC-formatted option symbol.
     # @param [Hash] opts the optional parameters
     # @return [Array<(OptionQuote, Integer, Hash)>] OptionQuote data, response status code and response headers
-    private def get_option_quote_with_http_info_impl(user_id, user_secret, symbol, opts = {})
+    private def get_option_quote_with_http_info_impl(user_id, user_secret, account_id, symbol, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: OptionsApi.get_option_quote ...'
       end
@@ -77,12 +77,16 @@ module SnapTrade
       if @api_client.config.client_side_validation && user_secret.nil?
         fail ArgumentError, "Missing the required parameter 'user_secret' when calling OptionsApi.get_option_quote"
       end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling OptionsApi.get_option_quote"
+      end
       # verify the required parameter 'symbol' is set
       if @api_client.config.client_side_validation && symbol.nil?
         fail ArgumentError, "Missing the required parameter 'symbol' when calling OptionsApi.get_option_quote"
       end
       # resource path
-      local_var_path = '/marketData/options/quotes'
+      local_var_path = '/accounts/{accountId}/quotes/options'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/snaptrade/api/trading_api.rb

@@ -381,7 +381,7 @@ module SnapTrade
     # Get option order impact
     #
     # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it.
-    # Only supported for certain brokerages. Please refer to https://support.snaptrade.com/brokerages for more information on brokerage trading support.
+    # Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
     #
     # @param order_type [MlegOrderTypeStrict] The type of order to place.
     # @param time_in_force [TimeInForceStrict] The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: - `Day` - Day. The order is valid only for the trading day on which it is placed. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. 
@@ -389,8 +389,8 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
-    # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+    # @param limit_price [Float] The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`.
+    # @param stop_price [Float] The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`.
     # @param price_effect [MlegPriceEffectStrict] 
     # @param body [MlegTradeForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -410,7 +410,7 @@ module SnapTrade
     # Get option order impact
     #
     # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it.
-    # Only supported for certain brokerages. Please refer to https://support.snaptrade.com/brokerages for more information on brokerage trading support.
+    # Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
     #
     # @param order_type [MlegOrderTypeStrict] The type of order to place.
     # @param time_in_force [TimeInForceStrict] The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: - `Day` - Day. The order is valid only for the trading day on which it is placed. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. 
@@ -418,8 +418,8 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
-    # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+    # @param limit_price [Float] The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`.
+    # @param stop_price [Float] The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`.
     # @param price_effect [MlegPriceEffectStrict] 
     # @param body [MlegTradeForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -436,7 +436,7 @@ module SnapTrade
     end
 
     # Get option order impact
-    # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://support.snaptrade.com/brokerages for more information on brokerage trading support. 
+    # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -449,7 +449,7 @@ module SnapTrade
     end
 
     # Get option order impact
-    # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://support.snaptrade.com/brokerages for more information on brokerage trading support. 
+    # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -978,10 +978,10 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
-    # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
-    # @param post_only [Boolean] Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
-    # @param expiration_date [Time] The expiration date of the order. Required if the time_in_force is GTD.
+    # @param limit_price [Float] The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
+    # @param stop_price [Float] The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
+    # @param post_only [Boolean] Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
+    # @param expiration_date [Time] The expiration date of the order. Required if the time_in_force is `GTD`.
     # @param body [CryptoOrderForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def place_crypto_order(instrument:, side:, type:, time_in_force:, amount:, user_id:, user_secret:, account_id:, limit_price: SENTINEL, stop_price: SENTINEL, post_only: SENTINEL, expiration_date: SENTINEL, extra: {})
@@ -1013,10 +1013,10 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
-    # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
-    # @param post_only [Boolean] Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
-    # @param expiration_date [Time] The expiration date of the order. Required if the time_in_force is GTD.
+    # @param limit_price [Float] The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
+    # @param stop_price [Float] The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
+    # @param post_only [Boolean] Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
+    # @param expiration_date [Time] The expiration date of the order. Required if the time_in_force is `GTD`.
     # @param body [CryptoOrderForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def place_crypto_order_with_http_info(instrument:, side:, type:, time_in_force:, amount:, user_id:, user_secret:, account_id:, limit_price: SENTINEL, stop_price: SENTINEL, post_only: SENTINEL, expiration_date: SENTINEL, extra: {})
@@ -1297,8 +1297,8 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
-    # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+    # @param limit_price [Float] The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`.
+    # @param stop_price [Float] The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`.
     # @param price_effect [MlegPriceEffectStrict] 
     # @param body [MlegTradeForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -1325,8 +1325,8 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
-    # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+    # @param limit_price [Float] The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`.
+    # @param stop_price [Float] The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`.
     # @param price_effect [MlegPriceEffectStrict] 
     # @param body [MlegTradeForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -1567,10 +1567,10 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
-    # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
-    # @param post_only [Boolean] Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
-    # @param expiration_date [Time] The expiration date of the order. Required if the time_in_force is GTD.
+    # @param limit_price [Float] The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
+    # @param stop_price [Float] The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
+    # @param post_only [Boolean] Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
+    # @param expiration_date [Time] The expiration date of the order. Required if the time_in_force is `GTD`.
     # @param body [CryptoOrderForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def preview_crypto_order(instrument:, side:, type:, time_in_force:, amount:, user_id:, user_secret:, account_id:, limit_price: SENTINEL, stop_price: SENTINEL, post_only: SENTINEL, expiration_date: SENTINEL, extra: {})
@@ -1601,10 +1601,10 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
-    # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
-    # @param post_only [Boolean] Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
-    # @param expiration_date [Time] The expiration date of the order. Required if the time_in_force is GTD.
+    # @param limit_price [Float] The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
+    # @param stop_price [Float] The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
+    # @param post_only [Boolean] Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
+    # @param expiration_date [Time] The expiration date of the order. Required if the time_in_force is `GTD`.
     # @param body [CryptoOrderForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def preview_crypto_order_with_http_info(instrument:, side:, type:, time_in_force:, amount:, user_id:, user_secret:, account_id:, limit_price: SENTINEL, stop_price: SENTINEL, post_only: SENTINEL, expiration_date: SENTINEL, extra: {})

data/lib/snaptrade/models/cash_change_direction.rb

@@ -0,0 +1,39 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  class CashChangeDirection
+    CREDIT = "CREDIT".freeze
+    DEBIT = "DEBIT".freeze
+    EVEN = "EVEN".freeze
+    UNKNOWN = "UNKNOWN".freeze
+
+    def self.all_vars
+      @all_vars ||= [CREDIT, DEBIT, EVEN, UNKNOWN].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if CashChangeDirection.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #CashChangeDirection"
+    end
+  end
+end

data/lib/snaptrade/models/crypto_order_form.rb

@@ -26,16 +26,16 @@ module SnapTrade
     # The amount of the base currency to buy or sell.
     attr_accessor :amount
 
-    # The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
+    # The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
     attr_accessor :limit_price
 
-    # The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
+    # The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
     attr_accessor :stop_price
 
-    # Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
+    # Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
     attr_accessor :post_only
 
-    # The expiration date of the order. Required if the time_in_force is GTD.
+    # The expiration date of the order. Required if the time_in_force is `GTD`.
     attr_accessor :expiration_date
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/mleg_trade_form.rb

@@ -19,10 +19,10 @@ module SnapTrade
     # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. 
     attr_accessor :time_in_force
 
-    # The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
+    # The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`.
     attr_accessor :limit_price
 
-    # The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+    # The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`.
     attr_accessor :stop_price
 
     attr_accessor :price_effect

data/lib/snaptrade/models/option_impact.rb

@@ -11,19 +11,23 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Estimated cost and fees for an option order before it is placed.
+  # Estimated cash change and fees for an option order before it is placed.
   class OptionImpact
-    # Estimated option premium for the order (before fees).
-    attr_accessor :estimated_cost
+    # Estimated cash change for the order, before fees.
+    attr_accessor :estimated_cash_change
 
-    # Estimated transaction fees and commissions for the order.
-    attr_accessor :estimated_transaction_fee
+    # Direction of the cash change. CREDIT means cash is received, DEBIT means cash is paid out, EVEN means no cash changes hands. UNKNOWN if the direction cannot be determined from the request.
+    attr_accessor :cash_change_direction
+
+    # Estimated total transaction fees and commissions for the order.
+    attr_accessor :estimated_fee_total
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'estimated_cost' => :'estimated_cost',
-        :'estimated_transaction_fee' => :'estimated_transaction_fee'
+        :'estimated_cash_change' => :'estimated_cash_change',
+        :'cash_change_direction' => :'cash_change_direction',
+        :'estimated_fee_total' => :'estimated_fee_total'
       }
     end
 
@@ -35,14 +39,16 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'estimated_cost' => :'String',
-        :'estimated_transaction_fee' => :'String'
+        :'estimated_cash_change' => :'String',
+        :'cash_change_direction' => :'CashChangeDirection',
+        :'estimated_fee_total' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'cash_change_direction',
       ])
     end
 
@@ -61,12 +67,16 @@ module SnapTrade
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'estimated_cost')
-        self.estimated_cost = attributes[:'estimated_cost']
+      if attributes.key?(:'estimated_cash_change')
+        self.estimated_cash_change = attributes[:'estimated_cash_change']
+      end
+
+      if attributes.key?(:'cash_change_direction')
+        self.cash_change_direction = attributes[:'cash_change_direction']
       end
 
-      if attributes.key?(:'estimated_transaction_fee')
-        self.estimated_transaction_fee = attributes[:'estimated_transaction_fee']
+      if attributes.key?(:'estimated_fee_total')
+        self.estimated_fee_total = attributes[:'estimated_fee_total']
       end
     end
 
@@ -88,8 +98,9 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          estimated_cost == o.estimated_cost &&
-          estimated_transaction_fee == o.estimated_transaction_fee
+          estimated_cash_change == o.estimated_cash_change &&
+          cash_change_direction == o.cash_change_direction &&
+          estimated_fee_total == o.estimated_fee_total
     end
 
     # @see the `==` method
@@ -101,7 +112,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [estimated_cost, estimated_transaction_fee].hash
+      [estimated_cash_change, cash_change_direction, estimated_fee_total].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/simple_order_form.rb

@@ -26,16 +26,16 @@ module SnapTrade
     # The amount of the base currency to buy or sell.
     attr_accessor :amount
 
-    # The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
+    # The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
     attr_accessor :limit_price
 
-    # The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
+    # The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
     attr_accessor :stop_price
 
-    # Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
+    # Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
     attr_accessor :post_only
 
-    # The expiration date of the order. Required if the time_in_force is GTD.
+    # The expiration date of the order. Required if the time_in_force is `GTD`.
     attr_accessor :expiration_date
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/version.rb

@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '2.0.169'
+  VERSION = '2.0.170'
 end

data/lib/snaptrade.rb

@@ -59,6 +59,7 @@ require 'snaptrade/models/brokerage_instrument'
 require 'snaptrade/models/brokerage_instruments_response'
 require 'snaptrade/models/brokerage_type'
 require 'snaptrade/models/cancel_order_response'
+require 'snaptrade/models/cash_change_direction'
 require 'snaptrade/models/child_brokerage_order_ids'
 require 'snaptrade/models/connection_portal_version'
 require 'snaptrade/models/connection_type'

data/spec/api/options_api_spec.rb

@@ -29,9 +29,10 @@ describe 'OptionsApi' do
 
   # unit tests for get_option_quote
   # Get option quote
-  # Returns a real-time quote for a single option contract. The option contract is specified using an OCC-formatted symbol.  OCC format: `AAPL  251219C00150000` (underlying padded to 6 characters with spaces, followed by date, put/call, and strike). 
+  # Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) 
   # @param user_id 
   # @param user_secret 
+  # @param account_id 
   # @param symbol The OCC-formatted option symbol.
   # @param [Hash] opts the optional parameters
   # @return [OptionQuote]

data/spec/api/trading_api_spec.rb

@@ -74,7 +74,7 @@ describe 'TradingApi' do
 
   # unit tests for get_option_impact
   # Get option order impact
-  # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://support.snaptrade.com/brokerages for more information on brokerage trading support. 
+  # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint. 
   # @param user_id 
   # @param user_secret 
   # @param account_id 

data/spec/models/cash_change_direction_spec.rb

@@ -0,0 +1,23 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SnapTrade::CashChangeDirection
+describe SnapTrade::CashChangeDirection do
+  let(:instance) { SnapTrade::CashChangeDirection.new }
+
+  describe 'test an instance of CashChangeDirection' do
+    it 'should create an instance of CashChangeDirection' do
+      expect(instance).to be_instance_of(SnapTrade::CashChangeDirection)
+    end
+  end
+end

data/spec/models/option_impact_spec.rb

@@ -20,13 +20,19 @@ describe SnapTrade::OptionImpact do
       expect(instance).to be_instance_of(SnapTrade::OptionImpact)
     end
   end
-  describe 'test attribute "estimated_cost"' do
+  describe 'test attribute "estimated_cash_change"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "estimated_transaction_fee"' do
+  describe 'test attribute "cash_change_direction"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "estimated_fee_total"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.169
+  version: 2.0.170
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-03-06 00:00:00.000000000 Z
+date: 2026-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -139,6 +139,7 @@ files:
 - lib/snaptrade/models/brokerage_instruments_response.rb
 - lib/snaptrade/models/brokerage_type.rb
 - lib/snaptrade/models/cancel_order_response.rb
+- lib/snaptrade/models/cash_change_direction.rb
 - lib/snaptrade/models/child_brokerage_order_ids.rb
 - lib/snaptrade/models/connection_portal_version.rb
 - lib/snaptrade/models/connection_type.rb
@@ -320,6 +321,7 @@ files:
 - spec/models/brokerage_spec.rb
 - spec/models/brokerage_type_spec.rb
 - spec/models/cancel_order_response_spec.rb
+- spec/models/cash_change_direction_spec.rb
 - spec/models/child_brokerage_order_ids_spec.rb
 - spec/models/connection_portal_version_spec.rb
 - spec/models/connection_type_spec.rb
@@ -556,6 +558,7 @@ test_files:
 - spec/models/brokerage_authorization_refresh_confirmation_spec.rb
 - spec/models/account_order_record_spec.rb
 - spec/models/strategy_quotes_greek_spec.rb
+- spec/models/cash_change_direction_spec.rb
 - spec/models/net_contributions_spec.rb
 - spec/models/mleg_order_response_spec.rb
 - spec/models/manual_trade_form_notional_value_spec.rb