Class: SnapTrade::ExperimentalEndpointsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/snaptrade/api/experimental_endpoints_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExperimentalEndpointsApi

Returns a new instance of ExperimentalEndpointsApi.



16
17
18
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#add_subscription(account_id:, check_interval_seconds:, user_id:, user_secret:, extra: {}) ⇒ Object

Add a Trade Detection subscription

Adds or restores a Trade Detection subscription for a connected brokerage account. This endpoint requires ‘userId` and `userSecret` in addition to the partner signature.

Parameters:

  • account_id (String) —

    Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

  • check_interval_seconds (Integer) —

    How often the subscribed account should be checked for new trades. Must match an active Trade Detection plan.

  • user_id (String)
  • user_secret (String)
  • body (TradeDetectionAddSubscriptionRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



31
32
33
34
35
36
37
38
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 31

def add_subscription(account_id:, check_interval_seconds:, user_id:, user_secret:, extra: {})
  _body = {}
  _body[:account_id] =  if  != SENTINEL
  _body[:check_interval_seconds] = check_interval_seconds if check_interval_seconds != SENTINEL
  trade_detection_add_subscription_request = _body
  data, _status_code, _headers = add_subscription_with_http_info_impl(user_id, user_secret, trade_detection_add_subscription_request, extra)
  data
end

#add_subscription_with_http_info(account_id:, check_interval_seconds:, user_id:, user_secret:, extra: {}) ⇒ Object

Add a Trade Detection subscription

Adds or restores a Trade Detection subscription for a connected brokerage account. This endpoint requires ‘userId` and `userSecret` in addition to the partner signature.

Parameters:

  • account_id (String) —

    Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

  • check_interval_seconds (Integer) —

    How often the subscribed account should be checked for new trades. Must match an active Trade Detection plan.

  • user_id (String)
  • user_secret (String)
  • body (TradeDetectionAddSubscriptionRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



51
52
53
54
55
56
57
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 51

def add_subscription_with_http_info(account_id:, check_interval_seconds:, user_id:, user_secret:, extra: {})
  _body = {}
  _body[:account_id] =  if  != SENTINEL
  _body[:check_interval_seconds] = check_interval_seconds if check_interval_seconds != SENTINEL
  trade_detection_add_subscription_request = _body
  add_subscription_with_http_info_impl(user_id, user_secret, trade_detection_add_subscription_request, extra)
end

#cancel_subscription(account_id:, extra: {}) ⇒ Object

Cancel a Trade Detection subscription

Cancels a Trade Detection subscription for a connected brokerage account. This endpoint requires partner signature authentication only and does not require ‘userId` or `userSecret`.

Parameters:

  • account_id (String) —

    Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

  • body (TradeDetectionCancelSubscriptionRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



150
151
152
153
154
155
156
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 150

def cancel_subscription(account_id:, extra: {})
  _body = {}
  _body[:account_id] =  if  != SENTINEL
  trade_detection_cancel_subscription_request = _body
  data, _status_code, _headers = cancel_subscription_with_http_info_impl(trade_detection_cancel_subscription_request, extra)
  data
end

#cancel_subscription_with_http_info(account_id:, extra: {}) ⇒ Object

Cancel a Trade Detection subscription

Cancels a Trade Detection subscription for a connected brokerage account. This endpoint requires partner signature authentication only and does not require ‘userId` or `userSecret`.

Parameters:

  • account_id (String) —

    Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

  • body (TradeDetectionCancelSubscriptionRequest)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



166
167
168
169
170
171
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 166

def cancel_subscription_with_http_info(account_id:, extra: {})
  _body = {}
  _body[:account_id] =  if  != SENTINEL
  trade_detection_cancel_subscription_request = _body
  cancel_subscription_with_http_info_impl(trade_detection_cancel_subscription_request, extra)
end

#get_user_account_order_detail_v2(account_id:, brokerage_order_id:, user_id:, user_secret:, extra: {}) ⇒ Object

Get account order detail (V2)

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.

Parameters:

  • account_id (String)
  • brokerage_order_id (String)
  • user_id (String)
  • user_secret (String)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



258
259
260
261
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 258

def (account_id:, brokerage_order_id:, user_id:, user_secret:, extra: {})
  data, _status_code, _headers = (, brokerage_order_id, user_id, user_secret, extra)
  data
end

#get_user_account_order_detail_v2_with_http_info(account_id:, brokerage_order_id:, user_id:, user_secret:, extra: {}) ⇒ Object

Get account order detail (V2)

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.

Parameters:

  • account_id (String)
  • brokerage_order_id (String)
  • user_id (String)
  • user_secret (String)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



279
280
281
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 279

def (account_id:, brokerage_order_id:, user_id:, user_secret:, extra: {})
  (, brokerage_order_id, user_id, user_secret, extra)
end

#get_user_account_orders_v2(user_id:, user_secret:, account_id:, state: SENTINEL, days: SENTINEL, extra: {}) ⇒ Object

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.

Parameters:

  • user_id (String)
  • user_secret (String)
  • account_id (String)
  • state (String) (defaults to: SENTINEL) —

    defaults to "all"

  • days (Integer) (defaults to: SENTINEL) —

    Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.

  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



381
382
383
384
385
386
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 381

def (user_id:, user_secret:, account_id:, state: SENTINEL, days: SENTINEL, extra: {})
  extra[:state] = state if state != SENTINEL
  extra[:days] = days if days != SENTINEL
  data, _status_code, _headers = (user_id, user_secret, , extra)
  data
end

#get_user_account_orders_v2_with_http_info(user_id:, user_secret:, account_id:, state: SENTINEL, days: SENTINEL, extra: {}) ⇒ Object

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.

Parameters:

  • user_id (String)
  • user_secret (String)
  • account_id (String)
  • state (String) (defaults to: SENTINEL) —

    defaults to "all"

  • days (Integer) (defaults to: SENTINEL) —

    Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.

  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



402
403
404
405
406
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 402

def (user_id:, user_secret:, account_id:, state: SENTINEL, days: SENTINEL, extra: {})
  extra[:state] = state if state != SENTINEL
  extra[:days] = days if days != SENTINEL
  (user_id, user_secret, , extra)
end

#get_user_account_recent_orders_v2(user_id:, user_secret:, account_id:, only_executed: SENTINEL, extra: {}) ⇒ Object

List account recent orders (V2, last 24 hours only)

A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. 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. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](dashboard.snaptrade.com/settings/billing)**

Parameters:

  • user_id (String)
  • user_secret (String)
  • account_id (String)
  • only_executed (Boolean) (defaults to: SENTINEL) —

    Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well

  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



517
518
519
520
521
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 517

def (user_id:, user_secret:, account_id:, only_executed: SENTINEL, extra: {})
  extra[:only_executed] = only_executed if only_executed != SENTINEL
  data, _status_code, _headers = (user_id, user_secret, , extra)
  data
end

#get_user_account_recent_orders_v2_with_http_info(user_id:, user_secret:, account_id:, only_executed: SENTINEL, extra: {}) ⇒ Object

List account recent orders (V2, last 24 hours only)

A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. 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. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](dashboard.snaptrade.com/settings/billing)**

Parameters:

  • user_id (String)
  • user_secret (String)
  • account_id (String)
  • only_executed (Boolean) (defaults to: SENTINEL) —

    Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well

  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



536
537
538
539
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 536

def (user_id:, user_secret:, account_id:, only_executed: SENTINEL, extra: {})
  extra[:only_executed] = only_executed if only_executed != SENTINEL
  (user_id, user_secret, , extra)
end

#list_subscriptions(extra: {}) ⇒ Object

List active Trade Detection subscriptions

Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.

Parameters:

  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



627
628
629
630
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 627

def list_subscriptions(extra: {})
  data, _status_code, _headers = list_subscriptions_with_http_info_impl(extra)
  data
end

#list_subscriptions_with_http_info(extra: {}) ⇒ Object

List active Trade Detection subscriptions

Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.

Parameters:

  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



637
638
639
 
# File 'lib/snaptrade/api/experimental_endpoints_api.rb', line 637

def list_subscriptions_with_http_info(extra: {})
  list_subscriptions_with_http_info_impl(extra)
end