snaptrade 2.0.124 → 2.0.126

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c52a939d269906ab92631ba9806d1d7a9f6fc2b06badd2260018ca5046b9e6f5
-  data.tar.gz: 1d7b5eee9b5ae12d88c244aa086c0c2a7d5e428b3defec7e64a433ded17ffb22
+  metadata.gz: 43137f138b8350fe0965e3a2a323075c292dc33820eb0f0e9539a18919627bd1
+  data.tar.gz: 4abe81884e2b96419e60f492ee407f042f30f032b1dc529a24b89ec6bb3b3321
 SHA512:
-  metadata.gz: 406fe1174adad1ec1ad3962dae8c0c2098c9fc31ad30adbd6cbd8346a271ebf42f06285b129bd8d4f9283cdc16278125e5317aa245e9c4d36205c0b1ab5e8d3e
-  data.tar.gz: 710d59a5c10de48f22b51b9a36dd2077cdeb5a498c70e2553ae7cd8b012b6a62e2cf27854865479c289001f2dd70c780e182e45d2b5ab834f7ac261bb45e12fc
+  metadata.gz: 60cf996815603a779d72c3aa5e4cb88e704004e88c09f11e00fc75808c6a649fb93d10abba6fe15a7f278466165a0bb0906cfabc9aa5562f8272fa56594897dc
+  data.tar.gz: 3aff0d1f2d907de76459213fc6d2a2b17f0eeb88c4dce9029ea4ce7ab306177c8b65d76798b77449edadd89d5f970c1c26d50a1196775d69f7dd447467506305

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.124)
+    snaptrade (2.0.126)
       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.124-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.124)
+[![npm](https://img.shields.io/badge/gem-v2.0.126-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.126)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -44,11 +44,8 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.connections.remove_brokerage_authorization`](#snaptradeconnectionsremove_brokerage_authorization)
   * [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
   * [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
-  * [`snaptrade.options.get_option_strategy`](#snaptradeoptionsget_option_strategy)
   * [`snaptrade.options.get_options_chain`](#snaptradeoptionsget_options_chain)
-  * [`snaptrade.options.get_options_strategy_quote`](#snaptradeoptionsget_options_strategy_quote)
   * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
-  * [`snaptrade.options.place_option_strategy`](#snaptradeoptionsplace_option_strategy)
   * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
   * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
   * [`snaptrade.reference_data.get_security_types`](#snaptradereference_dataget_security_types)
@@ -84,7 +81,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.124'
+gem 'snaptrade', '~> 2.0.126'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -323,7 +320,11 @@ p result
 
 ### `snaptrade.account_information.get_user_account_order_detail`<a id="snaptradeaccount_informationget_user_account_order_detail"></a>
 
-Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
+Returns the detail of a single order in the specified account.
+
+This endpoint is always realtime and does not rely on cached data.
+
+This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1085,54 +1086,6 @@ specific users
 ---
 
 
-### `snaptrade.options.get_option_strategy`<a id="snaptradeoptionsget_option_strategy"></a>
-
-Creates an option strategy object that will be used to place an option strategy order.
-
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```ruby
-result = snaptrade.options.get_option_strategy(
-  underlying_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-  legs: [
-        {
-            "action" => "BUY_TO_OPEN",
-            "option_symbol_id" => "SPY220819P00200000",
-            "quantity" => 1,
-        }
-    ],
-  strategy_type: "CUSTOM",
-  user_id: "snaptrade-user-123",
-  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-  account_id: "accountId_example",
-)
-p result
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></a>
-
-##### underlying_symbol_id: `String`<a id="underlying_symbol_id-string"></a>
-##### legs: Array<[`OptionLeg`](./lib/snaptrade/models/option_leg.rb)><a id="legs-array"></a>
-##### strategy_type: [`StrategyType`](./lib/snaptrade/models/strategy_type.rb)<a id="strategy_type-strategytypelibsnaptrademodelsstrategy_typerb"></a>
-##### 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>
-The ID of the account to create the option strategy object in.
-
-#### 🔄 Return<a id="🔄-return"></a>
-
-[StrategyQuotes](./lib/snaptrade/models/strategy_quotes.rb)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/optionStrategy` `POST`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
-
 ### `snaptrade.options.get_options_chain`<a id="snaptradeoptionsget_options_chain"></a>
 
 Returns the option chain for the specified symbol in the specified account.
@@ -1172,46 +1125,6 @@ Universal symbol ID if symbol
 ---
 
 
-### `snaptrade.options.get_options_strategy_quote`<a id="snaptradeoptionsget_options_strategy_quote"></a>
-
-Returns a Strategy Quotes object which has latest market data of the specified option strategy.
-
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```ruby
-result = snaptrade.options.get_options_strategy_quote(
-  user_id: "snaptrade-user-123",
-  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-  account_id: "accountId_example",
-  option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-)
-p result
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></a>
-
-##### 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>
-The ID of the account the strategy will be placed in.
-
-##### option_strategy_id: `String`<a id="option_strategy_id-string"></a>
-Option strategy id obtained from response when creating option strategy object
-
-#### 🔄 Return<a id="🔄-return"></a>
-
-[StrategyQuotes](./lib/snaptrade/models/strategy_quotes.rb)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/optionStrategy/{optionStrategyId}` `GET`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
-
 ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
 
 Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
@@ -1248,66 +1161,6 @@ p result
 ---
 
 
-### `snaptrade.options.place_option_strategy`<a id="snaptradeoptionsplace_option_strategy"></a>
-
-Places the option strategy order and returns the order record received from the brokerage.
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```ruby
-result = snaptrade.options.place_option_strategy(
-  order_type: "Market",
-  time_in_force: "Day",
-  user_id: "snaptrade-user-123",
-  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-  account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-  option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-  price: 31.33,
-)
-p result
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></a>
-
-##### order_type: [`OrderTypeStrict`](./lib/snaptrade/models/order_type_strict.rb)<a id="order_type-ordertypestrictlibsnaptrademodelsorder_type_strictrb"></a>
-The type of order to place. - For `Limit` and `StopLimit` orders, the `price`
-field is required. - For `Stop` and `StopLimit` orders, the `stop` field is
-required.
-
-##### time_in_force: [`TimeInForceStrict`](./lib/snaptrade/models/time_in_force_strict.rb)<a id="time_in_force-timeinforcestrictlibsnaptrademodelstime_in_force_strictrb"></a>
-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.
-
-##### 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>
-The ID of the account to execute the strategy in.
-
-##### option_strategy_id: `String`<a id="option_strategy_id-string"></a>
-Option strategy id obtained from response when creating option strategy object
-
-##### price: `Float`<a id="price-float"></a>
-Trade Price if limit or stop limit order
-
-#### 🔄 Return<a id="🔄-return"></a>
-
-[StrategyOrderRecord](./lib/snaptrade/models/strategy_order_record.rb)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/optionStrategy/{optionStrategyId}/execute` `POST`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
-
 ### `snaptrade.reference_data.get_currency_exchange_rate_pair`<a id="snaptradereference_dataget_currency_exchange_rate_pair"></a>
 
 Returns an Exchange Rate Pair object for the specified Currency Pair.
@@ -1840,7 +1693,14 @@ The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
 
 ### `snaptrade.trading.get_user_account_quotes`<a id="snaptradetradingget_user_account_quotes"></a>
 
-Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
+Returns quotes from the brokerage for the specified symbols and account.
+
+The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.
+
+This endpoint does not work for options quotes.
+
+This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

data/lib/snaptrade/api/account_information_api.rb

@@ -499,7 +499,11 @@ module SnapTrade
 
     # Get account order detail
     #
-    # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
+    # Returns the detail of a single order in the specified account.
+    # 
+    # This endpoint is always realtime and does not rely on cached data.
+    # 
+    # This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -513,7 +517,11 @@ module SnapTrade
 
     # Get account order detail
     #
-    # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
+    # Returns the detail of a single order in the specified account.
+    # 
+    # This endpoint is always realtime and does not rely on cached data.
+    # 
+    # This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -525,7 +533,7 @@ module SnapTrade
     end
 
     # Get account order detail
-    # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data. 
+    # Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -538,7 +546,7 @@ module SnapTrade
     end
 
     # Get account order detail
-    # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data. 
+    # Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String]