snaptrade 1.11.0 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +10 -10
- data/Gemfile.lock +13 -11
- data/README.md +220 -218
- data/docs/APIStatusApi.md +57 -57
- data/docs/AccountInformationApi.md +535 -535
- data/docs/AuthenticationApi.md +314 -314
- data/docs/BrokerageSymbol.md +28 -26
- data/docs/BrokerageSymbolOptionSymbol.md +38 -0
- data/docs/BrokerageSymbolSymbol.md +32 -0
- data/docs/ConnectionsApi.md +265 -265
- data/docs/ErrorLogsApi.md +68 -68
- data/docs/OptionsApi.md +378 -378
- data/docs/ReferenceDataApi.md +595 -595
- data/docs/TradingApi.md +478 -478
- data/docs/TransactionsAndReportingApi.md +183 -183
- data/docs/UniversalActivity.md +48 -48
- data/docs/UserIDandSecret.md +20 -20
- data/lib/snaptrade/api/account_information_api.rb +801 -801
- data/lib/snaptrade/api/api_status_api.rb +98 -98
- data/lib/snaptrade/api/authentication_api.rb +481 -481
- data/lib/snaptrade/api/connections_api.rb +398 -398
- data/lib/snaptrade/api/error_logs_api.rb +112 -112
- data/lib/snaptrade/api/options_api.rb +591 -591
- data/lib/snaptrade/api/reference_data_api.rb +894 -894
- data/lib/snaptrade/api/trading_api.rb +741 -741
- data/lib/snaptrade/api/transactions_and_reporting_api.rb +283 -283
- data/lib/snaptrade/api_client.rb +427 -427
- data/lib/snaptrade/api_client_custom.rb +32 -32
- data/lib/snaptrade/api_error.rb +6 -6
- data/lib/snaptrade/configuration.rb +334 -334
- data/lib/snaptrade/models/account.rb +6 -6
- data/lib/snaptrade/models/account_holdings.rb +6 -6
- data/lib/snaptrade/models/account_holdings_account.rb +6 -6
- data/lib/snaptrade/models/account_order_record.rb +6 -6
- data/lib/snaptrade/models/account_order_record_status.rb +6 -6
- data/lib/snaptrade/models/account_simple.rb +6 -6
- data/lib/snaptrade/models/account_sync_status.rb +6 -6
- data/lib/snaptrade/models/action.rb +6 -6
- data/lib/snaptrade/models/auth_type.rb +6 -6
- data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +6 -6
- data/lib/snaptrade/models/balance.rb +6 -6
- data/lib/snaptrade/models/brokerage.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_type.rb +6 -6
- data/lib/snaptrade/models/brokerage_symbol.rb +266 -255
- data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb +316 -0
- data/lib/snaptrade/models/brokerage_symbol_symbol.rb +290 -0
- data/lib/snaptrade/models/brokerage_type.rb +6 -6
- data/lib/snaptrade/models/calculated_trade.rb +6 -6
- data/lib/snaptrade/models/cash_restriction.rb +6 -6
- data/lib/snaptrade/models/connection_type.rb +6 -6
- data/lib/snaptrade/models/connections_session_events200_response_inner.rb +6 -6
- data/lib/snaptrade/models/currency.rb +6 -6
- data/lib/snaptrade/models/delete_user_response.rb +6 -6
- data/lib/snaptrade/models/dividend_at_date.rb +6 -6
- data/lib/snaptrade/models/encrypted_response.rb +6 -6
- data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +6 -6
- data/lib/snaptrade/models/exchange.rb +6 -6
- data/lib/snaptrade/models/exchange_rate_pairs.rb +6 -6
- data/lib/snaptrade/models/excluded_asset.rb +6 -6
- data/lib/snaptrade/models/jwt.rb +6 -6
- data/lib/snaptrade/models/login_redirect_uri.rb +6 -6
- data/lib/snaptrade/models/manual_trade.rb +6 -6
- data/lib/snaptrade/models/manual_trade_and_impact.rb +6 -6
- data/lib/snaptrade/models/manual_trade_balance.rb +6 -6
- data/lib/snaptrade/models/manual_trade_form.rb +6 -6
- data/lib/snaptrade/models/manual_trade_symbol.rb +6 -6
- data/lib/snaptrade/models/model400_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model401_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model403_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model404_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model_asset_class.rb +6 -6
- data/lib/snaptrade/models/model_asset_class_details.rb +6 -6
- data/lib/snaptrade/models/model_asset_class_target.rb +6 -6
- data/lib/snaptrade/models/model_portfolio.rb +6 -6
- data/lib/snaptrade/models/model_portfolio_asset_class.rb +6 -6
- data/lib/snaptrade/models/model_portfolio_details.rb +6 -6
- data/lib/snaptrade/models/model_portfolio_security.rb +6 -6
- data/lib/snaptrade/models/model_type.rb +6 -6
- data/lib/snaptrade/models/monthly_dividends.rb +6 -6
- data/lib/snaptrade/models/net_contributions.rb +6 -6
- data/lib/snaptrade/models/net_dividend.rb +6 -6
- data/lib/snaptrade/models/option_chain_inner.rb +6 -6
- data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +6 -6
- data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +6 -6
- data/lib/snaptrade/models/option_leg.rb +6 -6
- data/lib/snaptrade/models/option_leg_action.rb +6 -6
- data/lib/snaptrade/models/option_strategy.rb +6 -6
- data/lib/snaptrade/models/option_strategy_legs_inner.rb +6 -6
- data/lib/snaptrade/models/options_get_option_strategy_request.rb +6 -6
- data/lib/snaptrade/models/options_holdings.rb +6 -6
- data/lib/snaptrade/models/options_place_option_strategy_request.rb +6 -6
- data/lib/snaptrade/models/options_position.rb +6 -6
- data/lib/snaptrade/models/options_symbol.rb +6 -6
- data/lib/snaptrade/models/order_strategy_execute_body_order_type.rb +6 -6
- data/lib/snaptrade/models/order_strategy_execute_body_time_in_force.rb +6 -6
- data/lib/snaptrade/models/order_type.rb +6 -6
- data/lib/snaptrade/models/partner_data.rb +6 -6
- data/lib/snaptrade/models/past_value.rb +6 -6
- data/lib/snaptrade/models/performance_custom.rb +6 -6
- data/lib/snaptrade/models/portfolio_group.rb +6 -6
- data/lib/snaptrade/models/portfolio_group_info.rb +6 -6
- data/lib/snaptrade/models/portfolio_group_position.rb +6 -6
- data/lib/snaptrade/models/portfolio_group_settings.rb +6 -6
- data/lib/snaptrade/models/position.rb +6 -6
- data/lib/snaptrade/models/position_symbol.rb +6 -6
- data/lib/snaptrade/models/redirect_tokenand_pin.rb +6 -6
- data/lib/snaptrade/models/security_type.rb +6 -6
- data/lib/snaptrade/models/session_event.rb +6 -6
- data/lib/snaptrade/models/session_event_type.rb +6 -6
- data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +6 -6
- data/lib/snaptrade/models/snap_trade_holdings_account.rb +6 -6
- data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +6 -6
- data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +6 -6
- data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +6 -6
- data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +6 -6
- data/lib/snaptrade/models/state.rb +6 -6
- data/lib/snaptrade/models/status.rb +6 -6
- data/lib/snaptrade/models/strategy_impact.rb +6 -6
- data/lib/snaptrade/models/strategy_impact_legs_inner.rb +6 -6
- data/lib/snaptrade/models/strategy_order_place.rb +6 -6
- data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +6 -6
- data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record_order_type.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record_status.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record_time_in_force.rb +6 -6
- data/lib/snaptrade/models/strategy_quotes.rb +6 -6
- data/lib/snaptrade/models/strategy_quotes_greek.rb +6 -6
- data/lib/snaptrade/models/strategy_type.rb +6 -6
- data/lib/snaptrade/models/sub_period_return_rate.rb +6 -6
- data/lib/snaptrade/models/symbol.rb +6 -6
- data/lib/snaptrade/models/symbol_query.rb +6 -6
- data/lib/snaptrade/models/symbols_quotes_inner.rb +6 -6
- data/lib/snaptrade/models/target_asset.rb +6 -6
- data/lib/snaptrade/models/time_in_force.rb +6 -6
- data/lib/snaptrade/models/trade.rb +6 -6
- data/lib/snaptrade/models/trade_action.rb +6 -6
- data/lib/snaptrade/models/trade_execution_status.rb +6 -6
- data/lib/snaptrade/models/trade_execution_status_action.rb +6 -6
- data/lib/snaptrade/models/trade_impact.rb +6 -6
- data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +6 -6
- data/lib/snaptrade/models/trading_place_oco_order_request.rb +6 -6
- data/lib/snaptrade/models/transactions_status.rb +6 -6
- data/lib/snaptrade/models/type.rb +6 -6
- data/lib/snaptrade/models/underlying_symbol.rb +6 -6
- data/lib/snaptrade/models/universal_activity.rb +360 -360
- data/lib/snaptrade/models/universal_symbol.rb +6 -6
- data/lib/snaptrade/models/universal_symbol_ticker.rb +6 -6
- data/lib/snaptrade/models/us_exchange.rb +6 -6
- data/lib/snaptrade/models/user_error_log.rb +6 -6
- data/lib/snaptrade/models/user_i_dand_secret.rb +229 -229
- data/lib/snaptrade/models/user_settings.rb +6 -6
- data/lib/snaptrade/version.rb +13 -13
- data/lib/snaptrade.rb +213 -211
- data/snaptrade.gemspec +41 -41
- data/spec/api/account_information_api_spec.rb +135 -135
- data/spec/api/api_status_api_spec.rb +42 -42
- data/spec/api/authentication_api_spec.rb +88 -88
- data/spec/api/connections_api_spec.rb +82 -82
- data/spec/api/error_logs_api_spec.rb +43 -43
- data/spec/api/options_api_spec.rb +101 -101
- data/spec/api/reference_data_api_spec.rb +150 -150
- data/spec/api/trading_api_spec.rb +112 -112
- data/spec/api/transactions_and_reporting_api_spec.rb +67 -67
- data/spec/api_client_spec.rb +193 -193
- data/spec/configuration_spec.rb +6 -6
- data/spec/getting_started_spec.rb +108 -108
- data/spec/models/account_holdings_account_spec.rb +54 -54
- data/spec/models/account_holdings_spec.rb +48 -48
- data/spec/models/account_order_record_spec.rb +132 -132
- data/spec/models/account_order_record_status_spec.rb +24 -24
- data/spec/models/account_simple_spec.rb +48 -48
- data/spec/models/account_spec.rb +84 -84
- data/spec/models/account_sync_status_spec.rb +30 -30
- data/spec/models/action_spec.rb +24 -24
- data/spec/models/auth_type_spec.rb +24 -24
- data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +27 -27
- data/spec/models/balance_spec.rb +36 -36
- data/spec/models/brokerage_authorization_spec.rb +78 -78
- data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +42 -42
- data/spec/models/brokerage_authorization_type_read_only_spec.rb +48 -48
- data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +24 -24
- data/spec/models/brokerage_authorization_type_spec.rb +30 -30
- data/spec/models/brokerage_authorization_type_type_spec.rb +24 -24
- data/spec/models/brokerage_spec.rb +132 -132
- data/spec/models/brokerage_symbol_option_symbol_spec.rb +90 -0
- data/spec/models/brokerage_symbol_spec.rb +60 -54
- data/spec/models/brokerage_symbol_symbol_spec.rb +72 -0
- data/spec/models/brokerage_type_spec.rb +36 -36
- data/spec/models/calculated_trade_spec.rb +36 -36
- data/spec/models/cash_restriction_spec.rb +54 -54
- data/spec/models/connection_type_spec.rb +24 -24
- data/spec/models/connections_session_events200_response_inner_spec.rb +66 -66
- data/spec/models/currency_spec.rb +42 -42
- data/spec/models/delete_user_response_spec.rb +36 -36
- data/spec/models/dividend_at_date_spec.rb +42 -42
- data/spec/models/encrypted_response_encrypted_message_data_spec.rb +42 -42
- data/spec/models/encrypted_response_spec.rb +36 -36
- data/spec/models/exchange_rate_pairs_spec.rb +42 -42
- data/spec/models/exchange_spec.rb +72 -72
- data/spec/models/excluded_asset_spec.rb +30 -30
- data/spec/models/jwt_spec.rb +30 -30
- data/spec/models/login_redirect_uri_spec.rb +36 -36
- data/spec/models/manual_trade_and_impact_spec.rb +42 -42
- data/spec/models/manual_trade_balance_spec.rb +42 -42
- data/spec/models/manual_trade_form_spec.rb +72 -72
- data/spec/models/manual_trade_spec.rb +72 -72
- data/spec/models/manual_trade_symbol_spec.rb +60 -60
- data/spec/models/model400_failed_request_response_spec.rb +36 -36
- data/spec/models/model401_failed_request_response_spec.rb +36 -36
- data/spec/models/model403_failed_request_response_spec.rb +36 -36
- data/spec/models/model404_failed_request_response_spec.rb +36 -36
- data/spec/models/model_asset_class_details_spec.rb +36 -36
- data/spec/models/model_asset_class_spec.rb +36 -36
- data/spec/models/model_asset_class_target_spec.rb +30 -30
- data/spec/models/model_portfolio_asset_class_spec.rb +36 -36
- data/spec/models/model_portfolio_details_spec.rb +42 -42
- data/spec/models/model_portfolio_security_spec.rb +36 -36
- data/spec/models/model_portfolio_spec.rb +42 -42
- data/spec/models/model_type_spec.rb +24 -24
- data/spec/models/monthly_dividends_spec.rb +36 -36
- data/spec/models/net_contributions_spec.rb +42 -42
- data/spec/models/net_dividend_spec.rb +42 -42
- data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +42 -42
- data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +42 -42
- data/spec/models/option_chain_inner_spec.rb +54 -54
- data/spec/models/option_leg_action_spec.rb +24 -24
- data/spec/models/option_leg_spec.rb +42 -42
- data/spec/models/option_strategy_legs_inner_spec.rb +48 -48
- data/spec/models/option_strategy_spec.rb +54 -54
- data/spec/models/options_get_option_strategy_request_spec.rb +42 -42
- data/spec/models/options_holdings_spec.rb +60 -60
- data/spec/models/options_place_option_strategy_request_spec.rb +42 -42
- data/spec/models/options_position_spec.rb +66 -66
- data/spec/models/options_symbol_spec.rb +90 -90
- data/spec/models/order_strategy_execute_body_order_type_spec.rb +24 -24
- data/spec/models/order_strategy_execute_body_time_in_force_spec.rb +24 -24
- data/spec/models/order_type_spec.rb +24 -24
- data/spec/models/partner_data_spec.rb +96 -96
- data/spec/models/past_value_spec.rb +42 -42
- data/spec/models/performance_custom_spec.rb +138 -138
- data/spec/models/portfolio_group_info_spec.rb +90 -90
- data/spec/models/portfolio_group_position_spec.rb +42 -42
- data/spec/models/portfolio_group_settings_spec.rb +54 -54
- data/spec/models/portfolio_group_spec.rb +36 -36
- data/spec/models/position_spec.rb +60 -60
- data/spec/models/position_symbol_spec.rb +60 -60
- data/spec/models/redirect_tokenand_pin_spec.rb +36 -36
- data/spec/models/security_type_spec.rb +48 -48
- data/spec/models/session_event_spec.rb +66 -66
- data/spec/models/session_event_type_spec.rb +24 -24
- data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +36 -36
- data/spec/models/snap_trade_holdings_account_account_id_spec.rb +78 -78
- data/spec/models/snap_trade_holdings_account_spec.rb +72 -72
- data/spec/models/snap_trade_holdings_total_value_spec.rb +36 -36
- data/spec/models/snap_trade_login_user_request_body_spec.rb +54 -54
- data/spec/models/snap_trade_register_user_request_body_spec.rb +36 -36
- data/spec/models/state_spec.rb +24 -24
- data/spec/models/status_spec.rb +42 -42
- data/spec/models/strategy_impact_legs_inner_spec.rb +66 -66
- data/spec/models/strategy_impact_spec.rb +90 -90
- data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +66 -66
- data/spec/models/strategy_order_place_orders_inner_spec.rb +282 -282
- data/spec/models/strategy_order_place_spec.rb +36 -36
- data/spec/models/strategy_order_record_order_type_spec.rb +24 -24
- data/spec/models/strategy_order_record_spec.rb +90 -90
- data/spec/models/strategy_order_record_status_spec.rb +24 -24
- data/spec/models/strategy_order_record_time_in_force_spec.rb +24 -24
- data/spec/models/strategy_quotes_greek_spec.rb +54 -54
- data/spec/models/strategy_quotes_spec.rb +60 -60
- data/spec/models/strategy_type_spec.rb +24 -24
- data/spec/models/sub_period_return_rate_spec.rb +42 -42
- data/spec/models/symbol_query_spec.rb +30 -30
- data/spec/models/symbol_spec.rb +66 -66
- data/spec/models/symbols_quotes_inner_spec.rb +60 -60
- data/spec/models/target_asset_spec.rb +60 -60
- data/spec/models/time_in_force_spec.rb +24 -24
- data/spec/models/trade_action_spec.rb +24 -24
- data/spec/models/trade_execution_status_action_spec.rb +24 -24
- data/spec/models/trade_execution_status_spec.rb +78 -78
- data/spec/models/trade_impact_spec.rb +54 -54
- data/spec/models/trade_spec.rb +72 -72
- data/spec/models/trading_cancel_user_account_order_request_spec.rb +30 -30
- data/spec/models/trading_place_oco_order_request_spec.rb +36 -36
- data/spec/models/transactions_status_spec.rb +36 -36
- data/spec/models/type_spec.rb +24 -24
- data/spec/models/underlying_symbol_spec.rb +66 -66
- data/spec/models/universal_activity_spec.rb +120 -120
- data/spec/models/universal_symbol_spec.rb +72 -72
- data/spec/models/universal_symbol_ticker_spec.rb +72 -72
- data/spec/models/us_exchange_spec.rb +78 -78
- data/spec/models/user_error_log_spec.rb +60 -60
- data/spec/models/user_i_dand_secret_spec.rb +36 -36
- data/spec/models/user_settings_spec.rb +84 -84
- data/spec/spec_helper.rb +6 -6
- metadata +121 -113
data/docs/ReferenceDataApi.md
CHANGED
@@ -1,595 +1,595 @@
|
|
1
|
-
# SnapTrade::ReferenceDataApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.snaptrade.com/api/v1*
|
4
|
-
|
5
|
-
| Method | HTTP request | Description |
|
6
|
-
| ------ | ------------ | ----------- |
|
7
|
-
| [**get_currency_exchange_rate_pair**](ReferenceDataApi.md#get_currency_exchange_rate_pair) | **GET** /currencies/rates/{currencyPair} | Return the exchange rate of a currency pair |
|
8
|
-
| [**get_partner_info**](ReferenceDataApi.md#get_partner_info) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner |
|
9
|
-
| [**get_security_types**](ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types. |
|
10
|
-
| [**get_stock_exchanges**](ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges |
|
11
|
-
| [**get_symbols**](ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols |
|
12
|
-
| [**get_symbols_by_ticker**](ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker |
|
13
|
-
| [**list_all_brokerage_authorization_type**](ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types |
|
14
|
-
| [**list_all_brokerages**](ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List brokerages |
|
15
|
-
| [**list_all_currencies**](ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List currencies |
|
16
|
-
| [**list_all_currencies_rates**](ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | List currency exchange rates |
|
17
|
-
| [**symbol_search_user_account**](ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols available in an account |
|
18
|
-
|
19
|
-
## get_currency_exchange_rate_pair
|
20
|
-
|
21
|
-
Return the exchange rate of a currency pair
|
22
|
-
|
23
|
-
### Example
|
24
|
-
|
25
|
-
```ruby
|
26
|
-
require 'snaptrade'
|
27
|
-
|
28
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
29
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
30
|
-
|
31
|
-
currency_pair = "currencyPair_example"
|
32
|
-
|
33
|
-
begin
|
34
|
-
# Return the exchange rate of a currency pair
|
35
|
-
result = SnapTrade::ReferenceData.get_currency_exchange_rate_pair(
|
36
|
-
currency_pair: currency_pair,
|
37
|
-
)
|
38
|
-
p result
|
39
|
-
rescue SnapTrade::ApiError => e
|
40
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_currency_exchange_rate_pair: #{e}"
|
41
|
-
end
|
42
|
-
```
|
43
|
-
|
44
|
-
#### Using the get_currency_exchange_rate_pair_with_http_info variant
|
45
|
-
|
46
|
-
This returns an Array which contains the response data, status code and headers.
|
47
|
-
|
48
|
-
```ruby
|
49
|
-
currency_pair = "currencyPair_example"
|
50
|
-
|
51
|
-
begin
|
52
|
-
# Return the exchange rate of a currency pair
|
53
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.get_currency_exchange_rate_pair_with_http_info(
|
54
|
-
currency_pair: currency_pair,
|
55
|
-
)
|
56
|
-
p status_code # => 2xx
|
57
|
-
p headers # => { ... }
|
58
|
-
p data # => ExchangeRatePairs
|
59
|
-
rescue SnapTrade::ApiError => e
|
60
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_currency_exchange_rate_pair: #{e}"
|
61
|
-
end
|
62
|
-
```
|
63
|
-
|
64
|
-
### Parameters
|
65
|
-
|
66
|
-
| Name | Type | Description | Notes |
|
67
|
-
| ---- | ---- | ----------- | ----- |
|
68
|
-
| **currency_pair** | **String** | A currency pair based on currency code for example, {CAD-USD} | |
|
69
|
-
|
70
|
-
### Return type
|
71
|
-
|
72
|
-
[**ExchangeRatePairs**](ExchangeRatePairs.md)
|
73
|
-
|
74
|
-
## get_partner_info
|
75
|
-
|
76
|
-
Get metadata related to Snaptrade partner
|
77
|
-
|
78
|
-
### Example
|
79
|
-
|
80
|
-
```ruby
|
81
|
-
require 'snaptrade'
|
82
|
-
|
83
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
84
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
85
|
-
|
86
|
-
|
87
|
-
begin
|
88
|
-
# Get metadata related to Snaptrade partner
|
89
|
-
result = SnapTrade::ReferenceData.get_partner_info
|
90
|
-
p result
|
91
|
-
rescue SnapTrade::ApiError => e
|
92
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_partner_info: #{e}"
|
93
|
-
end
|
94
|
-
```
|
95
|
-
|
96
|
-
#### Using the get_partner_info_with_http_info variant
|
97
|
-
|
98
|
-
This returns an Array which contains the response data, status code and headers.
|
99
|
-
|
100
|
-
```ruby
|
101
|
-
|
102
|
-
begin
|
103
|
-
# Get metadata related to Snaptrade partner
|
104
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.get_partner_info_with_http_info
|
105
|
-
p status_code # => 2xx
|
106
|
-
p headers # => { ... }
|
107
|
-
p data # => PartnerData
|
108
|
-
rescue SnapTrade::ApiError => e
|
109
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_partner_info: #{e}"
|
110
|
-
end
|
111
|
-
```
|
112
|
-
|
113
|
-
### Parameters
|
114
|
-
|
115
|
-
This endpoint does not need any parameter.
|
116
|
-
|
117
|
-
### Return type
|
118
|
-
|
119
|
-
[**PartnerData**](PartnerData.md)
|
120
|
-
|
121
|
-
## get_security_types
|
122
|
-
|
123
|
-
List of all security types.
|
124
|
-
|
125
|
-
### Example
|
126
|
-
|
127
|
-
```ruby
|
128
|
-
require 'snaptrade'
|
129
|
-
|
130
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
131
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
132
|
-
|
133
|
-
|
134
|
-
begin
|
135
|
-
# List of all security types.
|
136
|
-
result = SnapTrade::ReferenceData.get_security_types
|
137
|
-
p result
|
138
|
-
rescue SnapTrade::ApiError => e
|
139
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_security_types: #{e}"
|
140
|
-
end
|
141
|
-
```
|
142
|
-
|
143
|
-
#### Using the get_security_types_with_http_info variant
|
144
|
-
|
145
|
-
This returns an Array which contains the response data, status code and headers.
|
146
|
-
|
147
|
-
```ruby
|
148
|
-
|
149
|
-
begin
|
150
|
-
# List of all security types.
|
151
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.get_security_types_with_http_info
|
152
|
-
p status_code # => 2xx
|
153
|
-
p headers # => { ... }
|
154
|
-
p data # => Array<SecurityType>
|
155
|
-
rescue SnapTrade::ApiError => e
|
156
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_security_types: #{e}"
|
157
|
-
end
|
158
|
-
```
|
159
|
-
|
160
|
-
### Parameters
|
161
|
-
|
162
|
-
This endpoint does not need any parameter.
|
163
|
-
|
164
|
-
### Return type
|
165
|
-
|
166
|
-
[**Array<SecurityType>**](SecurityType.md)
|
167
|
-
|
168
|
-
## get_stock_exchanges
|
169
|
-
|
170
|
-
List exchanges
|
171
|
-
|
172
|
-
### Example
|
173
|
-
|
174
|
-
```ruby
|
175
|
-
require 'snaptrade'
|
176
|
-
|
177
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
178
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
179
|
-
|
180
|
-
|
181
|
-
begin
|
182
|
-
# List exchanges
|
183
|
-
result = SnapTrade::ReferenceData.get_stock_exchanges
|
184
|
-
p result
|
185
|
-
rescue SnapTrade::ApiError => e
|
186
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_stock_exchanges: #{e}"
|
187
|
-
end
|
188
|
-
```
|
189
|
-
|
190
|
-
#### Using the get_stock_exchanges_with_http_info variant
|
191
|
-
|
192
|
-
This returns an Array which contains the response data, status code and headers.
|
193
|
-
|
194
|
-
```ruby
|
195
|
-
|
196
|
-
begin
|
197
|
-
# List exchanges
|
198
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.get_stock_exchanges_with_http_info
|
199
|
-
p status_code # => 2xx
|
200
|
-
p headers # => { ... }
|
201
|
-
p data # => Array<Exchange>
|
202
|
-
rescue SnapTrade::ApiError => e
|
203
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_stock_exchanges: #{e}"
|
204
|
-
end
|
205
|
-
```
|
206
|
-
|
207
|
-
### Parameters
|
208
|
-
|
209
|
-
This endpoint does not need any parameter.
|
210
|
-
|
211
|
-
### Return type
|
212
|
-
|
213
|
-
[**Array<Exchange>**](Exchange.md)
|
214
|
-
|
215
|
-
## get_symbols
|
216
|
-
|
217
|
-
Search for symbols
|
218
|
-
|
219
|
-
### Example
|
220
|
-
|
221
|
-
```ruby
|
222
|
-
require 'snaptrade'
|
223
|
-
|
224
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
225
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
226
|
-
|
227
|
-
substring = "apple"
|
228
|
-
|
229
|
-
begin
|
230
|
-
# Search for symbols
|
231
|
-
result = SnapTrade::ReferenceData.get_symbols(
|
232
|
-
substring: substring,
|
233
|
-
)
|
234
|
-
p result
|
235
|
-
rescue SnapTrade::ApiError => e
|
236
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_symbols: #{e}"
|
237
|
-
end
|
238
|
-
```
|
239
|
-
|
240
|
-
#### Using the get_symbols_with_http_info variant
|
241
|
-
|
242
|
-
This returns an Array which contains the response data, status code and headers.
|
243
|
-
|
244
|
-
```ruby
|
245
|
-
substring = "apple"
|
246
|
-
|
247
|
-
begin
|
248
|
-
# Search for symbols
|
249
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.get_symbols_with_http_info(
|
250
|
-
substring: substring,
|
251
|
-
)
|
252
|
-
p status_code # => 2xx
|
253
|
-
p headers # => { ... }
|
254
|
-
p data # => Array<UniversalSymbol>
|
255
|
-
rescue SnapTrade::ApiError => e
|
256
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_symbols: #{e}"
|
257
|
-
end
|
258
|
-
```
|
259
|
-
|
260
|
-
### Parameters
|
261
|
-
|
262
|
-
| Name | Type | Description | Notes |
|
263
|
-
| ---- | ---- | ----------- | ----- |
|
264
|
-
| **symbol_query** | [**SymbolQuery**](SymbolQuery.md) | | [optional] |
|
265
|
-
|
266
|
-
### Return type
|
267
|
-
|
268
|
-
[**Array<UniversalSymbol>**](UniversalSymbol.md)
|
269
|
-
|
270
|
-
## get_symbols_by_ticker
|
271
|
-
|
272
|
-
Get details of a symbol by the ticker
|
273
|
-
|
274
|
-
### Example
|
275
|
-
|
276
|
-
```ruby
|
277
|
-
require 'snaptrade'
|
278
|
-
|
279
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
280
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
281
|
-
|
282
|
-
ticker = "ticker_example"
|
283
|
-
symbol_id = "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
284
|
-
|
285
|
-
begin
|
286
|
-
# Get details of a symbol by the ticker
|
287
|
-
result = SnapTrade::ReferenceData.get_symbols_by_ticker(
|
288
|
-
ticker: ticker,
|
289
|
-
symbol_id: symbol_id,
|
290
|
-
)
|
291
|
-
p result
|
292
|
-
rescue SnapTrade::ApiError => e
|
293
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_symbols_by_ticker: #{e}"
|
294
|
-
end
|
295
|
-
```
|
296
|
-
|
297
|
-
#### Using the get_symbols_by_ticker_with_http_info variant
|
298
|
-
|
299
|
-
This returns an Array which contains the response data, status code and headers.
|
300
|
-
|
301
|
-
```ruby
|
302
|
-
ticker = "ticker_example"
|
303
|
-
symbol_id = "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
304
|
-
|
305
|
-
begin
|
306
|
-
# Get details of a symbol by the ticker
|
307
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.get_symbols_by_ticker_with_http_info(
|
308
|
-
ticker: ticker,
|
309
|
-
symbol_id: symbol_id,
|
310
|
-
)
|
311
|
-
p status_code # => 2xx
|
312
|
-
p headers # => { ... }
|
313
|
-
p data # => UniversalSymbol
|
314
|
-
rescue SnapTrade::ApiError => e
|
315
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_symbols_by_ticker: #{e}"
|
316
|
-
end
|
317
|
-
```
|
318
|
-
|
319
|
-
### Parameters
|
320
|
-
|
321
|
-
| Name | Type | Description | Notes |
|
322
|
-
| ---- | ---- | ----------- | ----- |
|
323
|
-
| **ticker** | **String** | The ticker of the UniversalSymbol to get. | |
|
324
|
-
| **symbol_id** | **String** | OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get. | [optional] |
|
325
|
-
|
326
|
-
### Return type
|
327
|
-
|
328
|
-
[**UniversalSymbol**](UniversalSymbol.md)
|
329
|
-
|
330
|
-
## list_all_brokerage_authorization_type
|
331
|
-
|
332
|
-
List of all brokerage authorization types
|
333
|
-
|
334
|
-
### Example
|
335
|
-
|
336
|
-
```ruby
|
337
|
-
require 'snaptrade'
|
338
|
-
|
339
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
340
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
341
|
-
|
342
|
-
brokerage = "QUESTRADE,ALPACA"
|
343
|
-
|
344
|
-
begin
|
345
|
-
# List of all brokerage authorization types
|
346
|
-
result = SnapTrade::ReferenceData.list_all_brokerage_authorization_type(
|
347
|
-
brokerage: brokerage,
|
348
|
-
)
|
349
|
-
p result
|
350
|
-
rescue SnapTrade::ApiError => e
|
351
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerage_authorization_type: #{e}"
|
352
|
-
end
|
353
|
-
```
|
354
|
-
|
355
|
-
#### Using the list_all_brokerage_authorization_type_with_http_info variant
|
356
|
-
|
357
|
-
This returns an Array which contains the response data, status code and headers.
|
358
|
-
|
359
|
-
```ruby
|
360
|
-
brokerage = "QUESTRADE,ALPACA"
|
361
|
-
|
362
|
-
begin
|
363
|
-
# List of all brokerage authorization types
|
364
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_brokerage_authorization_type_with_http_info(
|
365
|
-
brokerage: brokerage,
|
366
|
-
)
|
367
|
-
p status_code # => 2xx
|
368
|
-
p headers # => { ... }
|
369
|
-
p data # => Array<BrokerageAuthorizationTypeReadOnly>
|
370
|
-
rescue SnapTrade::ApiError => e
|
371
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerage_authorization_type: #{e}"
|
372
|
-
end
|
373
|
-
```
|
374
|
-
|
375
|
-
### Parameters
|
376
|
-
|
377
|
-
| Name | Type | Description | Notes |
|
378
|
-
| ---- | ---- | ----------- | ----- |
|
379
|
-
| **brokerage** | **String** | Comma separated value of brokerage slugs | [optional] |
|
380
|
-
|
381
|
-
### Return type
|
382
|
-
|
383
|
-
[**Array<BrokerageAuthorizationTypeReadOnly>**](BrokerageAuthorizationTypeReadOnly.md)
|
384
|
-
|
385
|
-
## list_all_brokerages
|
386
|
-
|
387
|
-
List brokerages
|
388
|
-
|
389
|
-
### Example
|
390
|
-
|
391
|
-
```ruby
|
392
|
-
require 'snaptrade'
|
393
|
-
|
394
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
395
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
396
|
-
|
397
|
-
|
398
|
-
begin
|
399
|
-
# List brokerages
|
400
|
-
result = SnapTrade::ReferenceData.list_all_brokerages
|
401
|
-
p result
|
402
|
-
rescue SnapTrade::ApiError => e
|
403
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerages: #{e}"
|
404
|
-
end
|
405
|
-
```
|
406
|
-
|
407
|
-
#### Using the list_all_brokerages_with_http_info variant
|
408
|
-
|
409
|
-
This returns an Array which contains the response data, status code and headers.
|
410
|
-
|
411
|
-
```ruby
|
412
|
-
|
413
|
-
begin
|
414
|
-
# List brokerages
|
415
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_brokerages_with_http_info
|
416
|
-
p status_code # => 2xx
|
417
|
-
p headers # => { ... }
|
418
|
-
p data # => Array<Brokerage>
|
419
|
-
rescue SnapTrade::ApiError => e
|
420
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerages: #{e}"
|
421
|
-
end
|
422
|
-
```
|
423
|
-
|
424
|
-
### Parameters
|
425
|
-
|
426
|
-
This endpoint does not need any parameter.
|
427
|
-
|
428
|
-
### Return type
|
429
|
-
|
430
|
-
[**Array<Brokerage>**](Brokerage.md)
|
431
|
-
|
432
|
-
## list_all_currencies
|
433
|
-
|
434
|
-
List currencies
|
435
|
-
|
436
|
-
### Example
|
437
|
-
|
438
|
-
```ruby
|
439
|
-
require 'snaptrade'
|
440
|
-
|
441
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
442
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
443
|
-
|
444
|
-
|
445
|
-
begin
|
446
|
-
# List currencies
|
447
|
-
result = SnapTrade::ReferenceData.list_all_currencies
|
448
|
-
p result
|
449
|
-
rescue SnapTrade::ApiError => e
|
450
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies: #{e}"
|
451
|
-
end
|
452
|
-
```
|
453
|
-
|
454
|
-
#### Using the list_all_currencies_with_http_info variant
|
455
|
-
|
456
|
-
This returns an Array which contains the response data, status code and headers.
|
457
|
-
|
458
|
-
```ruby
|
459
|
-
|
460
|
-
begin
|
461
|
-
# List currencies
|
462
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_currencies_with_http_info
|
463
|
-
p status_code # => 2xx
|
464
|
-
p headers # => { ... }
|
465
|
-
p data # => Array<Currency>
|
466
|
-
rescue SnapTrade::ApiError => e
|
467
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies: #{e}"
|
468
|
-
end
|
469
|
-
```
|
470
|
-
|
471
|
-
### Parameters
|
472
|
-
|
473
|
-
This endpoint does not need any parameter.
|
474
|
-
|
475
|
-
### Return type
|
476
|
-
|
477
|
-
[**Array<Currency>**](Currency.md)
|
478
|
-
|
479
|
-
## list_all_currencies_rates
|
480
|
-
|
481
|
-
List currency exchange rates
|
482
|
-
|
483
|
-
### Example
|
484
|
-
|
485
|
-
```ruby
|
486
|
-
require 'snaptrade'
|
487
|
-
|
488
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
489
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
490
|
-
|
491
|
-
|
492
|
-
begin
|
493
|
-
# List currency exchange rates
|
494
|
-
result = SnapTrade::ReferenceData.list_all_currencies_rates
|
495
|
-
p result
|
496
|
-
rescue SnapTrade::ApiError => e
|
497
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies_rates: #{e}"
|
498
|
-
end
|
499
|
-
```
|
500
|
-
|
501
|
-
#### Using the list_all_currencies_rates_with_http_info variant
|
502
|
-
|
503
|
-
This returns an Array which contains the response data, status code and headers.
|
504
|
-
|
505
|
-
```ruby
|
506
|
-
|
507
|
-
begin
|
508
|
-
# List currency exchange rates
|
509
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_currencies_rates_with_http_info
|
510
|
-
p status_code # => 2xx
|
511
|
-
p headers # => { ... }
|
512
|
-
p data # => Array<ExchangeRatePairs>
|
513
|
-
rescue SnapTrade::ApiError => e
|
514
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies_rates: #{e}"
|
515
|
-
end
|
516
|
-
```
|
517
|
-
|
518
|
-
### Parameters
|
519
|
-
|
520
|
-
This endpoint does not need any parameter.
|
521
|
-
|
522
|
-
### Return type
|
523
|
-
|
524
|
-
[**Array<ExchangeRatePairs>**](ExchangeRatePairs.md)
|
525
|
-
|
526
|
-
## symbol_search_user_account
|
527
|
-
|
528
|
-
Search for symbols available in an account
|
529
|
-
|
530
|
-
### Example
|
531
|
-
|
532
|
-
```ruby
|
533
|
-
require 'snaptrade'
|
534
|
-
|
535
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
536
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
537
|
-
|
538
|
-
user_id = "John.doe@snaptrade.com"
|
539
|
-
user_secret = "USERSECRET123"
|
540
|
-
account_id = "accountId_example"
|
541
|
-
substring = "apple"
|
542
|
-
|
543
|
-
begin
|
544
|
-
# Search for symbols available in an account
|
545
|
-
result = SnapTrade::ReferenceData.symbol_search_user_account(
|
546
|
-
user_id: user_id,
|
547
|
-
user_secret: user_secret,
|
548
|
-
account_id: account_id,
|
549
|
-
substring: substring,
|
550
|
-
)
|
551
|
-
p result
|
552
|
-
rescue SnapTrade::ApiError => e
|
553
|
-
puts "Exception when calling SnapTrade::ReferenceData.symbol_search_user_account: #{e}"
|
554
|
-
end
|
555
|
-
```
|
556
|
-
|
557
|
-
#### Using the symbol_search_user_account_with_http_info variant
|
558
|
-
|
559
|
-
This returns an Array which contains the response data, status code and headers.
|
560
|
-
|
561
|
-
```ruby
|
562
|
-
user_id = "John.doe@snaptrade.com"
|
563
|
-
user_secret = "USERSECRET123"
|
564
|
-
account_id = "accountId_example"
|
565
|
-
substring = "apple"
|
566
|
-
|
567
|
-
begin
|
568
|
-
# Search for symbols available in an account
|
569
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.symbol_search_user_account_with_http_info(
|
570
|
-
user_id: user_id,
|
571
|
-
user_secret: user_secret,
|
572
|
-
account_id: account_id,
|
573
|
-
substring: substring,
|
574
|
-
)
|
575
|
-
p status_code # => 2xx
|
576
|
-
p headers # => { ... }
|
577
|
-
p data # => Array<UniversalSymbol>
|
578
|
-
rescue SnapTrade::ApiError => e
|
579
|
-
puts "Exception when calling SnapTrade::ReferenceData.symbol_search_user_account: #{e}"
|
580
|
-
end
|
581
|
-
```
|
582
|
-
|
583
|
-
### Parameters
|
584
|
-
|
585
|
-
| Name | Type | Description | Notes |
|
586
|
-
| ---- | ---- | ----------- | ----- |
|
587
|
-
| **user_id** | **String** | | |
|
588
|
-
| **user_secret** | **String** | | |
|
589
|
-
| **account_id** | **String** | The ID of the account get positions. | |
|
590
|
-
| **symbol_query** | [**SymbolQuery**](SymbolQuery.md) | | [optional] |
|
591
|
-
|
592
|
-
### Return type
|
593
|
-
|
594
|
-
[**Array<UniversalSymbol>**](UniversalSymbol.md)
|
595
|
-
|
1
|
+
# SnapTrade::ReferenceDataApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.snaptrade.com/api/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_currency_exchange_rate_pair**](ReferenceDataApi.md#get_currency_exchange_rate_pair) | **GET** /currencies/rates/{currencyPair} | Return the exchange rate of a currency pair |
|
8
|
+
| [**get_partner_info**](ReferenceDataApi.md#get_partner_info) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner |
|
9
|
+
| [**get_security_types**](ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types. |
|
10
|
+
| [**get_stock_exchanges**](ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges |
|
11
|
+
| [**get_symbols**](ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols |
|
12
|
+
| [**get_symbols_by_ticker**](ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker |
|
13
|
+
| [**list_all_brokerage_authorization_type**](ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types |
|
14
|
+
| [**list_all_brokerages**](ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List brokerages |
|
15
|
+
| [**list_all_currencies**](ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List currencies |
|
16
|
+
| [**list_all_currencies_rates**](ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | List currency exchange rates |
|
17
|
+
| [**symbol_search_user_account**](ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols available in an account |
|
18
|
+
|
19
|
+
## get_currency_exchange_rate_pair
|
20
|
+
|
21
|
+
Return the exchange rate of a currency pair
|
22
|
+
|
23
|
+
### Example
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'snaptrade'
|
27
|
+
|
28
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
29
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
30
|
+
|
31
|
+
currency_pair = "currencyPair_example"
|
32
|
+
|
33
|
+
begin
|
34
|
+
# Return the exchange rate of a currency pair
|
35
|
+
result = SnapTrade::ReferenceData.get_currency_exchange_rate_pair(
|
36
|
+
currency_pair: currency_pair,
|
37
|
+
)
|
38
|
+
p result
|
39
|
+
rescue SnapTrade::ApiError => e
|
40
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_currency_exchange_rate_pair: #{e}"
|
41
|
+
end
|
42
|
+
```
|
43
|
+
|
44
|
+
#### Using the get_currency_exchange_rate_pair_with_http_info variant
|
45
|
+
|
46
|
+
This returns an Array which contains the response data, status code and headers.
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
currency_pair = "currencyPair_example"
|
50
|
+
|
51
|
+
begin
|
52
|
+
# Return the exchange rate of a currency pair
|
53
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.get_currency_exchange_rate_pair_with_http_info(
|
54
|
+
currency_pair: currency_pair,
|
55
|
+
)
|
56
|
+
p status_code # => 2xx
|
57
|
+
p headers # => { ... }
|
58
|
+
p data # => ExchangeRatePairs
|
59
|
+
rescue SnapTrade::ApiError => e
|
60
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_currency_exchange_rate_pair: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
| Name | Type | Description | Notes |
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
68
|
+
| **currency_pair** | **String** | A currency pair based on currency code for example, {CAD-USD} | |
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**ExchangeRatePairs**](ExchangeRatePairs.md)
|
73
|
+
|
74
|
+
## get_partner_info
|
75
|
+
|
76
|
+
Get metadata related to Snaptrade partner
|
77
|
+
|
78
|
+
### Example
|
79
|
+
|
80
|
+
```ruby
|
81
|
+
require 'snaptrade'
|
82
|
+
|
83
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
84
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
85
|
+
|
86
|
+
|
87
|
+
begin
|
88
|
+
# Get metadata related to Snaptrade partner
|
89
|
+
result = SnapTrade::ReferenceData.get_partner_info
|
90
|
+
p result
|
91
|
+
rescue SnapTrade::ApiError => e
|
92
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_partner_info: #{e}"
|
93
|
+
end
|
94
|
+
```
|
95
|
+
|
96
|
+
#### Using the get_partner_info_with_http_info variant
|
97
|
+
|
98
|
+
This returns an Array which contains the response data, status code and headers.
|
99
|
+
|
100
|
+
```ruby
|
101
|
+
|
102
|
+
begin
|
103
|
+
# Get metadata related to Snaptrade partner
|
104
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.get_partner_info_with_http_info
|
105
|
+
p status_code # => 2xx
|
106
|
+
p headers # => { ... }
|
107
|
+
p data # => PartnerData
|
108
|
+
rescue SnapTrade::ApiError => e
|
109
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_partner_info: #{e}"
|
110
|
+
end
|
111
|
+
```
|
112
|
+
|
113
|
+
### Parameters
|
114
|
+
|
115
|
+
This endpoint does not need any parameter.
|
116
|
+
|
117
|
+
### Return type
|
118
|
+
|
119
|
+
[**PartnerData**](PartnerData.md)
|
120
|
+
|
121
|
+
## get_security_types
|
122
|
+
|
123
|
+
List of all security types.
|
124
|
+
|
125
|
+
### Example
|
126
|
+
|
127
|
+
```ruby
|
128
|
+
require 'snaptrade'
|
129
|
+
|
130
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
131
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
132
|
+
|
133
|
+
|
134
|
+
begin
|
135
|
+
# List of all security types.
|
136
|
+
result = SnapTrade::ReferenceData.get_security_types
|
137
|
+
p result
|
138
|
+
rescue SnapTrade::ApiError => e
|
139
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_security_types: #{e}"
|
140
|
+
end
|
141
|
+
```
|
142
|
+
|
143
|
+
#### Using the get_security_types_with_http_info variant
|
144
|
+
|
145
|
+
This returns an Array which contains the response data, status code and headers.
|
146
|
+
|
147
|
+
```ruby
|
148
|
+
|
149
|
+
begin
|
150
|
+
# List of all security types.
|
151
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.get_security_types_with_http_info
|
152
|
+
p status_code # => 2xx
|
153
|
+
p headers # => { ... }
|
154
|
+
p data # => Array<SecurityType>
|
155
|
+
rescue SnapTrade::ApiError => e
|
156
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_security_types: #{e}"
|
157
|
+
end
|
158
|
+
```
|
159
|
+
|
160
|
+
### Parameters
|
161
|
+
|
162
|
+
This endpoint does not need any parameter.
|
163
|
+
|
164
|
+
### Return type
|
165
|
+
|
166
|
+
[**Array<SecurityType>**](SecurityType.md)
|
167
|
+
|
168
|
+
## get_stock_exchanges
|
169
|
+
|
170
|
+
List exchanges
|
171
|
+
|
172
|
+
### Example
|
173
|
+
|
174
|
+
```ruby
|
175
|
+
require 'snaptrade'
|
176
|
+
|
177
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
178
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
179
|
+
|
180
|
+
|
181
|
+
begin
|
182
|
+
# List exchanges
|
183
|
+
result = SnapTrade::ReferenceData.get_stock_exchanges
|
184
|
+
p result
|
185
|
+
rescue SnapTrade::ApiError => e
|
186
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_stock_exchanges: #{e}"
|
187
|
+
end
|
188
|
+
```
|
189
|
+
|
190
|
+
#### Using the get_stock_exchanges_with_http_info variant
|
191
|
+
|
192
|
+
This returns an Array which contains the response data, status code and headers.
|
193
|
+
|
194
|
+
```ruby
|
195
|
+
|
196
|
+
begin
|
197
|
+
# List exchanges
|
198
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.get_stock_exchanges_with_http_info
|
199
|
+
p status_code # => 2xx
|
200
|
+
p headers # => { ... }
|
201
|
+
p data # => Array<Exchange>
|
202
|
+
rescue SnapTrade::ApiError => e
|
203
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_stock_exchanges: #{e}"
|
204
|
+
end
|
205
|
+
```
|
206
|
+
|
207
|
+
### Parameters
|
208
|
+
|
209
|
+
This endpoint does not need any parameter.
|
210
|
+
|
211
|
+
### Return type
|
212
|
+
|
213
|
+
[**Array<Exchange>**](Exchange.md)
|
214
|
+
|
215
|
+
## get_symbols
|
216
|
+
|
217
|
+
Search for symbols
|
218
|
+
|
219
|
+
### Example
|
220
|
+
|
221
|
+
```ruby
|
222
|
+
require 'snaptrade'
|
223
|
+
|
224
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
225
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
226
|
+
|
227
|
+
substring = "apple"
|
228
|
+
|
229
|
+
begin
|
230
|
+
# Search for symbols
|
231
|
+
result = SnapTrade::ReferenceData.get_symbols(
|
232
|
+
substring: substring,
|
233
|
+
)
|
234
|
+
p result
|
235
|
+
rescue SnapTrade::ApiError => e
|
236
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_symbols: #{e}"
|
237
|
+
end
|
238
|
+
```
|
239
|
+
|
240
|
+
#### Using the get_symbols_with_http_info variant
|
241
|
+
|
242
|
+
This returns an Array which contains the response data, status code and headers.
|
243
|
+
|
244
|
+
```ruby
|
245
|
+
substring = "apple"
|
246
|
+
|
247
|
+
begin
|
248
|
+
# Search for symbols
|
249
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.get_symbols_with_http_info(
|
250
|
+
substring: substring,
|
251
|
+
)
|
252
|
+
p status_code # => 2xx
|
253
|
+
p headers # => { ... }
|
254
|
+
p data # => Array<UniversalSymbol>
|
255
|
+
rescue SnapTrade::ApiError => e
|
256
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_symbols: #{e}"
|
257
|
+
end
|
258
|
+
```
|
259
|
+
|
260
|
+
### Parameters
|
261
|
+
|
262
|
+
| Name | Type | Description | Notes |
|
263
|
+
| ---- | ---- | ----------- | ----- |
|
264
|
+
| **symbol_query** | [**SymbolQuery**](SymbolQuery.md) | | [optional] |
|
265
|
+
|
266
|
+
### Return type
|
267
|
+
|
268
|
+
[**Array<UniversalSymbol>**](UniversalSymbol.md)
|
269
|
+
|
270
|
+
## get_symbols_by_ticker
|
271
|
+
|
272
|
+
Get details of a symbol by the ticker
|
273
|
+
|
274
|
+
### Example
|
275
|
+
|
276
|
+
```ruby
|
277
|
+
require 'snaptrade'
|
278
|
+
|
279
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
280
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
281
|
+
|
282
|
+
ticker = "ticker_example"
|
283
|
+
symbol_id = "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
284
|
+
|
285
|
+
begin
|
286
|
+
# Get details of a symbol by the ticker
|
287
|
+
result = SnapTrade::ReferenceData.get_symbols_by_ticker(
|
288
|
+
ticker: ticker,
|
289
|
+
symbol_id: symbol_id,
|
290
|
+
)
|
291
|
+
p result
|
292
|
+
rescue SnapTrade::ApiError => e
|
293
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_symbols_by_ticker: #{e}"
|
294
|
+
end
|
295
|
+
```
|
296
|
+
|
297
|
+
#### Using the get_symbols_by_ticker_with_http_info variant
|
298
|
+
|
299
|
+
This returns an Array which contains the response data, status code and headers.
|
300
|
+
|
301
|
+
```ruby
|
302
|
+
ticker = "ticker_example"
|
303
|
+
symbol_id = "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
304
|
+
|
305
|
+
begin
|
306
|
+
# Get details of a symbol by the ticker
|
307
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.get_symbols_by_ticker_with_http_info(
|
308
|
+
ticker: ticker,
|
309
|
+
symbol_id: symbol_id,
|
310
|
+
)
|
311
|
+
p status_code # => 2xx
|
312
|
+
p headers # => { ... }
|
313
|
+
p data # => UniversalSymbol
|
314
|
+
rescue SnapTrade::ApiError => e
|
315
|
+
puts "Exception when calling SnapTrade::ReferenceData.get_symbols_by_ticker: #{e}"
|
316
|
+
end
|
317
|
+
```
|
318
|
+
|
319
|
+
### Parameters
|
320
|
+
|
321
|
+
| Name | Type | Description | Notes |
|
322
|
+
| ---- | ---- | ----------- | ----- |
|
323
|
+
| **ticker** | **String** | The ticker of the UniversalSymbol to get. | |
|
324
|
+
| **symbol_id** | **String** | OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get. | [optional] |
|
325
|
+
|
326
|
+
### Return type
|
327
|
+
|
328
|
+
[**UniversalSymbol**](UniversalSymbol.md)
|
329
|
+
|
330
|
+
## list_all_brokerage_authorization_type
|
331
|
+
|
332
|
+
List of all brokerage authorization types
|
333
|
+
|
334
|
+
### Example
|
335
|
+
|
336
|
+
```ruby
|
337
|
+
require 'snaptrade'
|
338
|
+
|
339
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
340
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
341
|
+
|
342
|
+
brokerage = "QUESTRADE,ALPACA"
|
343
|
+
|
344
|
+
begin
|
345
|
+
# List of all brokerage authorization types
|
346
|
+
result = SnapTrade::ReferenceData.list_all_brokerage_authorization_type(
|
347
|
+
brokerage: brokerage,
|
348
|
+
)
|
349
|
+
p result
|
350
|
+
rescue SnapTrade::ApiError => e
|
351
|
+
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerage_authorization_type: #{e}"
|
352
|
+
end
|
353
|
+
```
|
354
|
+
|
355
|
+
#### Using the list_all_brokerage_authorization_type_with_http_info variant
|
356
|
+
|
357
|
+
This returns an Array which contains the response data, status code and headers.
|
358
|
+
|
359
|
+
```ruby
|
360
|
+
brokerage = "QUESTRADE,ALPACA"
|
361
|
+
|
362
|
+
begin
|
363
|
+
# List of all brokerage authorization types
|
364
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_brokerage_authorization_type_with_http_info(
|
365
|
+
brokerage: brokerage,
|
366
|
+
)
|
367
|
+
p status_code # => 2xx
|
368
|
+
p headers # => { ... }
|
369
|
+
p data # => Array<BrokerageAuthorizationTypeReadOnly>
|
370
|
+
rescue SnapTrade::ApiError => e
|
371
|
+
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerage_authorization_type: #{e}"
|
372
|
+
end
|
373
|
+
```
|
374
|
+
|
375
|
+
### Parameters
|
376
|
+
|
377
|
+
| Name | Type | Description | Notes |
|
378
|
+
| ---- | ---- | ----------- | ----- |
|
379
|
+
| **brokerage** | **String** | Comma separated value of brokerage slugs | [optional] |
|
380
|
+
|
381
|
+
### Return type
|
382
|
+
|
383
|
+
[**Array<BrokerageAuthorizationTypeReadOnly>**](BrokerageAuthorizationTypeReadOnly.md)
|
384
|
+
|
385
|
+
## list_all_brokerages
|
386
|
+
|
387
|
+
List brokerages
|
388
|
+
|
389
|
+
### Example
|
390
|
+
|
391
|
+
```ruby
|
392
|
+
require 'snaptrade'
|
393
|
+
|
394
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
395
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
396
|
+
|
397
|
+
|
398
|
+
begin
|
399
|
+
# List brokerages
|
400
|
+
result = SnapTrade::ReferenceData.list_all_brokerages
|
401
|
+
p result
|
402
|
+
rescue SnapTrade::ApiError => e
|
403
|
+
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerages: #{e}"
|
404
|
+
end
|
405
|
+
```
|
406
|
+
|
407
|
+
#### Using the list_all_brokerages_with_http_info variant
|
408
|
+
|
409
|
+
This returns an Array which contains the response data, status code and headers.
|
410
|
+
|
411
|
+
```ruby
|
412
|
+
|
413
|
+
begin
|
414
|
+
# List brokerages
|
415
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_brokerages_with_http_info
|
416
|
+
p status_code # => 2xx
|
417
|
+
p headers # => { ... }
|
418
|
+
p data # => Array<Brokerage>
|
419
|
+
rescue SnapTrade::ApiError => e
|
420
|
+
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerages: #{e}"
|
421
|
+
end
|
422
|
+
```
|
423
|
+
|
424
|
+
### Parameters
|
425
|
+
|
426
|
+
This endpoint does not need any parameter.
|
427
|
+
|
428
|
+
### Return type
|
429
|
+
|
430
|
+
[**Array<Brokerage>**](Brokerage.md)
|
431
|
+
|
432
|
+
## list_all_currencies
|
433
|
+
|
434
|
+
List currencies
|
435
|
+
|
436
|
+
### Example
|
437
|
+
|
438
|
+
```ruby
|
439
|
+
require 'snaptrade'
|
440
|
+
|
441
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
442
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
443
|
+
|
444
|
+
|
445
|
+
begin
|
446
|
+
# List currencies
|
447
|
+
result = SnapTrade::ReferenceData.list_all_currencies
|
448
|
+
p result
|
449
|
+
rescue SnapTrade::ApiError => e
|
450
|
+
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies: #{e}"
|
451
|
+
end
|
452
|
+
```
|
453
|
+
|
454
|
+
#### Using the list_all_currencies_with_http_info variant
|
455
|
+
|
456
|
+
This returns an Array which contains the response data, status code and headers.
|
457
|
+
|
458
|
+
```ruby
|
459
|
+
|
460
|
+
begin
|
461
|
+
# List currencies
|
462
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_currencies_with_http_info
|
463
|
+
p status_code # => 2xx
|
464
|
+
p headers # => { ... }
|
465
|
+
p data # => Array<Currency>
|
466
|
+
rescue SnapTrade::ApiError => e
|
467
|
+
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies: #{e}"
|
468
|
+
end
|
469
|
+
```
|
470
|
+
|
471
|
+
### Parameters
|
472
|
+
|
473
|
+
This endpoint does not need any parameter.
|
474
|
+
|
475
|
+
### Return type
|
476
|
+
|
477
|
+
[**Array<Currency>**](Currency.md)
|
478
|
+
|
479
|
+
## list_all_currencies_rates
|
480
|
+
|
481
|
+
List currency exchange rates
|
482
|
+
|
483
|
+
### Example
|
484
|
+
|
485
|
+
```ruby
|
486
|
+
require 'snaptrade'
|
487
|
+
|
488
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
489
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
490
|
+
|
491
|
+
|
492
|
+
begin
|
493
|
+
# List currency exchange rates
|
494
|
+
result = SnapTrade::ReferenceData.list_all_currencies_rates
|
495
|
+
p result
|
496
|
+
rescue SnapTrade::ApiError => e
|
497
|
+
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies_rates: #{e}"
|
498
|
+
end
|
499
|
+
```
|
500
|
+
|
501
|
+
#### Using the list_all_currencies_rates_with_http_info variant
|
502
|
+
|
503
|
+
This returns an Array which contains the response data, status code and headers.
|
504
|
+
|
505
|
+
```ruby
|
506
|
+
|
507
|
+
begin
|
508
|
+
# List currency exchange rates
|
509
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_currencies_rates_with_http_info
|
510
|
+
p status_code # => 2xx
|
511
|
+
p headers # => { ... }
|
512
|
+
p data # => Array<ExchangeRatePairs>
|
513
|
+
rescue SnapTrade::ApiError => e
|
514
|
+
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies_rates: #{e}"
|
515
|
+
end
|
516
|
+
```
|
517
|
+
|
518
|
+
### Parameters
|
519
|
+
|
520
|
+
This endpoint does not need any parameter.
|
521
|
+
|
522
|
+
### Return type
|
523
|
+
|
524
|
+
[**Array<ExchangeRatePairs>**](ExchangeRatePairs.md)
|
525
|
+
|
526
|
+
## symbol_search_user_account
|
527
|
+
|
528
|
+
Search for symbols available in an account
|
529
|
+
|
530
|
+
### Example
|
531
|
+
|
532
|
+
```ruby
|
533
|
+
require 'snaptrade'
|
534
|
+
|
535
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
536
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
537
|
+
|
538
|
+
user_id = "John.doe@snaptrade.com"
|
539
|
+
user_secret = "USERSECRET123"
|
540
|
+
account_id = "accountId_example"
|
541
|
+
substring = "apple"
|
542
|
+
|
543
|
+
begin
|
544
|
+
# Search for symbols available in an account
|
545
|
+
result = SnapTrade::ReferenceData.symbol_search_user_account(
|
546
|
+
user_id: user_id,
|
547
|
+
user_secret: user_secret,
|
548
|
+
account_id: account_id,
|
549
|
+
substring: substring,
|
550
|
+
)
|
551
|
+
p result
|
552
|
+
rescue SnapTrade::ApiError => e
|
553
|
+
puts "Exception when calling SnapTrade::ReferenceData.symbol_search_user_account: #{e}"
|
554
|
+
end
|
555
|
+
```
|
556
|
+
|
557
|
+
#### Using the symbol_search_user_account_with_http_info variant
|
558
|
+
|
559
|
+
This returns an Array which contains the response data, status code and headers.
|
560
|
+
|
561
|
+
```ruby
|
562
|
+
user_id = "John.doe@snaptrade.com"
|
563
|
+
user_secret = "USERSECRET123"
|
564
|
+
account_id = "accountId_example"
|
565
|
+
substring = "apple"
|
566
|
+
|
567
|
+
begin
|
568
|
+
# Search for symbols available in an account
|
569
|
+
data, status_code, headers, response = SnapTrade::ReferenceData.symbol_search_user_account_with_http_info(
|
570
|
+
user_id: user_id,
|
571
|
+
user_secret: user_secret,
|
572
|
+
account_id: account_id,
|
573
|
+
substring: substring,
|
574
|
+
)
|
575
|
+
p status_code # => 2xx
|
576
|
+
p headers # => { ... }
|
577
|
+
p data # => Array<UniversalSymbol>
|
578
|
+
rescue SnapTrade::ApiError => e
|
579
|
+
puts "Exception when calling SnapTrade::ReferenceData.symbol_search_user_account: #{e}"
|
580
|
+
end
|
581
|
+
```
|
582
|
+
|
583
|
+
### Parameters
|
584
|
+
|
585
|
+
| Name | Type | Description | Notes |
|
586
|
+
| ---- | ---- | ----------- | ----- |
|
587
|
+
| **user_id** | **String** | | |
|
588
|
+
| **user_secret** | **String** | | |
|
589
|
+
| **account_id** | **String** | The ID of the account get positions. | |
|
590
|
+
| **symbol_query** | [**SymbolQuery**](SymbolQuery.md) | | [optional] |
|
591
|
+
|
592
|
+
### Return type
|
593
|
+
|
594
|
+
[**Array<UniversalSymbol>**](UniversalSymbol.md)
|
595
|
+
|