snaptrade 2.0.158 → 2.0.160

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 208d96ea14724d70f6f3590b860441bd35d0e07701eeaec581d0b1b50f6982a3
-  data.tar.gz: 16f0414d1fc302d6cfcca6bdb76a6ae4a5663602e616ee836293bc50c289e717
+  metadata.gz: 39abef0a80a05056e6158a4188f33e2fdaff4fba0e1d2df65e8a0ac813547676
+  data.tar.gz: c972f3c93167a4380b19db8012a459afb4d2b04d007f7db1b7753dd8a2549d9f
 SHA512:
-  metadata.gz: 1767861bac2258021f487181e064394307103ed53c910ef16e025e9b1de0a4598befa2865b96fd9ef6decd5cd88b0c2302d0e025e476b27ae16bd7f4040afd53
-  data.tar.gz: 52187c8f7505fe08495fe592a1a32a3c7793d0d0efb163cf3d5e91127ab5f44530bfe367e41f956597df8a22188fb3b089051872e8505807e64631d3b9c2597b
+  metadata.gz: cba00b1bdbf83f0eab2124b8694ac57387937a9e71a2e611b96bd4b3d16d2ef512338982371ac54ba4e016b59cd08a03cf723d591c2f2f3c8d8e7637436f4902
+  data.tar.gz: 8157df2d2e6eef61236ad1d2105cda161064ad4661828648992dba12c524f4a092f531a54a7876eabcc7aae35b4024eb4a1dee5e27a58b816cb4ef33a251b99e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.158)
+    snaptrade (2.0.160)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -58,7 +58,7 @@ GEM
     rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.6)
+    rspec-support (3.13.7)
     rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)

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.158-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.158)
+[![npm](https://img.shields.io/badge/gem-v2.0.160-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.160)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -44,6 +44,7 @@ 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.experimental_endpoints.get_user_account_order_detail_v2`](#snaptradeexperimental_endpointsget_user_account_order_detail_v2)
   * [`snaptrade.experimental_endpoints.get_user_account_orders_v2`](#snaptradeexperimental_endpointsget_user_account_orders_v2)
   * [`snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`](#snaptradeexperimental_endpointsget_user_account_recent_orders_v2)
   * [`snaptrade.options.get_options_chain`](#snaptradeoptionsget_options_chain)
@@ -83,7 +84,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.158'
+gem 'snaptrade', '~> 2.0.160'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -467,9 +468,9 @@ p result
 
 ### `snaptrade.account_information.get_user_account_recent_orders`<a id="snaptradeaccount_informationget_user_account_recent_orders"></a>
 
-A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account.
+A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders.
 This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders
-Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days
+Differs from /orders in that it is always realtime, and only checks the last 24 hours
 By default only returns executed orders, but that can be changed by setting *only_executed* to false
 
 
@@ -1128,6 +1129,52 @@ specific users
 ---
 
 
+### `snaptrade.experimental_endpoints.get_user_account_order_detail_v2`<a id="snaptradeexperimental_endpointsget_user_account_order_detail_v2"></a>
+
+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.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.experimental_endpoints.get_user_account_order_detail_v2(
+  brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  user_id: "snaptrade-user-123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+)
+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.
+
+##### account_id: `String`<a id="account_id-string"></a>
+##### user_id: `String`<a id="user_id-string"></a>
+##### user_secret: `String`<a id="user_secret-string"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[AccountOrderRecordV2](./lib/snaptrade/models/account_order_record_v2.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/details/v2` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.experimental_endpoints.get_user_account_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_orders_v2"></a>
 
 Returns a list of recent orders in the specified account.

data/lib/snaptrade/api/account_information_api.rb

@@ -907,9 +907,9 @@ module SnapTrade
 
     # List account recent orders (last 24 hours only)
     #
-    # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account.
+    # A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders.
     # This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders
-    # Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days
+    # Differs from /orders in that it is always realtime, and only checks the last 24 hours
     # By default only returns executed orders, but that can be changed by setting *only_executed* to false
     #
     # @param user_id [String] 
@@ -925,9 +925,9 @@ module SnapTrade
 
     # List account recent orders (last 24 hours only)
     #
-    # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account.
+    # A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders.
     # This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders
-    # Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days
+    # Differs from /orders in that it is always realtime, and only checks the last 24 hours
     # By default only returns executed orders, but that can be changed by setting *only_executed* to false
     #
     # @param user_id [String] 
@@ -941,7 +941,7 @@ module SnapTrade
     end
 
     # List account recent orders (last 24 hours only)
-    # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days By default only returns executed orders, but that can be changed by setting *only_executed* to false 
+    # A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -954,7 +954,7 @@ module SnapTrade
     end
 
     # List account recent orders (last 24 hours only)
-    # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days By default only returns executed orders, but that can be changed by setting *only_executed* to false 
+    # A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 

data/lib/snaptrade/api/experimental_endpoints_api.rb

@@ -17,6 +17,144 @@ module SnapTrade
       @api_client = api_client
     end
 
+    # Get account order detail (V2)
+    #
+    # 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.
+    #
+    # @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    # @param account_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param body [AccountInformationGetUserAccountOrderDetailRequest] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_user_account_order_detail_v2(brokerage_order_id:, account_id:, user_id:, user_secret:, extra: {})
+      _body = {}
+      _body[:brokerage_order_id] = brokerage_order_id if brokerage_order_id != SENTINEL
+      account_information_get_user_account_order_detail_request = _body
+      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)
+      data
+    end
+
+    # Get account order detail (V2)
+    #
+    # 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.
+    #
+    # @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    # @param account_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param body [AccountInformationGetUserAccountOrderDetailRequest] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_user_account_order_detail_v2_with_http_info(brokerage_order_id:, account_id:, user_id:, user_secret:, extra: {})
+      _body = {}
+      _body[:brokerage_order_id] = brokerage_order_id if brokerage_order_id != SENTINEL
+      account_information_get_user_account_order_detail_request = _body
+      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)
+    end
+
+    # Get account order detail (V2)
+    # 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. 
+    # @param account_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_information_get_user_account_order_detail_request [AccountInformationGetUserAccountOrderDetailRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountOrderRecordV2]
+    private def get_user_account_order_detail_v2_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts = {})
+      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)
+      data
+    end
+
+    # Get account order detail (V2)
+    # 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. 
+    # @param account_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_information_get_user_account_order_detail_request [AccountInformationGetUserAccountOrderDetailRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountOrderRecordV2, Integer, Hash)>] AccountOrderRecordV2 data, response status code and response headers
+    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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExperimentalEndpointsApi.get_user_account_order_detail_v2 ...'
+      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 ExperimentalEndpointsApi.get_user_account_order_detail_v2"
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
+      end
+      # verify the required parameter 'user_secret' is set
+      if @api_client.config.client_side_validation && user_secret.nil?
+        fail ArgumentError, "Missing the required parameter 'user_secret' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
+      end
+      # verify the required parameter 'account_information_get_user_account_order_detail_request' is set
+      if @api_client.config.client_side_validation && account_information_get_user_account_order_detail_request.nil?
+        fail ArgumentError, "Missing the required parameter 'account_information_get_user_account_order_detail_request' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
+      end
+      # resource path
+      local_var_path = '/accounts/{accountId}/orders/details/v2'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'userId'] = user_id
+      query_params[:'userSecret'] = user_secret
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_information_get_user_account_order_detail_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountOrderRecordV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"ExperimentalEndpointsApi.get_user_account_order_detail_v2",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExperimentalEndpointsApi#get_user_account_order_detail_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
     # List account orders v2
     #
     # Returns a list of recent orders in the specified account.

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -135,7 +135,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_user_account_recent_orders
   # List account recent orders (last 24 hours only)
-  # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days By default only returns executed orders, but that can be changed by setting *only_executed* to false 
+  # A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false 
   # @param user_id 
   # @param user_secret 
   # @param account_id 

data/spec/api/experimental_endpoints_api_spec.rb

@@ -27,6 +27,21 @@ describe 'ExperimentalEndpointsApi' do
     end
   end
 
+  # unit tests for get_user_account_order_detail_v2
+  # Get account order detail (V2)
+  # 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. 
+  # @param account_id 
+  # @param user_id 
+  # @param user_secret 
+  # @param account_information_get_user_account_order_detail_request 
+  # @param [Hash] opts the optional parameters
+  # @return [AccountOrderRecordV2]
+  describe 'get_user_account_order_detail_v2 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_user_account_orders_v2
   # List account orders v2
   # Returns a list of recent orders in the specified account.  The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.158
+  version: 2.0.160
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-01-27 00:00:00.000000000 Z
+date: 2026-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday