Module: SnapTrade

Defined in:
lib/snaptrade/version.rb,
lib/snaptrade.rb,
lib/snaptrade/api_error.rb,
lib/snaptrade/api_client.rb,
lib/snaptrade/models/type.rb,
lib/snaptrade/configuration.rb,
lib/snaptrade/models/status.rb,
lib/snaptrade/models/symbol.rb,
lib/snaptrade/models/account.rb,
lib/snaptrade/models/balance.rb,
lib/snaptrade/models/tax_lot.rb,
lib/snaptrade/api/options_api.rb,
lib/snaptrade/api/trading_api.rb,
lib/snaptrade/models/currency.rb,
lib/snaptrade/models/exchange.rb,
lib/snaptrade/models/mleg_leg.rb,
lib/snaptrade/models/position.rb,
lib/snaptrade/models/auth_type.rb,
lib/snaptrade/models/brokerage.rb,
lib/snaptrade/models/stop_loss.rb,
lib/snaptrade/models/timeframe.rb,
lib/snaptrade/api_client_custom.rb,
lib/snaptrade/models/option_leg.rb,
lib/snaptrade/models/past_value.rb,
lib/snaptrade/api/api_status_api.rb,
lib/snaptrade/models/option_type.rb,
lib/snaptrade/models/take_profit.rb,
lib/snaptrade/models/us_exchange.rb,
lib/snaptrade/api/connections_api.rb,
lib/snaptrade/models/manual_trade.rb,
lib/snaptrade/models/net_dividend.rb,
lib/snaptrade/models/partner_data.rb,
lib/snaptrade/models/symbol_query.rb,
lib/snaptrade/models/action_strict.rb,
lib/snaptrade/models/security_type.rb,
lib/snaptrade/models/session_event.rb,
lib/snaptrade/models/strategy_type.rb,
lib/snaptrade/models/account_simple.rb,
lib/snaptrade/models/account_status.rb,
lib/snaptrade/models/brokerage_type.rb,
lib/snaptrade/models/notional_value.rb,
lib/snaptrade/models/options_symbol.rb,
lib/snaptrade/api/authentication_api.rb,
lib/snaptrade/api/reference_data_api.rb,
lib/snaptrade/models/account_balance.rb,
lib/snaptrade/models/connection_type.rb,
lib/snaptrade/models/figi_instrument.rb,
lib/snaptrade/models/holdings_status.rb,
lib/snaptrade/models/mleg_trade_form.rb,
lib/snaptrade/models/option_strategy.rb,
lib/snaptrade/models/position_symbol.rb,
lib/snaptrade/models/strategy_quotes.rb,
lib/snaptrade/models/symbol_currency.rb,
lib/snaptrade/models/symbol_exchange.rb,
lib/snaptrade/models/trading_session.rb,
lib/snaptrade/models/account_holdings.rb,
lib/snaptrade/models/balance_currency.rb,
lib/snaptrade/models/dividend_at_date.rb,
lib/snaptrade/models/options_position.rb,
lib/snaptrade/models/universal_symbol.rb,
lib/snaptrade/models/crypto_order_form.rb,
lib/snaptrade/models/manual_trade_form.rb,
lib/snaptrade/models/monthly_dividends.rb,
lib/snaptrade/models/net_contributions.rb,
lib/snaptrade/models/option_leg_action.rb,
lib/snaptrade/models/order_type_strict.rb,
lib/snaptrade/models/position_currency.rb,
lib/snaptrade/models/simple_order_form.rb,
lib/snaptrade/models/underlying_symbol.rb,
lib/snaptrade/models/encrypted_response.rb,
lib/snaptrade/models/login_redirect_uri.rb,
lib/snaptrade/models/mleg_action_strict.rb,
lib/snaptrade/models/option_chain_inner.rb,
lib/snaptrade/models/pagination_details.rb,
lib/snaptrade/models/performance_custom.rb,
lib/snaptrade/models/session_event_type.rb,
lib/snaptrade/models/trading_instrument.rb,
lib/snaptrade/models/universal_activity.rb,
lib/snaptrade/models/user_i_dand_secret.rb,
lib/snaptrade/models/account_sync_status.rb,
lib/snaptrade/models/cryptocurrency_pair.rb,
lib/snaptrade/models/exchange_rate_pairs.rb,
lib/snaptrade/models/manual_trade_impact.rb,
lib/snaptrade/models/manual_trade_symbol.rb,
lib/snaptrade/models/mleg_order_response.rb,
lib/snaptrade/models/transactions_status.rb,
lib/snaptrade/api/account_information_api.rb,
lib/snaptrade/models/account_order_record.rb,
lib/snaptrade/models/brokerage_instrument.rb,
lib/snaptrade/models/crypto_order_preview.rb,
lib/snaptrade/models/delete_user_response.rb,
lib/snaptrade/models/manual_trade_balance.rb,
lib/snaptrade/models/mleg_instrument_type.rb,
lib/snaptrade/models/symbols_quotes_inner.rb,
lib/snaptrade/models/time_in_force_strict.rb,
lib/snaptrade/models/validated_trade_body.rb,
lib/snaptrade/models/account_balance_total.rb,
lib/snaptrade/models/cancel_order_response.rb,
lib/snaptrade/models/rate_of_return_object.rb,
lib/snaptrade/models/strategy_order_record.rb,
lib/snaptrade/models/strategy_quotes_greek.rb,
lib/snaptrade/models/crypto_order_form_type.rb,
lib/snaptrade/models/mleg_order_type_strict.rb,
lib/snaptrade/models/order_updated_response.rb,
lib/snaptrade/models/recent_orders_response.rb,
lib/snaptrade/models/simple_order_form_type.rb,
lib/snaptrade/models/sub_period_return_rate.rb,
lib/snaptrade/models/symbol_figi_instrument.rb,
lib/snaptrade/models/underlying_symbol_type.rb,
lib/snaptrade/api/experimental_endpoints_api.rb,
lib/snaptrade/models/account_order_record_v2.rb,
lib/snaptrade/models/brokerage_authorization.rb,
lib/snaptrade/models/manual_trade_and_impact.rb,
lib/snaptrade/models/mleg_trading_instrument.rb,
lib/snaptrade/models/option_brokerage_symbol.rb,
lib/snaptrade/models/rate_of_return_response.rb,
lib/snaptrade/models/trading_instrument_type.rb,
lib/snaptrade/models/account_holdings_account.rb,
lib/snaptrade/models/account_order_record_leg.rb,
lib/snaptrade/models/mleg_price_effect_strict.rb,
lib/snaptrade/models/child_brokerage_order_ids.rb,
lib/snaptrade/models/connection_portal_version.rb,
lib/snaptrade/models/crypto_trading_instrument.rb,
lib/snaptrade/models/cryptocurrency_pair_quote.rb,
lib/snaptrade/models/manual_trade_form_bracket.rb,
lib/snaptrade/models/manual_trade_replace_form.rb,
lib/snaptrade/models/options_position_currency.rb,
lib/snaptrade/models/account_orders_v2_response.rb,
lib/snaptrade/models/account_universal_activity.rb,
lib/snaptrade/models/action_strict_with_options.rb,
lib/snaptrade/models/option_strategy_legs_inner.rb,
lib/snaptrade/models/underlying_symbol_exchange.rb,
lib/snaptrade/api/transactions_and_reporting_api.rb,
lib/snaptrade/models/account_order_record_status.rb,
lib/snaptrade/models/snap_trade_holdings_account.rb,
lib/snaptrade/models/paginated_universal_activity.rb,
lib/snaptrade/models/strategy_order_record_status.rb,
lib/snaptrade/models/account_order_record_status_v2.rb,
lib/snaptrade/models/brokerage_instruments_response.rb,
lib/snaptrade/models/crypto_trading_instrument_type.rb,
lib/snaptrade/models/manual_trade_form_with_options.rb,
lib/snaptrade/models/crypto_order_form_time_in_force.rb,
lib/snaptrade/models/simple_order_form_time_in_force.rb,
lib/snaptrade/models/snap_trade_holdings_total_value.rb,
lib/snaptrade/models/manual_trade_form_notional_value.rb,
lib/snaptrade/models/model400_failed_request_response.rb,
lib/snaptrade/models/model401_failed_request_response.rb,
lib/snaptrade/models/model403_failed_request_response.rb,
lib/snaptrade/models/model404_failed_request_response.rb,
lib/snaptrade/models/model425_failed_request_response.rb,
lib/snaptrade/models/account_universal_activity_symbol.rb,
lib/snaptrade/models/account_order_record_option_symbol.rb,
lib/snaptrade/models/crypto_order_preview_estimated_fee.rb,
lib/snaptrade/models/snap_trade_login_user_request_body.rb,
lib/snaptrade/models/account_order_record_leg_instrument.rb,
lib/snaptrade/models/account_order_record_quote_currency.rb,
lib/snaptrade/models/account_universal_activity_currency.rb,
lib/snaptrade/models/account_order_record_universal_symbol.rb,
lib/snaptrade/models/model403_feature_not_enabled_response.rb,
lib/snaptrade/models/snap_trade_register_user_request_body.rb,
lib/snaptrade/models/brokerage_authorization_type_read_only.rb,
lib/snaptrade/models/model500_unexpected_exception_response.rb,
lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb,
lib/snaptrade/models/account_universal_activity_option_symbol.rb,
lib/snaptrade/models/encrypted_response_encrypted_message_data.rb,
lib/snaptrade/models/model402_brokerage_auth_disabled_response.rb,
lib/snaptrade/models/account_order_record_quote_universal_symbol.rb,
lib/snaptrade/models/brokerage_authorization_refresh_confirmation.rb,
lib/snaptrade/models/connections_session_events200_response_inner.rb,
lib/snaptrade/models/brokerage_authorization_disabled_confirmation.rb,
lib/snaptrade/models/account_order_record_child_brokerage_order_ids.rb,
lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb,
lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb,
lib/snaptrade/models/model402_brokerage_auth_already_disabled_exception.rb,
lib/snaptrade/models/account_information_get_user_account_order_detail_request.rb,
lib/snaptrade/models/trading_search_cryptocurrency_pair_instruments200_response.rb,
lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb

Overview

#SnapTrade

#Connect brokerage accounts to your app for live positions and trading

The version of the OpenAPI document: 1.0.0 Contact: api@snaptrade.com

Defined Under Namespace

Modules: AuthenticationLoginSnapTradeUser200Response, NotionalValue Classes: APIResponse, APIStatusApi, Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationGetUserAccountOrderDetailRequest, AccountOrderRecord, AccountOrderRecordChildBrokerageOrderIds, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordOptionSymbol, AccountOrderRecordQuoteCurrency, AccountOrderRecordQuoteUniversalSymbol, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordUniversalSymbol, AccountOrderRecordV2, AccountOrdersV2Response, AccountSimple, AccountStatus, AccountSyncStatus, AccountUniversalActivity, AccountUniversalActivityCurrency, AccountUniversalActivityOptionSymbol, AccountUniversalActivitySymbol, ActionStrict, ActionStrictWithOptions, ApiClient, ApiClientCustom, ApiError, AuthType, AuthenticationApi, Balance, BalanceCurrency, Brokerage, BrokerageAuthorization, BrokerageAuthorizationDisabledConfirmation, BrokerageAuthorizationRefreshConfirmation, BrokerageAuthorizationTypeReadOnly, BrokerageAuthorizationTypeReadOnlyBrokerage, BrokerageInstrument, BrokerageInstrumentsResponse, BrokerageType, CancelOrderResponse, ChildBrokerageOrderIDs, Client, Configuration, ConnectionPortalVersion, ConnectionType, ConnectionsApi, ConnectionsSessionEvents200ResponseInner, CryptoOrderForm, CryptoOrderFormTimeInForce, CryptoOrderFormType, CryptoOrderPreview, CryptoOrderPreviewEstimatedFee, CryptoTradingInstrument, CryptoTradingInstrumentType, CryptocurrencyPair, CryptocurrencyPairQuote, Currency, DeleteUserResponse, DividendAtDate, EncryptedResponse, EncryptedResponseEncryptedMessageData, Exchange, ExchangeRatePairs, ExperimentalEndpointsApi, FigiInstrument, HoldingsStatus, LoginRedirectURI, ManualTrade, ManualTradeAndImpact, ManualTradeBalance, ManualTradeForm, ManualTradeFormBracket, ManualTradeFormNotionalValue, ManualTradeFormWithOptions, ManualTradeImpact, ManualTradeReplaceForm, ManualTradeSymbol, MlegActionStrict, MlegInstrumentType, MlegLeg, MlegOrderResponse, MlegOrderTypeStrict, MlegPriceEffectStrict, MlegTradeForm, MlegTradingInstrument, Model400FailedRequestResponse, Model401FailedRequestResponse, Model402BrokerageAuthAlreadyDisabledException, Model402BrokerageAuthDisabledResponse, Model403FailedRequestResponse, Model403FeatureNotEnabledResponse, Model404FailedRequestResponse, Model425FailedRequestResponse, Model500UnexpectedExceptionResponse, MonthlyDividends, NetContributions, NetDividend, OptionBrokerageSymbol, OptionChainInner, OptionChainInnerChainPerRootInner, OptionChainInnerChainPerRootInnerChainPerStrikePriceInner, OptionLeg, OptionLegAction, OptionStrategy, OptionStrategyLegsInner, OptionType, OptionsApi, OptionsPosition, OptionsPositionCurrency, OptionsSymbol, OrderTypeStrict, OrderUpdatedResponse, PaginatedUniversalActivity, PaginationDetails, PartnerData, PastValue, PerformanceCustom, Position, PositionCurrency, PositionSymbol, RateOfReturnObject, RateOfReturnResponse, RecentOrdersResponse, ReferenceDataApi, SecurityType, SessionEvent, SessionEventType, SimpleOrderForm, SimpleOrderFormTimeInForce, SimpleOrderFormType, SnapTradeHoldingsAccount, SnapTradeHoldingsTotalValue, SnapTradeLoginUserRequestBody, SnapTradeRegisterUserRequestBody, Status, StopLoss, StrategyOrderRecord, StrategyOrderRecordStatus, StrategyQuotes, StrategyQuotesGreek, StrategyType, SubPeriodReturnRate, Symbol, SymbolCurrency, SymbolExchange, SymbolFigiInstrument, SymbolQuery, SymbolsQuotesInner, TakeProfit, TaxLot, TimeInForceStrict, Timeframe, TradingApi, TradingInstrument, TradingInstrumentType, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TransactionsAndReportingApi, TransactionsStatus, Type, USExchange, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UniversalActivity, UniversalSymbol, UserIDandSecret, ValidatedTradeBody

Constant Summary collapse

SENTINEL = 
Object.new
VERSION = 
'2.0.160'
Options =

top-level client access to avoid having the user to insantiate their own API instances

OptionsApi::new
Trading =

top-level client access to avoid having the user to insantiate their own API instances

TradingApi::new
APIStatus =

top-level client access to avoid having the user to insantiate their own API instances

APIStatusApi::new
Connections =

top-level client access to avoid having the user to insantiate their own API instances

ConnectionsApi::new
Authentication =

top-level client access to avoid having the user to insantiate their own API instances

AuthenticationApi::new
ReferenceData =

top-level client access to avoid having the user to insantiate their own API instances

ReferenceDataApi::new
AccountInformation =

top-level client access to avoid having the user to insantiate their own API instances

AccountInformationApi::new
ExperimentalEndpoints =

top-level client access to avoid having the user to insantiate their own API instances

ExperimentalEndpointsApi::new
TransactionsAndReporting =

top-level client access to avoid having the user to insantiate their own API instances

TransactionsAndReportingApi::new

Class Method Summary collapse

Class Method Details

.client_id ⇒ Object

api key from OpenAPI spec



210
211
212
 
# File 'lib/snaptrade.rb', line 210

def client_id
  @config.client_id
end

.client_id=(value) ⇒ Object 



214
215
216
 
# File 'lib/snaptrade.rb', line 214

def client_id=(value)
  @config.client_id = value
end

.configure ⇒ Object

Customize default settings for the SDK using block.

SnapTrade.configure do |config|
  config.host = "http://example.com"
end

If no block given, return the default Configuration object.



247
248
249
250
251
252
253
 
# File 'lib/snaptrade.rb', line 247

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end

.consumer_key ⇒ Object

client state from konfig.yaml



234
235
236
 
# File 'lib/snaptrade.rb', line 234

def consumer_key
  @config.consumer_key
end

.consumer_key=(value) ⇒ Object 



238
239
240
 
# File 'lib/snaptrade.rb', line 238

def consumer_key=(value)
  @config.consumer_key = value
end

.host ⇒ Object 



202
203
204
 
# File 'lib/snaptrade.rb', line 202

def host
  @config.host
end

.host=(value) ⇒ Object 



206
207
208
 
# File 'lib/snaptrade.rb', line 206

def host=(value)
  @config.host = value
end

.signature ⇒ Object

api key from OpenAPI spec



218
219
220
 
# File 'lib/snaptrade.rb', line 218

def signature
  @config.signature
end

.signature=(value) ⇒ Object 



222
223
224
 
# File 'lib/snaptrade.rb', line 222

def signature=(value)
  @config.signature = value
end

.timestamp ⇒ Object

api key from OpenAPI spec



226
227
228
 
# File 'lib/snaptrade.rb', line 226

def timestamp
  @config.timestamp
end

.timestamp=(value) ⇒ Object 



230
231
232
 
# File 'lib/snaptrade.rb', line 230

def timestamp=(value)
  @config.timestamp = value
end