snaptrade 2.0.160 → 2.0.162

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +8 -9
  4. data/lib/snaptrade/api/experimental_endpoints_api.rb +22 -35
  5. data/lib/snaptrade/api/trading_api.rb +6 -2
  6. data/lib/snaptrade/models/tax_lot.rb +16 -5
  7. data/lib/snaptrade/version.rb +1 -1
  8. data/spec/api/experimental_endpoints_api_spec.rb +2 -2
  9. data/spec/api/trading_api_spec.rb +1 -1
  10. data/spec/models/tax_lot_spec.rb +6 -0
  11. metadata +149 -149
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 39abef0a80a05056e6158a4188f33e2fdaff4fba0e1d2df65e8a0ac813547676
4
- data.tar.gz: c972f3c93167a4380b19db8012a459afb4d2b04d007f7db1b7753dd8a2549d9f
3
+ metadata.gz: c3d0b0cc8be4545206c323ad3a5c5f12b3d554b2e68cb9c0d824f8c9e487916e
4
+ data.tar.gz: 0203e68a5490b53f71c06b8b9a67a25131676c25907e8f702e65bc42be947e08
5
5
  SHA512:
6
- metadata.gz: cba00b1bdbf83f0eab2124b8694ac57387937a9e71a2e611b96bd4b3d16d2ef512338982371ac54ba4e016b59cd08a03cf723d591c2f2f3c8d8e7637436f4902
7
- data.tar.gz: 8157df2d2e6eef61236ad1d2105cda161064ad4661828648992dba12c524f4a092f531a54a7876eabcc7aae35b4024eb4a1dee5e27a58b816cb4ef33a251b99e
6
+ metadata.gz: 77e7ad45a7b99c316d50f4c680ac78a94ef4102b26792c891d572e6b2c75eefde3595fa186c41e322cdc4f73e3b73cb1c0d28972ac169f9abe591b851d199807
7
+ data.tar.gz: 1b1c02c6fd99c6ff4d2d12963ede139f399420d1a244842080044e8f2c07eb86e3f01bb66faa559c939d6f24af870dfc6012acc785a9dba8c87661b545253593
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- snaptrade (2.0.160)
4
+ snaptrade (2.0.162)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
data/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Connect brokerage accounts to your app for live positions and trading
8
8
 
9
- [![npm](https://img.shields.io/badge/gem-v2.0.160-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.160)
9
+ [![npm](https://img.shields.io/badge/gem-v2.0.162-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.162)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -84,7 +84,7 @@ Connect brokerage accounts to your app for live positions and trading
84
84
  Add to Gemfile:
85
85
 
86
86
  ```ruby
87
- gem 'snaptrade', '~> 2.0.160'
87
+ gem 'snaptrade', '~> 2.0.162'
88
88
  ```
89
89
 
90
90
  ## Getting Started<a id="getting-started"></a>
@@ -1131,7 +1131,7 @@ specific users
1131
1131
 
1132
1132
  ### `snaptrade.experimental_endpoints.get_user_account_order_detail_v2`<a id="snaptradeexperimental_endpointsget_user_account_order_detail_v2"></a>
1133
1133
 
1134
- Returns the detail of a single order using the external order ID provided in the request body.
1134
+ Returns the detail of a single order using the brokerage order ID provided as a path parameter.
1135
1135
 
1136
1136
  The V2 order response format includes all legs of the order in the `legs` list field.
1137
1137
  If the order is single legged, `legs` will be a list of one leg.
@@ -1145,8 +1145,8 @@ This endpoint only returns orders placed through SnapTrade. In other words, orde
1145
1145
 
1146
1146
  ```ruby
1147
1147
  result = snaptrade.experimental_endpoints.get_user_account_order_detail_v2(
1148
- brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
1149
1148
  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1149
+ brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
1150
1150
  user_id: "snaptrade-user-123",
1151
1151
  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1152
1152
  )
@@ -1155,11 +1155,8 @@ p result
1155
1155
 
1156
1156
  #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1157
1157
 
1158
- ##### brokerage_order_id: `String`<a id="brokerage_order_id-string"></a>
1159
- Order ID returned by brokerage. This is the unique identifier for the order in
1160
- the brokerage system.
1161
-
1162
1158
  ##### account_id: `String`<a id="account_id-string"></a>
1159
+ ##### brokerage_order_id: `String`<a id="brokerage_order_id-string"></a>
1163
1160
  ##### user_id: `String`<a id="user_id-string"></a>
1164
1161
  ##### user_secret: `String`<a id="user_secret-string"></a>
1165
1162
  #### 🔄 Return<a id="🔄-return"></a>
@@ -1168,7 +1165,7 @@ the brokerage system.
1168
1165
 
1169
1166
  #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1170
1167
 
1171
- `/accounts/{accountId}/orders/details/v2` `POST`
1168
+ `/accounts/{accountId}/orders/details/v2/{brokerageOrderId}` `GET`
1172
1169
 
1173
1170
  [🔙 **Back to Table of Contents**](#table-of-contents)
1174
1171
 
@@ -1881,6 +1878,8 @@ Returns quotes from the brokerage for the specified symbols and account.
1881
1878
 
1882
1879
  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.
1883
1880
 
1881
+ **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**
1882
+
1884
1883
  This endpoint does not work for options quotes.
1885
1884
 
1886
1885
  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
data/lib/snaptrade/api/experimental_endpoints_api.rb CHANGED
@@ -19,7 +19,7 @@ module SnapTrade
19
19
 
20
20
  # Get account order detail (V2)
21
21
  #
22
- # Returns the detail of a single order using the external order ID provided in the request body.
22
+ # Returns the detail of a single order using the brokerage order ID provided as a path parameter.
23
23
  #
24
24
  # The V2 order response format includes all legs of the order in the `legs` list field.
25
25
  # If the order is single legged, `legs` will be a list of one leg.
@@ -28,23 +28,19 @@ module SnapTrade
28
28
  #
29
29
  # This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
30
30
  #
31
- # @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
32
31
  # @param account_id [String]
32
+ # @param brokerage_order_id [String]
33
33
  # @param user_id [String]
34
34
  # @param user_secret [String]
35
- # @param body [AccountInformationGetUserAccountOrderDetailRequest]
36
35
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
37
- def get_user_account_order_detail_v2(brokerage_order_id:, account_id:, user_id:, user_secret:, extra: {})
38
- _body = {}
39
- _body[:brokerage_order_id] = brokerage_order_id if brokerage_order_id != SENTINEL
40
- account_information_get_user_account_order_detail_request = _body
41
- data, _status_code, _headers = get_user_account_order_detail_v2_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, extra)
36
+ def get_user_account_order_detail_v2(account_id:, brokerage_order_id:, user_id:, user_secret:, extra: {})
37
+ data, _status_code, _headers = get_user_account_order_detail_v2_with_http_info_impl(account_id, brokerage_order_id, user_id, user_secret, extra)
42
38
  data
43
39
  end
44
40
 
45
41
  # Get account order detail (V2)
46
42
  #
47
- # Returns the detail of a single order using the external order ID provided in the request body.
43
+ # Returns the detail of a single order using the brokerage order ID provided as a path parameter.
48
44
  #
49
45
  # The V2 order response format includes all legs of the order in the `legs` list field.
50
46
  # If the order is single legged, `legs` will be a list of one leg.
@@ -53,41 +49,37 @@ module SnapTrade
53
49
  #
54
50
  # This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
55
51
  #
56
- # @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
57
52
  # @param account_id [String]
53
+ # @param brokerage_order_id [String]
58
54
  # @param user_id [String]
59
55
  # @param user_secret [String]
60
- # @param body [AccountInformationGetUserAccountOrderDetailRequest]
61
56
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
62
- def get_user_account_order_detail_v2_with_http_info(brokerage_order_id:, account_id:, user_id:, user_secret:, extra: {})
63
- _body = {}
64
- _body[:brokerage_order_id] = brokerage_order_id if brokerage_order_id != SENTINEL
65
- account_information_get_user_account_order_detail_request = _body
66
- get_user_account_order_detail_v2_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, extra)
57
+ def get_user_account_order_detail_v2_with_http_info(account_id:, brokerage_order_id:, user_id:, user_secret:, extra: {})
58
+ get_user_account_order_detail_v2_with_http_info_impl(account_id, brokerage_order_id, user_id, user_secret, extra)
67
59
  end
68
60
 
69
61
  # Get account order detail (V2)
70
- # Returns the detail of a single order using the external order ID provided in the request body. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. 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.
62
+ # Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. 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.
71
63
  # @param account_id [String]
64
+ # @param brokerage_order_id [String]
72
65
  # @param user_id [String]
73
66
  # @param user_secret [String]
74
- # @param account_information_get_user_account_order_detail_request [AccountInformationGetUserAccountOrderDetailRequest]
75
67
  # @param [Hash] opts the optional parameters
76
68
  # @return [AccountOrderRecordV2]
77
- private def get_user_account_order_detail_v2_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts = {})
78
- data, _status_code, _headers = get_user_account_order_detail_v2_with_http_info(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts)
69
+ private def get_user_account_order_detail_v2_impl(account_id, brokerage_order_id, user_id, user_secret, opts = {})
70
+ data, _status_code, _headers = get_user_account_order_detail_v2_with_http_info(account_id, brokerage_order_id, user_id, user_secret, opts)
79
71
  data
80
72
  end
81
73
 
82
74
  # Get account order detail (V2)
83
- # Returns the detail of a single order using the external order ID provided in the request body. The V2 order response format includes all legs of the order in the &#x60;legs&#x60; list field. If the order is single legged, &#x60;legs&#x60; will be a list of one leg. 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.
75
+ # Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the &#x60;legs&#x60; list field. If the order is single legged, &#x60;legs&#x60; will be a list of one leg. 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.
84
76
  # @param account_id [String]
77
+ # @param brokerage_order_id [String]
85
78
  # @param user_id [String]
86
79
  # @param user_secret [String]
87
- # @param account_information_get_user_account_order_detail_request [AccountInformationGetUserAccountOrderDetailRequest]
88
80
  # @param [Hash] opts the optional parameters
89
81
  # @return [Array<(AccountOrderRecordV2, Integer, Hash)>] AccountOrderRecordV2 data, response status code and response headers
90
- private def get_user_account_order_detail_v2_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts = {})
82
+ private def get_user_account_order_detail_v2_with_http_info_impl(account_id, brokerage_order_id, user_id, user_secret, opts = {})
91
83
  if @api_client.config.debugging
92
84
  @api_client.config.logger.debug 'Calling API: ExperimentalEndpointsApi.get_user_account_order_detail_v2 ...'
93
85
  end
@@ -95,6 +87,10 @@ module SnapTrade
95
87
  if @api_client.config.client_side_validation && account_id.nil?
96
88
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
97
89
  end
90
+ # verify the required parameter 'brokerage_order_id' is set
91
+ if @api_client.config.client_side_validation && brokerage_order_id.nil?
92
+ fail ArgumentError, "Missing the required parameter 'brokerage_order_id' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
93
+ end
98
94
  # verify the required parameter 'user_id' is set
99
95
  if @api_client.config.client_side_validation && user_id.nil?
100
96
  fail ArgumentError, "Missing the required parameter 'user_id' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
@@ -103,12 +99,8 @@ module SnapTrade
103
99
  if @api_client.config.client_side_validation && user_secret.nil?
104
100
  fail ArgumentError, "Missing the required parameter 'user_secret' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
105
101
  end
106
- # verify the required parameter 'account_information_get_user_account_order_detail_request' is set
107
- if @api_client.config.client_side_validation && account_information_get_user_account_order_detail_request.nil?
108
- fail ArgumentError, "Missing the required parameter 'account_information_get_user_account_order_detail_request' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
109
- end
110
102
  # resource path
111
- local_var_path = '/accounts/{accountId}/orders/details/v2'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
103
+ local_var_path = '/accounts/{accountId}/orders/details/v2/{brokerageOrderId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'brokerageOrderId' + '}', CGI.escape(brokerage_order_id.to_s))
112
104
 
113
105
  # query parameters
114
106
  query_params = opts[:query_params] || {}
@@ -119,17 +111,12 @@ module SnapTrade
119
111
  header_params = opts[:header_params] || {}
120
112
  # HTTP header 'Accept' (if needed)
121
113
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
122
- # HTTP header 'Content-Type'
123
- content_type = @api_client.select_header_content_type(['application/json'])
124
- if !content_type.nil?
125
- header_params['Content-Type'] = content_type
126
- end
127
114
 
128
115
  # form parameters
129
116
  form_params = opts[:form_params] || {}
130
117
 
131
118
  # http body (model)
132
- post_body = opts[:debug_body] || @api_client.object_to_http_body(account_information_get_user_account_order_detail_request)
119
+ post_body = opts[:debug_body]
133
120
 
134
121
  # return_type
135
122
  return_type = opts[:debug_return_type] || 'AccountOrderRecordV2'
@@ -147,7 +134,7 @@ module SnapTrade
147
134
  :return_type => return_type
148
135
  )
149
136
 
150
- data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
137
+ data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
151
138
  if @api_client.config.debugging
152
139
  @api_client.config.logger.debug "API called: ExperimentalEndpointsApi#get_user_account_order_detail_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
153
140
  end
data/lib/snaptrade/api/trading_api.rb CHANGED
@@ -532,6 +532,8 @@ module SnapTrade
532
532
  #
533
533
  # 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.
534
534
  #
535
+ # **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**
536
+ #
535
537
  # This endpoint does not work for options quotes.
536
538
  #
537
539
  # This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
@@ -554,6 +556,8 @@ module SnapTrade
554
556
  #
555
557
  # 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.
556
558
  #
559
+ # **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**
560
+ #
557
561
  # This endpoint does not work for options quotes.
558
562
  #
559
563
  # This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
@@ -570,7 +574,7 @@ module SnapTrade
570
574
  end
571
575
 
572
576
  # Get equity symbol quotes
573
- # 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.
577
+ # 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 is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** 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.
574
578
  # @param user_id [String]
575
579
  # @param user_secret [String]
576
580
  # @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
@@ -584,7 +588,7 @@ module SnapTrade
584
588
  end
585
589
 
586
590
  # Get equity symbol quotes
587
- # 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.
591
+ # 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 is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** 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.
588
592
  # @param user_id [String]
589
593
  # @param user_secret [String]
590
594
  # @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
data/lib/snaptrade/models/tax_lot.rb CHANGED
@@ -31,6 +31,9 @@ module SnapTrade
31
31
  # The type of position for the tax lot (e.g., LONG, SHORT).
32
32
  attr_accessor :position_type
33
33
 
34
+ # The unique id for this specific tax lot
35
+ attr_accessor :lot_id
36
+
34
37
  # Attribute mapping from ruby-style variable name to JSON key.
35
38
  def self.attribute_map
36
39
  {
@@ -39,7 +42,8 @@ module SnapTrade
39
42
  :'purchased_price' => :'purchased_price',
40
43
  :'cost_basis' => :'cost_basis',
41
44
  :'current_value' => :'current_value',
42
- :'position_type' => :'position_type'
45
+ :'position_type' => :'position_type',
46
+ :'lot_id' => :'lot_id'
43
47
  }
44
48
  end
45
49
 
@@ -56,7 +60,8 @@ module SnapTrade
56
60
  :'purchased_price' => :'String',
57
61
  :'cost_basis' => :'String',
58
62
  :'current_value' => :'String',
59
- :'position_type' => :'String'
63
+ :'position_type' => :'String',
64
+ :'lot_id' => :'String'
60
65
  }
61
66
  end
62
67
 
@@ -68,7 +73,8 @@ module SnapTrade
68
73
  :'purchased_price',
69
74
  :'cost_basis',
70
75
  :'current_value',
71
- :'position_type'
76
+ :'position_type',
77
+ :'lot_id'
72
78
  ])
73
79
  end
74
80
 
@@ -110,6 +116,10 @@ module SnapTrade
110
116
  if attributes.key?(:'position_type')
111
117
  self.position_type = attributes[:'position_type']
112
118
  end
119
+
120
+ if attributes.key?(:'lot_id')
121
+ self.lot_id = attributes[:'lot_id']
122
+ end
113
123
  end
114
124
 
115
125
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -135,7 +145,8 @@ module SnapTrade
135
145
  purchased_price == o.purchased_price &&
136
146
  cost_basis == o.cost_basis &&
137
147
  current_value == o.current_value &&
138
- position_type == o.position_type
148
+ position_type == o.position_type &&
149
+ lot_id == o.lot_id
139
150
  end
140
151
 
141
152
  # @see the `==` method
@@ -147,7 +158,7 @@ module SnapTrade
147
158
  # Calculates hash code according to all attributes.
148
159
  # @return [Integer] Hash code
149
160
  def hash
150
- [original_purchase_date, quantity, purchased_price, cost_basis, current_value, position_type].hash
161
+ [original_purchase_date, quantity, purchased_price, cost_basis, current_value, position_type, lot_id].hash
151
162
  end
152
163
 
153
164
  # Builds the object from hash
data/lib/snaptrade/version.rb CHANGED
@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
8
8
  =end
9
9
 
10
10
  module SnapTrade
11
- VERSION = '2.0.160'
11
+ VERSION = '2.0.162'
12
12
  end
data/spec/api/experimental_endpoints_api_spec.rb CHANGED
@@ -29,11 +29,11 @@ describe 'ExperimentalEndpointsApi' do
29
29
 
30
30
  # unit tests for get_user_account_order_detail_v2
31
31
  # Get account order detail (V2)
32
- # Returns the detail of a single order using the external order ID provided in the request body. The V2 order response format includes all legs of the order in the &#x60;legs&#x60; list field. If the order is single legged, &#x60;legs&#x60; will be a list of one leg. 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.
32
+ # Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the &#x60;legs&#x60; list field. If the order is single legged, &#x60;legs&#x60; will be a list of one leg. 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.
33
33
  # @param account_id
34
+ # @param brokerage_order_id
34
35
  # @param user_id
35
36
  # @param user_secret
36
- # @param account_information_get_user_account_order_detail_request
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @return [AccountOrderRecordV2]
39
39
  describe 'get_user_account_order_detail_v2 test' do
data/spec/api/trading_api_spec.rb CHANGED
@@ -88,7 +88,7 @@ describe 'TradingApi' do
88
88
 
89
89
  # unit tests for get_user_account_quotes
90
90
  # Get equity symbol quotes
91
- # 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.
91
+ # 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 is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** 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.
92
92
  # @param user_id
93
93
  # @param user_secret
94
94
  # @param symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
data/spec/models/tax_lot_spec.rb CHANGED
@@ -56,4 +56,10 @@ describe SnapTrade::TaxLot do
56
56
  end
57
57
  end
58
58
 
59
+ describe 'test attribute "lot_id"' do
60
+ it 'should work' do
61
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
62
+ end
63
+ end
64
+
59
65
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: snaptrade
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.160
4
+ version: 2.0.162
5
5
  platform: ruby
6
6
  authors:
7
7
  - SnapTrade
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-02-05 00:00:00.000000000 Z
11
+ date: 2026-02-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -462,177 +462,177 @@ specification_version: 4
462
462
  summary: SnapTrade Ruby Gem
463
463
  test_files:
464
464
  - spec/api/trading_api_spec.rb
465
- - spec/api/options_api_spec.rb
466
465
  - spec/api/api_status_api_spec.rb
466
+ - spec/api/reference_data_api_spec.rb
467
+ - spec/api/options_api_spec.rb
468
+ - spec/api/authentication_api_spec.rb
467
469
  - spec/api/experimental_endpoints_api_spec.rb
470
+ - spec/api/account_information_api_spec.rb
468
471
  - spec/api/connections_api_spec.rb
469
472
  - spec/api/transactions_and_reporting_api_spec.rb
470
- - spec/api/account_information_api_spec.rb
471
- - spec/api/reference_data_api_spec.rb
472
- - spec/api/authentication_api_spec.rb
473
473
  - spec/api_client_spec.rb
474
474
  - spec/configuration_spec.rb
475
475
  - spec/getting_started_spec.rb
476
- - spec/models/options_symbol_spec.rb
477
- - spec/models/crypto_order_preview_estimated_fee_spec.rb
478
- - spec/models/net_dividend_spec.rb
479
- - spec/models/validated_trade_body_spec.rb
480
- - spec/models/strategy_quotes_greek_spec.rb
481
- - spec/models/connection_portal_version_spec.rb
482
- - spec/models/underlying_symbol_spec.rb
483
- - spec/models/monthly_dividends_spec.rb
484
- - spec/models/option_type_spec.rb
485
- - spec/models/account_balance_spec.rb
486
- - spec/models/underlying_symbol_exchange_spec.rb
487
- - spec/models/connection_type_spec.rb
488
- - spec/models/snap_trade_login_user_request_body_spec.rb
489
- - spec/models/rate_of_return_object_spec.rb
490
- - spec/models/performance_custom_spec.rb
491
- - spec/models/account_order_record_quote_currency_spec.rb
492
- - spec/models/option_leg_action_spec.rb
476
+ - spec/models/balance_spec.rb
477
+ - spec/models/symbol_currency_spec.rb
478
+ - spec/models/snap_trade_holdings_account_spec.rb
479
+ - spec/models/login_redirect_uri_spec.rb
480
+ - spec/models/snap_trade_holdings_total_value_spec.rb
481
+ - spec/models/universal_activity_spec.rb
482
+ - spec/models/symbol_spec.rb
483
+ - spec/models/manual_trade_balance_spec.rb
484
+ - spec/models/encrypted_response_encrypted_message_data_spec.rb
485
+ - spec/models/model500_unexpected_exception_response_spec.rb
486
+ - spec/models/take_profit_spec.rb
487
+ - spec/models/account_holdings_spec.rb
488
+ - spec/models/holdings_status_spec.rb
489
+ - spec/models/trading_instrument_type_spec.rb
490
+ - spec/models/mleg_order_type_strict_spec.rb
491
+ - spec/models/account_simple_spec.rb
492
+ - spec/models/brokerage_spec.rb
493
+ - spec/models/account_order_record_quote_universal_symbol_spec.rb
493
494
  - spec/models/simple_order_form_spec.rb
494
- - spec/models/us_exchange_spec.rb
495
- - spec/models/balance_currency_spec.rb
496
- - spec/models/account_universal_activity_spec.rb
495
+ - spec/models/partner_data_spec.rb
496
+ - spec/models/manual_trade_symbol_spec.rb
497
497
  - spec/models/mleg_price_effect_strict_spec.rb
498
- - spec/models/crypto_order_preview_spec.rb
499
- - spec/models/manual_trade_form_with_options_spec.rb
500
- - spec/models/take_profit_spec.rb
501
- - spec/models/crypto_trading_instrument_spec.rb
498
+ - spec/models/strategy_order_record_status_spec.rb
499
+ - spec/models/balance_currency_spec.rb
500
+ - spec/models/cancel_order_response_spec.rb
501
+ - spec/models/symbol_figi_instrument_spec.rb
502
+ - spec/models/account_orders_v2_response_spec.rb
503
+ - spec/models/model401_failed_request_response_spec.rb
504
+ - spec/models/rate_of_return_object_spec.rb
505
+ - spec/models/manual_trade_spec.rb
506
+ - spec/models/timeframe_spec.rb
507
+ - spec/models/brokerage_authorization_spec.rb
508
+ - spec/models/snap_trade_register_user_request_body_spec.rb
509
+ - spec/models/action_strict_with_options_spec.rb
502
510
  - spec/models/transactions_status_spec.rb
503
- - spec/models/manual_trade_and_impact_spec.rb
504
- - spec/models/underlying_symbol_type_spec.rb
511
+ - spec/models/account_order_record_leg_spec.rb
512
+ - spec/models/encrypted_response_spec.rb
505
513
  - spec/models/symbols_quotes_inner_spec.rb
506
- - spec/models/symbol_exchange_spec.rb
507
- - spec/models/manual_trade_form_bracket_spec.rb
508
- - spec/models/snap_trade_holdings_total_value_spec.rb
509
- - spec/models/model402_brokerage_auth_disabled_response_spec.rb
510
- - spec/models/brokerage_authorization_disabled_confirmation_spec.rb
511
- - spec/models/brokerage_spec.rb
512
- - spec/models/manual_trade_symbol_spec.rb
514
+ - spec/models/manual_trade_form_spec.rb
515
+ - spec/models/option_leg_action_spec.rb
516
+ - spec/models/cryptocurrency_pair_quote_spec.rb
517
+ - spec/models/model404_failed_request_response_spec.rb
518
+ - spec/models/mleg_trading_instrument_spec.rb
519
+ - spec/models/options_position_spec.rb
520
+ - spec/models/child_brokerage_order_ids_spec.rb
521
+ - spec/models/manual_trade_replace_form_spec.rb
513
522
  - spec/models/manual_trade_impact_spec.rb
514
- - spec/models/position_spec.rb
515
- - spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
516
- - spec/models/dividend_at_date_spec.rb
517
- - spec/models/trading_search_cryptocurrency_pair_instruments200_response_spec.rb
523
+ - spec/models/net_dividend_spec.rb
524
+ - spec/models/account_balance_spec.rb
525
+ - spec/models/option_chain_inner_spec.rb
526
+ - spec/models/monthly_dividends_spec.rb
527
+ - spec/models/account_order_record_option_symbol_spec.rb
528
+ - spec/models/model402_brokerage_auth_disabled_response_spec.rb
529
+ - spec/models/position_symbol_spec.rb
530
+ - spec/models/account_universal_activity_spec.rb
531
+ - spec/models/brokerage_instruments_response_spec.rb
532
+ - spec/models/manual_trade_and_impact_spec.rb
533
+ - spec/models/brokerage_authorization_type_read_only_spec.rb
534
+ - spec/models/validated_trade_body_spec.rb
535
+ - spec/models/account_order_record_leg_instrument_spec.rb
536
+ - spec/models/universal_symbol_spec.rb
537
+ - spec/models/account_order_record_quote_currency_spec.rb
518
538
  - spec/models/strategy_type_spec.rb
519
- - spec/models/stop_loss_spec.rb
520
- - spec/models/timeframe_spec.rb
521
- - spec/models/crypto_trading_instrument_type_spec.rb
522
- - spec/models/trading_instrument_spec.rb
523
- - spec/models/account_orders_v2_response_spec.rb
524
- - spec/models/order_updated_response_spec.rb
525
- - spec/models/partner_data_spec.rb
539
+ - spec/models/options_position_currency_spec.rb
540
+ - spec/models/currency_spec.rb
526
541
  - spec/models/sub_period_return_rate_spec.rb
527
- - spec/models/mleg_trading_instrument_spec.rb
528
- - spec/models/brokerage_authorization_refresh_confirmation_spec.rb
529
- - spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
530
- - spec/models/account_balance_total_spec.rb
531
- - spec/models/model400_failed_request_response_spec.rb
532
- - spec/models/figi_instrument_spec.rb
533
- - spec/models/manual_trade_replace_form_spec.rb
534
- - spec/models/recent_orders_response_spec.rb
535
- - spec/models/holdings_status_spec.rb
536
- - spec/models/account_spec.rb
537
- - spec/models/option_chain_inner_chain_per_root_inner_spec.rb
538
- - spec/models/manual_trade_form_spec.rb
539
542
  - spec/models/connections_session_events200_response_inner_spec.rb
540
- - spec/models/model425_failed_request_response_spec.rb
541
- - spec/models/symbol_spec.rb
542
- - spec/models/strategy_order_record_status_spec.rb
543
- - spec/models/currency_spec.rb
544
- - spec/models/strategy_quotes_spec.rb
545
- - spec/models/snap_trade_holdings_account_spec.rb
546
- - spec/models/option_chain_inner_spec.rb
547
- - spec/models/exchange_spec.rb
548
- - spec/models/model404_failed_request_response_spec.rb
549
- - spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
543
+ - spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
544
+ - spec/models/position_currency_spec.rb
545
+ - spec/models/brokerage_authorization_refresh_confirmation_spec.rb
546
+ - spec/models/account_order_record_spec.rb
547
+ - spec/models/strategy_quotes_greek_spec.rb
548
+ - spec/models/net_contributions_spec.rb
549
+ - spec/models/mleg_order_response_spec.rb
550
+ - spec/models/manual_trade_form_notional_value_spec.rb
551
+ - spec/models/account_universal_activity_option_symbol_spec.rb
552
+ - spec/models/account_sync_status_spec.rb
553
+ - spec/models/exchange_rate_pairs_spec.rb
554
+ - spec/models/crypto_order_preview_estimated_fee_spec.rb
555
+ - spec/models/account_order_record_status_v2_spec.rb
556
+ - spec/models/crypto_order_preview_spec.rb
557
+ - spec/models/snap_trade_login_user_request_body_spec.rb
558
+ - spec/models/action_strict_spec.rb
559
+ - spec/models/security_type_spec.rb
560
+ - spec/models/cryptocurrency_pair_spec.rb
561
+ - spec/models/account_order_record_universal_symbol_spec.rb
562
+ - spec/models/trading_session_spec.rb
563
+ - spec/models/order_type_strict_spec.rb
564
+ - spec/models/brokerage_authorization_disabled_confirmation_spec.rb
565
+ - spec/models/auth_type_spec.rb
550
566
  - spec/models/notional_value_spec.rb
551
567
  - spec/models/status_spec.rb
552
- - spec/models/universal_activity_spec.rb
553
- - spec/models/session_event_type_spec.rb
554
- - spec/models/mleg_leg_spec.rb
555
- - spec/models/account_order_record_status_v2_spec.rb
556
- - spec/models/brokerage_instrument_spec.rb
557
- - spec/models/account_sync_status_spec.rb
558
- - spec/models/simple_order_form_type_spec.rb
559
- - spec/models/past_value_spec.rb
560
- - spec/models/time_in_force_strict_spec.rb
561
- - spec/models/account_order_record_leg_spec.rb
562
- - spec/models/authentication_login_snap_trade_user200_response_spec.rb
563
- - spec/models/account_order_record_quote_universal_symbol_spec.rb
564
- - spec/models/symbol_figi_instrument_spec.rb
568
+ - spec/models/option_type_spec.rb
565
569
  - spec/models/brokerage_type_spec.rb
566
- - spec/models/mleg_order_type_strict_spec.rb
567
- - spec/models/manual_trade_balance_spec.rb
568
- - spec/models/account_order_record_universal_symbol_spec.rb
569
- - spec/models/account_holdings_account_spec.rb
570
- - spec/models/manual_trade_spec.rb
571
- - spec/models/brokerage_instruments_response_spec.rb
572
- - spec/models/options_position_spec.rb
573
- - spec/models/tax_lot_spec.rb
574
- - spec/models/account_order_record_option_symbol_spec.rb
570
+ - spec/models/dividend_at_date_spec.rb
571
+ - spec/models/brokerage_instrument_spec.rb
575
572
  - spec/models/mleg_action_strict_spec.rb
576
- - spec/models/trading_instrument_type_spec.rb
577
- - spec/models/model401_failed_request_response_spec.rb
578
- - spec/models/mleg_order_response_spec.rb
579
- - spec/models/options_position_currency_spec.rb
580
- - spec/models/universal_symbol_spec.rb
581
573
  - spec/models/crypto_order_form_spec.rb
582
- - spec/models/snap_trade_register_user_request_body_spec.rb
583
- - spec/models/auth_type_spec.rb
584
- - spec/models/mleg_trade_form_spec.rb
585
- - spec/models/option_leg_spec.rb
586
- - spec/models/exchange_rate_pairs_spec.rb
587
- - spec/models/cancel_order_response_spec.rb
588
- - spec/models/login_redirect_uri_spec.rb
589
- - spec/models/account_universal_activity_currency_spec.rb
590
- - spec/models/account_information_get_user_account_order_detail_request_spec.rb
591
- - spec/models/type_spec.rb
592
- - spec/models/order_type_strict_spec.rb
593
- - spec/models/net_contributions_spec.rb
594
- - spec/models/account_status_spec.rb
595
- - spec/models/position_currency_spec.rb
596
- - spec/models/cryptocurrency_pair_spec.rb
597
- - spec/models/cryptocurrency_pair_quote_spec.rb
598
- - spec/models/user_i_dand_secret_spec.rb
599
- - spec/models/brokerage_authorization_type_read_only_spec.rb
600
- - spec/models/security_type_spec.rb
601
- - spec/models/option_brokerage_symbol_spec.rb
602
- - spec/models/model500_unexpected_exception_response_spec.rb
603
- - spec/models/account_universal_activity_option_symbol_spec.rb
604
- - spec/models/account_simple_spec.rb
605
- - spec/models/option_strategy_spec.rb
606
- - spec/models/symbol_query_spec.rb
607
- - spec/models/strategy_order_record_spec.rb
608
- - spec/models/model403_feature_not_enabled_response_spec.rb
609
- - spec/models/trading_session_spec.rb
610
- - spec/models/action_strict_spec.rb
611
- - spec/models/crypto_order_form_type_spec.rb
574
+ - spec/models/figi_instrument_spec.rb
612
575
  - spec/models/pagination_details_spec.rb
613
- - spec/models/session_event_spec.rb
614
- - spec/models/account_holdings_spec.rb
615
- - spec/models/account_order_record_leg_instrument_spec.rb
616
- - spec/models/manual_trade_form_notional_value_spec.rb
617
- - spec/models/option_strategy_legs_inner_spec.rb
618
- - spec/models/brokerage_authorization_spec.rb
619
- - spec/models/crypto_order_form_time_in_force_spec.rb
620
- - spec/models/encrypted_response_encrypted_message_data_spec.rb
621
- - spec/models/account_universal_activity_symbol_spec.rb
622
- - spec/models/paginated_universal_activity_spec.rb
623
- - spec/models/rate_of_return_response_spec.rb
624
- - spec/models/balance_spec.rb
576
+ - spec/models/simple_order_form_time_in_force_spec.rb
577
+ - spec/models/trading_instrument_spec.rb
578
+ - spec/models/strategy_order_record_spec.rb
579
+ - spec/models/performance_custom_spec.rb
580
+ - spec/models/account_status_spec.rb
581
+ - spec/models/manual_trade_form_bracket_spec.rb
625
582
  - spec/models/delete_user_response_spec.rb
626
583
  - spec/models/mleg_instrument_type_spec.rb
627
- - spec/models/account_order_record_spec.rb
628
- - spec/models/action_strict_with_options_spec.rb
629
- - spec/models/simple_order_form_time_in_force_spec.rb
630
- - spec/models/account_order_record_v2_spec.rb
631
- - spec/models/child_brokerage_order_ids_spec.rb
632
- - spec/models/encrypted_response_spec.rb
633
- - spec/models/position_symbol_spec.rb
584
+ - spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
585
+ - spec/models/account_universal_activity_symbol_spec.rb
586
+ - spec/models/symbol_exchange_spec.rb
587
+ - spec/models/past_value_spec.rb
588
+ - spec/models/user_i_dand_secret_spec.rb
589
+ - spec/models/exchange_spec.rb
590
+ - spec/models/account_information_get_user_account_order_detail_request_spec.rb
591
+ - spec/models/underlying_symbol_exchange_spec.rb
592
+ - spec/models/rate_of_return_response_spec.rb
593
+ - spec/models/option_leg_spec.rb
594
+ - spec/models/position_spec.rb
595
+ - spec/models/option_strategy_legs_inner_spec.rb
634
596
  - spec/models/account_order_record_child_brokerage_order_ids_spec.rb
597
+ - spec/models/recent_orders_response_spec.rb
598
+ - spec/models/account_order_record_v2_spec.rb
599
+ - spec/models/model425_failed_request_response_spec.rb
600
+ - spec/models/connection_portal_version_spec.rb
635
601
  - spec/models/model403_failed_request_response_spec.rb
602
+ - spec/models/time_in_force_strict_spec.rb
603
+ - spec/models/option_strategy_spec.rb
604
+ - spec/models/strategy_quotes_spec.rb
605
+ - spec/models/mleg_leg_spec.rb
606
+ - spec/models/option_brokerage_symbol_spec.rb
607
+ - spec/models/type_spec.rb
608
+ - spec/models/us_exchange_spec.rb
609
+ - spec/models/mleg_trade_form_spec.rb
610
+ - spec/models/underlying_symbol_type_spec.rb
611
+ - spec/models/underlying_symbol_spec.rb
612
+ - spec/models/stop_loss_spec.rb
613
+ - spec/models/authentication_login_snap_trade_user200_response_spec.rb
614
+ - spec/models/paginated_universal_activity_spec.rb
615
+ - spec/models/crypto_order_form_time_in_force_spec.rb
616
+ - spec/models/account_universal_activity_currency_spec.rb
617
+ - spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
618
+ - spec/models/trading_search_cryptocurrency_pair_instruments200_response_spec.rb
619
+ - spec/models/manual_trade_form_with_options_spec.rb
620
+ - spec/models/account_balance_total_spec.rb
621
+ - spec/models/options_symbol_spec.rb
622
+ - spec/models/session_event_spec.rb
623
+ - spec/models/account_holdings_account_spec.rb
624
+ - spec/models/crypto_trading_instrument_spec.rb
625
+ - spec/models/symbol_query_spec.rb
636
626
  - spec/models/account_order_record_status_spec.rb
637
- - spec/models/symbol_currency_spec.rb
627
+ - spec/models/account_spec.rb
628
+ - spec/models/crypto_trading_instrument_type_spec.rb
629
+ - spec/models/session_event_type_spec.rb
630
+ - spec/models/model400_failed_request_response_spec.rb
631
+ - spec/models/tax_lot_spec.rb
632
+ - spec/models/simple_order_form_type_spec.rb
633
+ - spec/models/model403_feature_not_enabled_response_spec.rb
634
+ - spec/models/option_chain_inner_chain_per_root_inner_spec.rb
635
+ - spec/models/connection_type_spec.rb
636
+ - spec/models/order_updated_response_spec.rb
637
+ - spec/models/crypto_order_form_type_spec.rb
638
638
  - spec/spec_helper.rb