snaptrade 2.0.119 → 2.0.121

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04544c3b4f3722e8f2bfc3b1a730fb3fc6ef65fd762afddf4d3e21556880faa4
-  data.tar.gz: 53521894f19e0f2bb52942845132b7f07dc3a0b9de436aa00d57b96d539c1041
+  metadata.gz: 7c6d68c3bef6d28351d54a9f45678a5cfefc9b9391e9ab251e2a1fde13a1932d
+  data.tar.gz: d6a23c0e07e552ec7a3164b9726b4c9a17519e25adcc6b6cd3fb141ec1ae6c68
 SHA512:
-  metadata.gz: e24567932a3cb2c2aa19c1219e3ebc26708beab6a2a5c84cf06b5f4468526c6466a4029202743227245a6d0eafea43fa02fdd7ddcb6e2b88bed363f7c1623fa0
-  data.tar.gz: b8409aaf5fcb21bd3a9a591f0cdaa93500211ad4bd359f6edd929fcbfac82450402a477f14c321b8d6cc73d44a491c85d7fc0b15da597b10f92e731e7c641432
+  metadata.gz: 70c0c65c30a04eacf60727973d3b3090b28cfac3746b964c9884f64271705e304762d280b7fda101db556548e94a34e8262d17d83a0dc56ea6cc66688f6330b6
+  data.tar.gz: fd1a0091ab72a9e0ee4955fe64d8ae8cc96edc7a03fa2ffdaddf516cf043a901142980dca741929703522ea7ebdc44f4a3bab494819b630a65df65f8136f895c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.119)
+    snaptrade (2.0.121)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -42,7 +42,7 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.10.0)
+    regexp_parser (2.11.0)
     reline (0.6.2)
       io-console (~> 0.5)
     rexml (3.4.1)

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.119-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.119)
+[![npm](https://img.shields.io/badge/gem-v2.0.121-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.121)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -66,11 +66,11 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.trading.get_order_impact`](#snaptradetradingget_order_impact)
   * [`snaptrade.trading.get_user_account_quotes`](#snaptradetradingget_user_account_quotes)
   * [`snaptrade.trading.place_bracket_order`](#snaptradetradingplace_bracket_order)
+  * [`snaptrade.trading.place_crypto_order`](#snaptradetradingplace_crypto_order)
   * [`snaptrade.trading.place_force_order`](#snaptradetradingplace_force_order)
   * [`snaptrade.trading.place_mleg_order`](#snaptradetradingplace_mleg_order)
   * [`snaptrade.trading.place_order`](#snaptradetradingplace_order)
-  * [`snaptrade.trading.place_simple_order`](#snaptradetradingplace_simple_order)
-  * [`snaptrade.trading.preview_simple_order`](#snaptradetradingpreview_simple_order)
+  * [`snaptrade.trading.preview_crypto_order`](#snaptradetradingpreview_crypto_order)
   * [`snaptrade.trading.replace_order`](#snaptradetradingreplace_order)
   * [`snaptrade.trading.search_cryptocurrency_pair_instruments`](#snaptradetradingsearch_cryptocurrency_pair_instruments)
   * [`snaptrade.transactions_and_reporting.get_activities`](#snaptradetransactions_and_reportingget_activities)
@@ -83,7 +83,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.119'
+gem 'snaptrade', '~> 2.0.121'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1612,7 +1612,7 @@ The search query for symbols.
 
 ### `snaptrade.trading.cancel_order`<a id="snaptradetradingcancel_order"></a>
 
-Cancels an order in the specified account.
+Cancels an order in the specified account. Accepts order IDs for all asset types.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1650,7 +1650,9 @@ the brokerage system.
 
 
 ### `snaptrade.trading.cancel_user_account_order`<a id="snaptradetradingcancel_user_account_order"></a>
+![Deprecated](https://img.shields.io/badge/deprecated-yellow)
 
+**This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) **
 Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
 
 
@@ -1933,6 +1935,88 @@ Must be `null` if `notional_value` is provided.
 ---
 
 
+### `snaptrade.trading.place_crypto_order`<a id="snaptradetradingplace_crypto_order"></a>
+
+Places an order in the specified account.
+This endpoint does not compute the impact to the account balance from the order before submitting the order.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.trading.place_crypto_order(
+  instrument: {
+        "symbol" => "BTC",
+        "type" => "CRYPTOCURRENCY",
+    },
+  side: "BUY",
+  type: "MARKET",
+  time_in_force: "GTC",
+  amount: "123.45",
+  user_id: "snaptrade-user-123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  limit_price: "123.45",
+  stop_price: "123.45",
+  post_only: false,
+  expiration_date: "2024-01-01T00:00:00Z",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### instrument: [`CryptoTradingInstrument`](./lib/snaptrade/models/crypto_trading_instrument.rb)<a id="instrument-cryptotradinginstrumentlibsnaptrademodelscrypto_trading_instrumentrb"></a>
+##### side: [`ActionStrict`](./lib/snaptrade/models/action_strict.rb)<a id="side-actionstrictlibsnaptrademodelsaction_strictrb"></a>
+The action describes the intent or side of a trade. This is either `BUY` or
+`SELL`.
+
+##### type: [`CryptoOrderFormType`](./lib/snaptrade/models/crypto_order_form_type.rb)<a id="type-cryptoorderformtypelibsnaptrademodelscrypto_order_form_typerb"></a>
+The type of order to place.
+
+##### time_in_force: [`CryptoOrderFormTimeInForce`](./lib/snaptrade/models/crypto_order_form_time_in_force.rb)<a id="time_in_force-cryptoorderformtimeinforcelibsnaptrademodelscrypto_order_form_time_in_forcerb"></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. - `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. - `GTD` - Good Til Date. The order is valid until the specified date.
+
+##### amount: `Float`<a id="amount-float"></a>
+The amount of the base currency to buy or sell.
+
+##### 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>
+##### 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.
+
+##### 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.
+
+##### post_only: `Boolean`<a id="post_only-boolean"></a>
+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.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[OrderUpdatedResponse](./lib/snaptrade/models/order_updated_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/crypto` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.trading.place_force_order`<a id="snaptradetradingplace_force_order"></a>
 
 Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
@@ -1953,7 +2037,7 @@ result = snaptrade.trading.place_force_order(
   user_id: "snaptrade-user-123",
   user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-  symbol: "AAPL  131124C00240000",
+  symbol: "AAPL",
   price: 31.33,
   stop: 31.33,
   units: 10.5,
@@ -1995,12 +2079,8 @@ The universal symbol ID of the security to trade. Must be 'null' if `symbol` is
 provided, otherwise must be provided.
 
 ##### symbol: `String`<a id="symbol-string"></a>
-The security's trading ticker symbol. This currently supports stock symbols and
-Options symbols in the 21 character OCC format. For example `AAPL
-131124C00240000` represents a call option on AAPL expiring on 2024-11-13 with a
-strike price of $240. For more information on the OCC format, see
-[here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format). If 'symbol' is
-provided, then 'universal_symbol_id' must be 'null'.
+The security's trading ticker symbol. If 'symbol' is provided, then
+'universal_symbol_id' must be 'null'.
 
 ##### price: `Float`<a id="price-float"></a>
 The limit price for `Limit` and `StopLimit` orders.
@@ -2144,89 +2224,7 @@ before responding to the request.
 ---
 
 
-### `snaptrade.trading.place_simple_order`<a id="snaptradetradingplace_simple_order"></a>
-
-Places an order in the specified account.
-This endpoint does not compute the impact to the account balance from the order before submitting the order.
-
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```ruby
-result = snaptrade.trading.place_simple_order(
-  instrument: {
-        "symbol" => "AAPL",
-        "type" => "EQUITY",
-    },
-  side: "BUY",
-  type: "MARKET",
-  time_in_force: "GTC",
-  amount: "123.45",
-  user_id: "snaptrade-user-123",
-  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
-  limit_price: "123.45",
-  stop_price: "123.45",
-  post_only: false,
-  expiration_date: "2024-01-01T00:00:00Z",
-)
-p result
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></a>
-
-##### instrument: [`TradingInstrument`](./lib/snaptrade/models/trading_instrument.rb)<a id="instrument-tradinginstrumentlibsnaptrademodelstrading_instrumentrb"></a>
-##### side: [`ActionStrict`](./lib/snaptrade/models/action_strict.rb)<a id="side-actionstrictlibsnaptrademodelsaction_strictrb"></a>
-The action describes the intent or side of a trade. This is either `BUY` or
-`SELL`.
-
-##### type: [`SimpleOrderFormType`](./lib/snaptrade/models/simple_order_form_type.rb)<a id="type-simpleorderformtypelibsnaptrademodelssimple_order_form_typerb"></a>
-The type of order to place.
-
-##### time_in_force: [`SimpleOrderFormTimeInForce`](./lib/snaptrade/models/simple_order_form_time_in_force.rb)<a id="time_in_force-simpleorderformtimeinforcelibsnaptrademodelssimple_order_form_time_in_forcerb"></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. - `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. - `GTD` - Good Til Date. The order is valid until the specified date.
-
-##### amount: `Float`<a id="amount-float"></a>
-The amount of the base currency to buy or sell.
-
-##### 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>
-##### 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.
-
-##### 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.
-
-##### post_only: `Boolean`<a id="post_only-boolean"></a>
-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.
-
-#### 🔄 Return<a id="🔄-return"></a>
-
-[OrderUpdatedResponse](./lib/snaptrade/models/order_updated_response.rb)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/trading/simple` `POST`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
-
-### `snaptrade.trading.preview_simple_order`<a id="snaptradetradingpreview_simple_order"></a>
+### `snaptrade.trading.preview_crypto_order`<a id="snaptradetradingpreview_crypto_order"></a>
 
 Previews an order using the specified account.
 
@@ -2234,10 +2232,10 @@ Previews an order using the specified account.
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```ruby
-result = snaptrade.trading.preview_simple_order(
+result = snaptrade.trading.preview_crypto_order(
   instrument: {
-        "symbol" => "AAPL",
-        "type" => "EQUITY",
+        "symbol" => "BTC",
+        "type" => "CRYPTOCURRENCY",
     },
   side: "BUY",
   type: "MARKET",
@@ -2256,15 +2254,15 @@ p result
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### instrument: [`TradingInstrument`](./lib/snaptrade/models/trading_instrument.rb)<a id="instrument-tradinginstrumentlibsnaptrademodelstrading_instrumentrb"></a>
+##### instrument: [`CryptoTradingInstrument`](./lib/snaptrade/models/crypto_trading_instrument.rb)<a id="instrument-cryptotradinginstrumentlibsnaptrademodelscrypto_trading_instrumentrb"></a>
 ##### side: [`ActionStrict`](./lib/snaptrade/models/action_strict.rb)<a id="side-actionstrictlibsnaptrademodelsaction_strictrb"></a>
 The action describes the intent or side of a trade. This is either `BUY` or
 `SELL`.
 
-##### type: [`SimpleOrderFormType`](./lib/snaptrade/models/simple_order_form_type.rb)<a id="type-simpleorderformtypelibsnaptrademodelssimple_order_form_typerb"></a>
+##### type: [`CryptoOrderFormType`](./lib/snaptrade/models/crypto_order_form_type.rb)<a id="type-cryptoorderformtypelibsnaptrademodelscrypto_order_form_typerb"></a>
 The type of order to place.
 
-##### time_in_force: [`SimpleOrderFormTimeInForce`](./lib/snaptrade/models/simple_order_form_time_in_force.rb)<a id="time_in_force-simpleorderformtimeinforcelibsnaptrademodelssimple_order_form_time_in_forcerb"></a>
+##### time_in_force: [`CryptoOrderFormTimeInForce`](./lib/snaptrade/models/crypto_order_form_time_in_force.rb)<a id="time_in_force-cryptoorderformtimeinforcelibsnaptrademodelscrypto_order_form_time_in_forcerb"></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. - `GTC` - Good Til
 Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or
@@ -2296,11 +2294,11 @@ The expiration date of the order. Required if the time_in_force is GTD.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
-[SimpleOrderPreview](./lib/snaptrade/models/simple_order_preview.rb)
+[CryptoOrderPreview](./lib/snaptrade/models/crypto_order_preview.rb)
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/accounts/{accountId}/trading/simple/preview` `POST`
+`/accounts/{accountId}/trading/crypto/preview` `POST`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)
 
@@ -2318,11 +2316,11 @@ returned in the response going forward. Only supported on some brokerages
 
 ```ruby
 result = snaptrade.trading.replace_order(
+  brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
   action: "BUY",
   order_type: "Market",
   time_in_force: "Day",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-  brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
   user_id: "snaptrade-user-123",
   user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   price: 31.33,
@@ -2335,6 +2333,10 @@ p result
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
+##### brokerage_order_id: `String`<a id="brokerage_order_id-string"></a>
+Order ID returned by brokerage. This is the unique identifier for the order in
+the brokerage system.
+
 ##### action: [`ActionStrict`](./lib/snaptrade/models/action_strict.rb)<a id="action-actionstrictlibsnaptrademodelsaction_strictrb"></a>
 The action describes the intent or side of a trade. This is either `BUY` or
 `SELL`.
@@ -2357,9 +2359,6 @@ immediately will be canceled.
 ##### account_id: `String`<a id="account_id-string"></a>
 The ID of the account to execute the trade on.
 
-##### brokerage_order_id: `String`<a id="brokerage_order_id-string"></a>
-The Brokerage Order ID of the order to replace.
-
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### price: `Float`<a id="price-float"></a>
@@ -2378,7 +2377,7 @@ The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/accounts/{accountId}/trading/simple/{brokerageOrderId}/replace` `PATCH`
+`/accounts/{accountId}/trading/replace` `POST`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)