snaptrade 2.0.6 → 2.0.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -0
- data/Gemfile.lock +4 -9
- data/README.md +1680 -206
- data/lib/snaptrade/api/account_information_api.rb +40 -21
- data/lib/snaptrade/api/api_status_api.rb +6 -3
- data/lib/snaptrade/api/authentication_api.rb +40 -23
- data/lib/snaptrade/api/connections_api.rb +16 -9
- data/lib/snaptrade/api/error_logs_api.rb +4 -3
- data/lib/snaptrade/api/options_api.rb +24 -15
- data/lib/snaptrade/api/reference_data_api.rb +46 -23
- data/lib/snaptrade/api/trading_api.rb +38 -27
- data/lib/snaptrade/api/transactions_and_reporting_api.rb +12 -5
- data/lib/snaptrade/api_client.rb +24 -14
- data/lib/snaptrade/api_error.rb +0 -1
- data/lib/snaptrade/configuration.rb +11 -29
- data/lib/snaptrade/models/account.rb +0 -1
- data/lib/snaptrade/models/account_balance.rb +0 -1
- data/lib/snaptrade/models/account_balance_total.rb +0 -1
- data/lib/snaptrade/models/account_holdings.rb +0 -1
- data/lib/snaptrade/models/account_holdings_account.rb +0 -1
- data/lib/snaptrade/models/account_order_record.rb +3 -2
- data/lib/snaptrade/models/account_order_record_status.rb +0 -1
- data/lib/snaptrade/models/account_simple.rb +0 -1
- data/lib/snaptrade/models/account_sync_status.rb +0 -1
- data/lib/snaptrade/models/action.rb +0 -1
- data/lib/snaptrade/models/amount.rb +0 -1
- data/lib/snaptrade/models/auth_type.rb +0 -1
- data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +0 -1
- data/lib/snaptrade/models/balance.rb +15 -6
- data/lib/snaptrade/models/brokerage.rb +0 -1
- data/lib/snaptrade/models/brokerage_authorization.rb +0 -1
- data/lib/snaptrade/models/brokerage_authorization_type.rb +0 -1
- data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +0 -1
- data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +0 -1
- data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +0 -1
- data/lib/snaptrade/models/brokerage_authorization_type_type.rb +0 -1
- data/lib/snaptrade/models/brokerage_symbol.rb +0 -1
- data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb +0 -1
- data/lib/snaptrade/models/brokerage_symbol_symbol.rb +0 -1
- data/lib/snaptrade/models/brokerage_type.rb +0 -1
- data/lib/snaptrade/models/calculated_trade.rb +0 -1
- data/lib/snaptrade/models/cash_restriction.rb +0 -1
- data/lib/snaptrade/models/connection_portal_version.rb +0 -1
- data/lib/snaptrade/models/connection_type.rb +0 -1
- data/lib/snaptrade/models/connections_session_events200_response_inner.rb +0 -1
- data/lib/snaptrade/models/currency.rb +0 -1
- data/lib/snaptrade/models/delete_user_response.rb +0 -1
- data/lib/snaptrade/models/dividend_at_date.rb +0 -1
- data/lib/snaptrade/models/encrypted_response.rb +0 -1
- data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +0 -1
- data/lib/snaptrade/models/exchange.rb +0 -1
- data/lib/snaptrade/models/exchange_rate_pairs.rb +0 -1
- data/lib/snaptrade/models/excluded_asset.rb +0 -1
- data/lib/snaptrade/models/jwt.rb +0 -1
- data/lib/snaptrade/models/login_redirect_uri.rb +0 -1
- data/lib/snaptrade/models/manual_trade.rb +3 -2
- data/lib/snaptrade/models/manual_trade_and_impact.rb +0 -1
- data/lib/snaptrade/models/manual_trade_balance.rb +0 -1
- data/lib/snaptrade/models/manual_trade_form.rb +3 -1
- data/lib/snaptrade/models/manual_trade_symbol.rb +0 -1
- data/lib/snaptrade/models/model400_failed_request_response.rb +0 -1
- data/lib/snaptrade/models/model401_failed_request_response.rb +0 -1
- data/lib/snaptrade/models/model403_failed_request_response.rb +0 -1
- data/lib/snaptrade/models/model404_failed_request_response.rb +0 -1
- data/lib/snaptrade/models/model500_unexpected_exception_response.rb +0 -1
- data/lib/snaptrade/models/model_asset_class.rb +0 -1
- data/lib/snaptrade/models/model_asset_class_details.rb +0 -1
- data/lib/snaptrade/models/model_asset_class_target.rb +0 -1
- data/lib/snaptrade/models/model_portfolio.rb +0 -1
- data/lib/snaptrade/models/model_portfolio_asset_class.rb +0 -1
- data/lib/snaptrade/models/model_portfolio_details.rb +0 -1
- data/lib/snaptrade/models/model_portfolio_security.rb +0 -1
- data/lib/snaptrade/models/model_type.rb +0 -1
- data/lib/snaptrade/models/monthly_dividends.rb +0 -1
- data/lib/snaptrade/models/net_contributions.rb +0 -1
- data/lib/snaptrade/models/net_dividend.rb +0 -1
- data/lib/snaptrade/models/option_chain_inner.rb +0 -1
- data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +0 -1
- data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +0 -1
- data/lib/snaptrade/models/option_leg.rb +0 -1
- data/lib/snaptrade/models/option_leg_action.rb +0 -1
- data/lib/snaptrade/models/option_strategy.rb +0 -1
- data/lib/snaptrade/models/option_strategy_legs_inner.rb +0 -1
- data/lib/snaptrade/models/option_type.rb +0 -1
- data/lib/snaptrade/models/options_get_option_strategy_request.rb +0 -1
- data/lib/snaptrade/models/options_holdings.rb +0 -1
- data/lib/snaptrade/models/options_place_option_strategy_request.rb +2 -1
- data/lib/snaptrade/models/options_position.rb +0 -1
- data/lib/snaptrade/models/options_position_currency.rb +0 -1
- data/lib/snaptrade/models/options_symbol.rb +0 -1
- data/lib/snaptrade/models/order_type.rb +0 -1
- data/lib/snaptrade/models/partner_data.rb +0 -1
- data/lib/snaptrade/models/past_value.rb +0 -1
- data/lib/snaptrade/models/performance_custom.rb +0 -1
- data/lib/snaptrade/models/portfolio_group.rb +0 -1
- data/lib/snaptrade/models/portfolio_group_info.rb +0 -1
- data/lib/snaptrade/models/portfolio_group_position.rb +0 -1
- data/lib/snaptrade/models/portfolio_group_settings.rb +0 -1
- data/lib/snaptrade/models/position.rb +0 -1
- data/lib/snaptrade/models/position_symbol.rb +0 -1
- data/lib/snaptrade/models/redirect_tokenand_pin.rb +0 -1
- data/lib/snaptrade/models/security_type.rb +0 -1
- data/lib/snaptrade/models/session_event.rb +0 -1
- data/lib/snaptrade/models/session_event_type.rb +0 -1
- data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +0 -1
- data/lib/snaptrade/models/snap_trade_holdings_account.rb +0 -1
- data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +0 -1
- data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +0 -1
- data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +2 -1
- data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +0 -1
- data/lib/snaptrade/models/state.rb +0 -1
- data/lib/snaptrade/models/status.rb +0 -1
- data/lib/snaptrade/models/strategy_impact.rb +0 -1
- data/lib/snaptrade/models/strategy_impact_legs_inner.rb +0 -1
- data/lib/snaptrade/models/strategy_order_place.rb +0 -1
- data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +0 -1
- data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +0 -1
- data/lib/snaptrade/models/strategy_order_record.rb +1 -1
- data/lib/snaptrade/models/strategy_order_record_status.rb +0 -1
- data/lib/snaptrade/models/strategy_quotes.rb +0 -1
- data/lib/snaptrade/models/strategy_quotes_greek.rb +0 -1
- data/lib/snaptrade/models/strategy_type.rb +0 -1
- data/lib/snaptrade/models/sub_period_return_rate.rb +0 -1
- data/lib/snaptrade/models/symbol.rb +0 -1
- data/lib/snaptrade/models/symbol_query.rb +0 -1
- data/lib/snaptrade/models/symbols_quotes_inner.rb +0 -1
- data/lib/snaptrade/models/target_asset.rb +0 -1
- data/lib/snaptrade/models/time_in_force_strict.rb +0 -1
- data/lib/snaptrade/models/trade.rb +0 -1
- data/lib/snaptrade/models/trade_action.rb +0 -1
- data/lib/snaptrade/models/trade_execution_status.rb +2 -1
- data/lib/snaptrade/models/trade_execution_status_action.rb +0 -1
- data/lib/snaptrade/models/trade_impact.rb +0 -1
- data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +0 -1
- data/lib/snaptrade/models/trading_place_oco_order_request.rb +0 -1
- data/lib/snaptrade/models/transactions_status.rb +0 -1
- data/lib/snaptrade/models/type.rb +0 -1
- data/lib/snaptrade/models/underlying_symbol.rb +0 -1
- data/lib/snaptrade/models/universal_activity.rb +0 -1
- data/lib/snaptrade/models/universal_symbol.rb +0 -1
- data/lib/snaptrade/models/us_exchange.rb +0 -1
- data/lib/snaptrade/models/user_error_log.rb +0 -1
- data/lib/snaptrade/models/user_i_dand_secret.rb +0 -1
- data/lib/snaptrade/models/user_settings.rb +0 -1
- data/lib/snaptrade/models/validated_trade_body.rb +0 -1
- data/lib/snaptrade/version.rb +1 -2
- data/lib/snaptrade.rb +50 -18
- data/snaptrade.gemspec +0 -1
- data/spec/api/account_information_api_spec.rb +0 -1
- data/spec/api/api_status_api_spec.rb +0 -1
- data/spec/api/authentication_api_spec.rb +0 -1
- data/spec/api/connections_api_spec.rb +0 -1
- data/spec/api/error_logs_api_spec.rb +0 -1
- data/spec/api/options_api_spec.rb +0 -1
- data/spec/api/reference_data_api_spec.rb +0 -1
- data/spec/api/trading_api_spec.rb +0 -1
- data/spec/api/transactions_and_reporting_api_spec.rb +0 -1
- data/spec/api_client_spec.rb +0 -1
- data/spec/configuration_spec.rb +0 -1
- data/spec/models/account_balance_spec.rb +0 -1
- data/spec/models/account_balance_total_spec.rb +0 -1
- data/spec/models/account_holdings_account_spec.rb +0 -1
- data/spec/models/account_holdings_spec.rb +0 -1
- data/spec/models/account_order_record_spec.rb +0 -1
- data/spec/models/account_order_record_status_spec.rb +0 -1
- data/spec/models/account_simple_spec.rb +0 -1
- data/spec/models/account_spec.rb +0 -1
- data/spec/models/account_sync_status_spec.rb +0 -1
- data/spec/models/action_spec.rb +0 -1
- data/spec/models/amount_spec.rb +0 -1
- data/spec/models/auth_type_spec.rb +0 -1
- data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +0 -1
- data/spec/models/balance_spec.rb +6 -1
- data/spec/models/brokerage_authorization_spec.rb +0 -1
- data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +0 -1
- data/spec/models/brokerage_authorization_type_read_only_spec.rb +0 -1
- data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +0 -1
- data/spec/models/brokerage_authorization_type_spec.rb +0 -1
- data/spec/models/brokerage_authorization_type_type_spec.rb +0 -1
- data/spec/models/brokerage_spec.rb +0 -1
- data/spec/models/brokerage_symbol_option_symbol_spec.rb +0 -1
- data/spec/models/brokerage_symbol_spec.rb +0 -1
- data/spec/models/brokerage_symbol_symbol_spec.rb +0 -1
- data/spec/models/brokerage_type_spec.rb +0 -1
- data/spec/models/calculated_trade_spec.rb +0 -1
- data/spec/models/cash_restriction_spec.rb +0 -1
- data/spec/models/connection_portal_version_spec.rb +0 -1
- data/spec/models/connection_type_spec.rb +0 -1
- data/spec/models/connections_session_events200_response_inner_spec.rb +0 -1
- data/spec/models/currency_spec.rb +0 -1
- data/spec/models/delete_user_response_spec.rb +0 -1
- data/spec/models/dividend_at_date_spec.rb +0 -1
- data/spec/models/encrypted_response_encrypted_message_data_spec.rb +0 -1
- data/spec/models/encrypted_response_spec.rb +0 -1
- data/spec/models/exchange_rate_pairs_spec.rb +0 -1
- data/spec/models/exchange_spec.rb +0 -1
- data/spec/models/excluded_asset_spec.rb +0 -1
- data/spec/models/jwt_spec.rb +0 -1
- data/spec/models/login_redirect_uri_spec.rb +0 -1
- data/spec/models/manual_trade_and_impact_spec.rb +0 -1
- data/spec/models/manual_trade_balance_spec.rb +0 -1
- data/spec/models/manual_trade_form_spec.rb +0 -1
- data/spec/models/manual_trade_spec.rb +0 -1
- data/spec/models/manual_trade_symbol_spec.rb +0 -1
- data/spec/models/model400_failed_request_response_spec.rb +0 -1
- data/spec/models/model401_failed_request_response_spec.rb +0 -1
- data/spec/models/model403_failed_request_response_spec.rb +0 -1
- data/spec/models/model404_failed_request_response_spec.rb +0 -1
- data/spec/models/model500_unexpected_exception_response_spec.rb +0 -1
- data/spec/models/model_asset_class_details_spec.rb +0 -1
- data/spec/models/model_asset_class_spec.rb +0 -1
- data/spec/models/model_asset_class_target_spec.rb +0 -1
- data/spec/models/model_portfolio_asset_class_spec.rb +0 -1
- data/spec/models/model_portfolio_details_spec.rb +0 -1
- data/spec/models/model_portfolio_security_spec.rb +0 -1
- data/spec/models/model_portfolio_spec.rb +0 -1
- data/spec/models/model_type_spec.rb +0 -1
- data/spec/models/monthly_dividends_spec.rb +0 -1
- data/spec/models/net_contributions_spec.rb +0 -1
- data/spec/models/net_dividend_spec.rb +0 -1
- data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +0 -1
- data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +0 -1
- data/spec/models/option_chain_inner_spec.rb +0 -1
- data/spec/models/option_leg_action_spec.rb +0 -1
- data/spec/models/option_leg_spec.rb +0 -1
- data/spec/models/option_strategy_legs_inner_spec.rb +0 -1
- data/spec/models/option_strategy_spec.rb +0 -1
- data/spec/models/option_type_spec.rb +0 -1
- data/spec/models/options_get_option_strategy_request_spec.rb +0 -1
- data/spec/models/options_holdings_spec.rb +0 -1
- data/spec/models/options_place_option_strategy_request_spec.rb +0 -1
- data/spec/models/options_position_currency_spec.rb +0 -1
- data/spec/models/options_position_spec.rb +0 -1
- data/spec/models/options_symbol_spec.rb +0 -1
- data/spec/models/order_type_spec.rb +0 -1
- data/spec/models/partner_data_spec.rb +0 -1
- data/spec/models/past_value_spec.rb +0 -1
- data/spec/models/performance_custom_spec.rb +0 -1
- data/spec/models/portfolio_group_info_spec.rb +0 -1
- data/spec/models/portfolio_group_position_spec.rb +0 -1
- data/spec/models/portfolio_group_settings_spec.rb +0 -1
- data/spec/models/portfolio_group_spec.rb +0 -1
- data/spec/models/position_spec.rb +0 -1
- data/spec/models/position_symbol_spec.rb +0 -1
- data/spec/models/redirect_tokenand_pin_spec.rb +0 -1
- data/spec/models/security_type_spec.rb +0 -1
- data/spec/models/session_event_spec.rb +0 -1
- data/spec/models/session_event_type_spec.rb +0 -1
- data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +0 -1
- data/spec/models/snap_trade_holdings_account_account_id_spec.rb +0 -1
- data/spec/models/snap_trade_holdings_account_spec.rb +0 -1
- data/spec/models/snap_trade_holdings_total_value_spec.rb +0 -1
- data/spec/models/snap_trade_login_user_request_body_spec.rb +0 -1
- data/spec/models/snap_trade_register_user_request_body_spec.rb +0 -1
- data/spec/models/state_spec.rb +0 -1
- data/spec/models/status_spec.rb +0 -1
- data/spec/models/strategy_impact_legs_inner_spec.rb +0 -1
- data/spec/models/strategy_impact_spec.rb +0 -1
- data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +0 -1
- data/spec/models/strategy_order_place_orders_inner_spec.rb +0 -1
- data/spec/models/strategy_order_place_spec.rb +0 -1
- data/spec/models/strategy_order_record_spec.rb +0 -1
- data/spec/models/strategy_order_record_status_spec.rb +0 -1
- data/spec/models/strategy_quotes_greek_spec.rb +0 -1
- data/spec/models/strategy_quotes_spec.rb +0 -1
- data/spec/models/strategy_type_spec.rb +0 -1
- data/spec/models/sub_period_return_rate_spec.rb +0 -1
- data/spec/models/symbol_query_spec.rb +0 -1
- data/spec/models/symbol_spec.rb +0 -1
- data/spec/models/symbols_quotes_inner_spec.rb +0 -1
- data/spec/models/target_asset_spec.rb +0 -1
- data/spec/models/time_in_force_strict_spec.rb +0 -1
- data/spec/models/trade_action_spec.rb +0 -1
- data/spec/models/trade_execution_status_action_spec.rb +0 -1
- data/spec/models/trade_execution_status_spec.rb +0 -1
- data/spec/models/trade_impact_spec.rb +0 -1
- data/spec/models/trade_spec.rb +0 -1
- data/spec/models/trading_cancel_user_account_order_request_spec.rb +0 -1
- data/spec/models/trading_place_oco_order_request_spec.rb +0 -1
- data/spec/models/transactions_status_spec.rb +0 -1
- data/spec/models/type_spec.rb +0 -1
- data/spec/models/underlying_symbol_spec.rb +0 -1
- data/spec/models/universal_activity_spec.rb +0 -1
- data/spec/models/universal_symbol_spec.rb +0 -1
- data/spec/models/us_exchange_spec.rb +0 -1
- data/spec/models/user_error_log_spec.rb +0 -1
- data/spec/models/user_i_dand_secret_spec.rb +0 -1
- data/spec/models/user_settings_spec.rb +0 -1
- data/spec/models/validated_trade_body_spec.rb +0 -1
- data/spec/spec_helper.rb +0 -1
- metadata +2 -141
- data/docs/APIStatusApi.md +0 -57
- data/docs/Account.md +0 -38
- data/docs/AccountBalance.md +0 -18
- data/docs/AccountBalanceTotal.md +0 -20
- data/docs/AccountHoldings.md +0 -24
- data/docs/AccountHoldingsAccount.md +0 -26
- data/docs/AccountInformationApi.md +0 -544
- data/docs/AccountOrderRecord.md +0 -52
- data/docs/AccountOrderRecordStatus.md +0 -15
- data/docs/AccountSimple.md +0 -24
- data/docs/AccountSyncStatus.md +0 -18
- data/docs/Action.md +0 -15
- data/docs/Amount.md +0 -20
- data/docs/AuthType.md +0 -15
- data/docs/AuthenticationApi.md +0 -380
- data/docs/AuthenticationLoginSnapTradeUser200Response.md +0 -49
- data/docs/Balance.md +0 -20
- data/docs/Brokerage.md +0 -56
- data/docs/BrokerageAuthorization.md +0 -34
- data/docs/BrokerageAuthorizationType.md +0 -18
- data/docs/BrokerageAuthorizationTypeReadOnly.md +0 -24
- data/docs/BrokerageAuthorizationTypeReadOnlyBrokerage.md +0 -22
- data/docs/BrokerageAuthorizationTypeReadOnlyType.md +0 -15
- data/docs/BrokerageAuthorizationTypeType.md +0 -15
- data/docs/BrokerageSymbol.md +0 -28
- data/docs/BrokerageSymbolOptionSymbol.md +0 -34
- data/docs/BrokerageSymbolSymbol.md +0 -34
- data/docs/BrokerageType.md +0 -20
- data/docs/CalculatedTrade.md +0 -20
- data/docs/CashRestriction.md +0 -26
- data/docs/ConnectionPortalVersion.md +0 -15
- data/docs/ConnectionType.md +0 -15
- data/docs/ConnectionsApi.md +0 -265
- data/docs/ConnectionsSessionEvents200ResponseInner.md +0 -30
- data/docs/Currency.md +0 -22
- data/docs/DeleteUserResponse.md +0 -20
- data/docs/DividendAtDate.md +0 -22
- data/docs/EncryptedResponse.md +0 -20
- data/docs/EncryptedResponseEncryptedMessageData.md +0 -22
- data/docs/ErrorLogsApi.md +0 -68
- data/docs/Exchange.md +0 -32
- data/docs/ExchangeRatePairs.md +0 -22
- data/docs/ExcludedAsset.md +0 -18
- data/docs/JWT.md +0 -18
- data/docs/LoginRedirectURI.md +0 -20
- data/docs/ManualTrade.md +0 -32
- data/docs/ManualTradeAndImpact.md +0 -22
- data/docs/ManualTradeBalance.md +0 -22
- data/docs/ManualTradeForm.md +0 -34
- data/docs/ManualTradeSymbol.md +0 -28
- data/docs/Model400FailedRequestResponse.md +0 -20
- data/docs/Model401FailedRequestResponse.md +0 -20
- data/docs/Model403FailedRequestResponse.md +0 -20
- data/docs/Model404FailedRequestResponse.md +0 -20
- data/docs/Model500UnexpectedExceptionResponse.md +0 -22
- data/docs/ModelAssetClass.md +0 -20
- data/docs/ModelAssetClassDetails.md +0 -20
- data/docs/ModelAssetClassTarget.md +0 -18
- data/docs/ModelPortfolio.md +0 -22
- data/docs/ModelPortfolioAssetClass.md +0 -20
- data/docs/ModelPortfolioDetails.md +0 -22
- data/docs/ModelPortfolioSecurity.md +0 -20
- data/docs/ModelType.md +0 -15
- data/docs/MonthlyDividends.md +0 -20
- data/docs/NetContributions.md +0 -22
- data/docs/NetDividend.md +0 -22
- data/docs/OptionChainInner.md +0 -26
- data/docs/OptionChainInnerChainPerRootInner.md +0 -22
- data/docs/OptionChainInnerChainPerRootInnerChainPerStrikePriceInner.md +0 -22
- data/docs/OptionLeg.md +0 -22
- data/docs/OptionLegAction.md +0 -15
- data/docs/OptionStrategy.md +0 -26
- data/docs/OptionStrategyLegsInner.md +0 -24
- data/docs/OptionType.md +0 -15
- data/docs/OptionsApi.md +0 -390
- data/docs/OptionsGetOptionStrategyRequest.md +0 -22
- data/docs/OptionsHoldings.md +0 -28
- data/docs/OptionsPlaceOptionStrategyRequest.md +0 -22
- data/docs/OptionsPosition.md +0 -26
- data/docs/OptionsPositionCurrency.md +0 -22
- data/docs/OptionsSymbol.md +0 -34
- data/docs/OrderType.md +0 -15
- data/docs/PartnerData.md +0 -40
- data/docs/PastValue.md +0 -22
- data/docs/PerformanceCustom.md +0 -54
- data/docs/PortfolioGroup.md +0 -20
- data/docs/PortfolioGroupInfo.md +0 -38
- data/docs/PortfolioGroupPosition.md +0 -22
- data/docs/PortfolioGroupSettings.md +0 -26
- data/docs/Position.md +0 -28
- data/docs/PositionSymbol.md +0 -28
- data/docs/RedirectTokenandPin.md +0 -20
- data/docs/ReferenceDataApi.md +0 -592
- data/docs/SecurityType.md +0 -24
- data/docs/SessionEvent.md +0 -30
- data/docs/SessionEventType.md +0 -15
- data/docs/SnapTradeAPIDisclaimerAcceptStatus.md +0 -20
- data/docs/SnapTradeHoldingsAccount.md +0 -32
- data/docs/SnapTradeHoldingsAccountAccountId.md +0 -34
- data/docs/SnapTradeHoldingsTotalValue.md +0 -20
- data/docs/SnapTradeLoginUserRequestBody.md +0 -28
- data/docs/SnapTradeRegisterUserRequestBody.md +0 -18
- data/docs/State.md +0 -15
- data/docs/Status.md +0 -22
- data/docs/StrategyImpact.md +0 -38
- data/docs/StrategyImpactLegsInner.md +0 -30
- data/docs/StrategyOrderPlace.md +0 -20
- data/docs/StrategyOrderPlaceOrdersInner.md +0 -102
- data/docs/StrategyOrderPlaceOrdersInnerLegsInner.md +0 -30
- data/docs/StrategyOrderRecord.md +0 -38
- data/docs/StrategyOrderRecordStatus.md +0 -15
- data/docs/StrategyQuotes.md +0 -28
- data/docs/StrategyQuotesGreek.md +0 -26
- data/docs/StrategyType.md +0 -15
- data/docs/SubPeriodReturnRate.md +0 -22
- data/docs/Symbol.md +0 -32
- data/docs/SymbolQuery.md +0 -18
- data/docs/SymbolsQuotesInner.md +0 -28
- data/docs/TargetAsset.md +0 -28
- data/docs/TimeInForceStrict.md +0 -15
- data/docs/Trade.md +0 -32
- data/docs/TradeAction.md +0 -15
- data/docs/TradeExecutionStatus.md +0 -34
- data/docs/TradeExecutionStatusAction.md +0 -15
- data/docs/TradeImpact.md +0 -26
- data/docs/TradingApi.md +0 -491
- data/docs/TradingCancelUserAccountOrderRequest.md +0 -18
- data/docs/TradingPlaceOCOOrderRequest.md +0 -20
- data/docs/TransactionsAndReportingApi.md +0 -183
- data/docs/TransactionsStatus.md +0 -20
- data/docs/Type.md +0 -15
- data/docs/USExchange.md +0 -34
- data/docs/UnderlyingSymbol.md +0 -32
- data/docs/UniversalActivity.md +0 -50
- data/docs/UniversalSymbol.md +0 -34
- data/docs/UserErrorLog.md +0 -28
- data/docs/UserIDandSecret.md +0 -20
- data/docs/UserSettings.md +0 -36
- data/docs/ValidatedTradeBody.md +0 -18
data/docs/ReferenceDataApi.md
DELETED
@@ -1,592 +0,0 @@
|
|
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/{query} | Get details of a symbol by the ticker or the universal_symbol_id |
|
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
|
-
List security types available on SnapTrade.
|
126
|
-
|
127
|
-
### Example
|
128
|
-
|
129
|
-
```ruby
|
130
|
-
require 'snaptrade'
|
131
|
-
|
132
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
133
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
134
|
-
|
135
|
-
|
136
|
-
begin
|
137
|
-
# List of all security types
|
138
|
-
result = SnapTrade::ReferenceData.get_security_types
|
139
|
-
p result
|
140
|
-
rescue SnapTrade::ApiError => e
|
141
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_security_types: #{e}"
|
142
|
-
end
|
143
|
-
```
|
144
|
-
|
145
|
-
#### Using the get_security_types_with_http_info variant
|
146
|
-
|
147
|
-
This returns an Array which contains the response data, status code and headers.
|
148
|
-
|
149
|
-
```ruby
|
150
|
-
|
151
|
-
begin
|
152
|
-
# List of all security types
|
153
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.get_security_types_with_http_info
|
154
|
-
p status_code # => 2xx
|
155
|
-
p headers # => { ... }
|
156
|
-
p data # => Array<SecurityType>
|
157
|
-
rescue SnapTrade::ApiError => e
|
158
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_security_types: #{e}"
|
159
|
-
end
|
160
|
-
```
|
161
|
-
|
162
|
-
### Parameters
|
163
|
-
|
164
|
-
This endpoint does not need any parameter.
|
165
|
-
|
166
|
-
### Return type
|
167
|
-
|
168
|
-
[**Array<SecurityType>**](SecurityType.md)
|
169
|
-
|
170
|
-
## get_stock_exchanges
|
171
|
-
|
172
|
-
List exchanges
|
173
|
-
|
174
|
-
### Example
|
175
|
-
|
176
|
-
```ruby
|
177
|
-
require 'snaptrade'
|
178
|
-
|
179
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
180
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
181
|
-
|
182
|
-
|
183
|
-
begin
|
184
|
-
# List exchanges
|
185
|
-
result = SnapTrade::ReferenceData.get_stock_exchanges
|
186
|
-
p result
|
187
|
-
rescue SnapTrade::ApiError => e
|
188
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_stock_exchanges: #{e}"
|
189
|
-
end
|
190
|
-
```
|
191
|
-
|
192
|
-
#### Using the get_stock_exchanges_with_http_info variant
|
193
|
-
|
194
|
-
This returns an Array which contains the response data, status code and headers.
|
195
|
-
|
196
|
-
```ruby
|
197
|
-
|
198
|
-
begin
|
199
|
-
# List exchanges
|
200
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.get_stock_exchanges_with_http_info
|
201
|
-
p status_code # => 2xx
|
202
|
-
p headers # => { ... }
|
203
|
-
p data # => Array<Exchange>
|
204
|
-
rescue SnapTrade::ApiError => e
|
205
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_stock_exchanges: #{e}"
|
206
|
-
end
|
207
|
-
```
|
208
|
-
|
209
|
-
### Parameters
|
210
|
-
|
211
|
-
This endpoint does not need any parameter.
|
212
|
-
|
213
|
-
### Return type
|
214
|
-
|
215
|
-
[**Array<Exchange>**](Exchange.md)
|
216
|
-
|
217
|
-
## get_symbols
|
218
|
-
|
219
|
-
Search for symbols
|
220
|
-
|
221
|
-
### Example
|
222
|
-
|
223
|
-
```ruby
|
224
|
-
require 'snaptrade'
|
225
|
-
|
226
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
227
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
228
|
-
|
229
|
-
substring = "apple"
|
230
|
-
|
231
|
-
begin
|
232
|
-
# Search for symbols
|
233
|
-
result = SnapTrade::ReferenceData.get_symbols(
|
234
|
-
substring: substring,
|
235
|
-
)
|
236
|
-
p result
|
237
|
-
rescue SnapTrade::ApiError => e
|
238
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_symbols: #{e}"
|
239
|
-
end
|
240
|
-
```
|
241
|
-
|
242
|
-
#### Using the get_symbols_with_http_info variant
|
243
|
-
|
244
|
-
This returns an Array which contains the response data, status code and headers.
|
245
|
-
|
246
|
-
```ruby
|
247
|
-
substring = "apple"
|
248
|
-
|
249
|
-
begin
|
250
|
-
# Search for symbols
|
251
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.get_symbols_with_http_info(
|
252
|
-
substring: substring,
|
253
|
-
)
|
254
|
-
p status_code # => 2xx
|
255
|
-
p headers # => { ... }
|
256
|
-
p data # => Array<UniversalSymbol>
|
257
|
-
rescue SnapTrade::ApiError => e
|
258
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_symbols: #{e}"
|
259
|
-
end
|
260
|
-
```
|
261
|
-
|
262
|
-
### Parameters
|
263
|
-
|
264
|
-
| Name | Type | Description | Notes |
|
265
|
-
| ---- | ---- | ----------- | ----- |
|
266
|
-
| **symbol_query** | [**SymbolQuery**](SymbolQuery.md) | | [optional] |
|
267
|
-
|
268
|
-
### Return type
|
269
|
-
|
270
|
-
[**Array<UniversalSymbol>**](UniversalSymbol.md)
|
271
|
-
|
272
|
-
## get_symbols_by_ticker
|
273
|
-
|
274
|
-
Get details of a symbol by the ticker or the universal_symbol_id
|
275
|
-
|
276
|
-
### Example
|
277
|
-
|
278
|
-
```ruby
|
279
|
-
require 'snaptrade'
|
280
|
-
|
281
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
282
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
283
|
-
|
284
|
-
query = "query_example"
|
285
|
-
|
286
|
-
begin
|
287
|
-
# Get details of a symbol by the ticker or the universal_symbol_id
|
288
|
-
result = SnapTrade::ReferenceData.get_symbols_by_ticker(
|
289
|
-
query: query,
|
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
|
-
query = "query_example"
|
303
|
-
|
304
|
-
begin
|
305
|
-
# Get details of a symbol by the ticker or the universal_symbol_id
|
306
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.get_symbols_by_ticker_with_http_info(
|
307
|
-
query: query,
|
308
|
-
)
|
309
|
-
p status_code # => 2xx
|
310
|
-
p headers # => { ... }
|
311
|
-
p data # => UniversalSymbol
|
312
|
-
rescue SnapTrade::ApiError => e
|
313
|
-
puts "Exception when calling SnapTrade::ReferenceData.get_symbols_by_ticker: #{e}"
|
314
|
-
end
|
315
|
-
```
|
316
|
-
|
317
|
-
### Parameters
|
318
|
-
|
319
|
-
| Name | Type | Description | Notes |
|
320
|
-
| ---- | ---- | ----------- | ----- |
|
321
|
-
| **query** | **String** | The ticker or universal_symbol_id of the UniversalSymbol to get. | |
|
322
|
-
|
323
|
-
### Return type
|
324
|
-
|
325
|
-
[**UniversalSymbol**](UniversalSymbol.md)
|
326
|
-
|
327
|
-
## list_all_brokerage_authorization_type
|
328
|
-
|
329
|
-
List of all brokerage authorization types
|
330
|
-
|
331
|
-
### Example
|
332
|
-
|
333
|
-
```ruby
|
334
|
-
require 'snaptrade'
|
335
|
-
|
336
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
337
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
338
|
-
|
339
|
-
brokerage = "QUESTRADE,ALPACA"
|
340
|
-
|
341
|
-
begin
|
342
|
-
# List of all brokerage authorization types
|
343
|
-
result = SnapTrade::ReferenceData.list_all_brokerage_authorization_type(
|
344
|
-
brokerage: brokerage,
|
345
|
-
)
|
346
|
-
p result
|
347
|
-
rescue SnapTrade::ApiError => e
|
348
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerage_authorization_type: #{e}"
|
349
|
-
end
|
350
|
-
```
|
351
|
-
|
352
|
-
#### Using the list_all_brokerage_authorization_type_with_http_info variant
|
353
|
-
|
354
|
-
This returns an Array which contains the response data, status code and headers.
|
355
|
-
|
356
|
-
```ruby
|
357
|
-
brokerage = "QUESTRADE,ALPACA"
|
358
|
-
|
359
|
-
begin
|
360
|
-
# List of all brokerage authorization types
|
361
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_brokerage_authorization_type_with_http_info(
|
362
|
-
brokerage: brokerage,
|
363
|
-
)
|
364
|
-
p status_code # => 2xx
|
365
|
-
p headers # => { ... }
|
366
|
-
p data # => Array<BrokerageAuthorizationTypeReadOnly>
|
367
|
-
rescue SnapTrade::ApiError => e
|
368
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerage_authorization_type: #{e}"
|
369
|
-
end
|
370
|
-
```
|
371
|
-
|
372
|
-
### Parameters
|
373
|
-
|
374
|
-
| Name | Type | Description | Notes |
|
375
|
-
| ---- | ---- | ----------- | ----- |
|
376
|
-
| **brokerage** | **String** | Comma separated value of brokerage slugs | [optional] |
|
377
|
-
|
378
|
-
### Return type
|
379
|
-
|
380
|
-
[**Array<BrokerageAuthorizationTypeReadOnly>**](BrokerageAuthorizationTypeReadOnly.md)
|
381
|
-
|
382
|
-
## list_all_brokerages
|
383
|
-
|
384
|
-
List brokerages
|
385
|
-
|
386
|
-
### Example
|
387
|
-
|
388
|
-
```ruby
|
389
|
-
require 'snaptrade'
|
390
|
-
|
391
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
392
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
393
|
-
|
394
|
-
|
395
|
-
begin
|
396
|
-
# List brokerages
|
397
|
-
result = SnapTrade::ReferenceData.list_all_brokerages
|
398
|
-
p result
|
399
|
-
rescue SnapTrade::ApiError => e
|
400
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerages: #{e}"
|
401
|
-
end
|
402
|
-
```
|
403
|
-
|
404
|
-
#### Using the list_all_brokerages_with_http_info variant
|
405
|
-
|
406
|
-
This returns an Array which contains the response data, status code and headers.
|
407
|
-
|
408
|
-
```ruby
|
409
|
-
|
410
|
-
begin
|
411
|
-
# List brokerages
|
412
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_brokerages_with_http_info
|
413
|
-
p status_code # => 2xx
|
414
|
-
p headers # => { ... }
|
415
|
-
p data # => Array<Brokerage>
|
416
|
-
rescue SnapTrade::ApiError => e
|
417
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_brokerages: #{e}"
|
418
|
-
end
|
419
|
-
```
|
420
|
-
|
421
|
-
### Parameters
|
422
|
-
|
423
|
-
This endpoint does not need any parameter.
|
424
|
-
|
425
|
-
### Return type
|
426
|
-
|
427
|
-
[**Array<Brokerage>**](Brokerage.md)
|
428
|
-
|
429
|
-
## list_all_currencies
|
430
|
-
|
431
|
-
List currencies
|
432
|
-
|
433
|
-
### Example
|
434
|
-
|
435
|
-
```ruby
|
436
|
-
require 'snaptrade'
|
437
|
-
|
438
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
439
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
440
|
-
|
441
|
-
|
442
|
-
begin
|
443
|
-
# List currencies
|
444
|
-
result = SnapTrade::ReferenceData.list_all_currencies
|
445
|
-
p result
|
446
|
-
rescue SnapTrade::ApiError => e
|
447
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies: #{e}"
|
448
|
-
end
|
449
|
-
```
|
450
|
-
|
451
|
-
#### Using the list_all_currencies_with_http_info variant
|
452
|
-
|
453
|
-
This returns an Array which contains the response data, status code and headers.
|
454
|
-
|
455
|
-
```ruby
|
456
|
-
|
457
|
-
begin
|
458
|
-
# List currencies
|
459
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_currencies_with_http_info
|
460
|
-
p status_code # => 2xx
|
461
|
-
p headers # => { ... }
|
462
|
-
p data # => Array<Currency>
|
463
|
-
rescue SnapTrade::ApiError => e
|
464
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies: #{e}"
|
465
|
-
end
|
466
|
-
```
|
467
|
-
|
468
|
-
### Parameters
|
469
|
-
|
470
|
-
This endpoint does not need any parameter.
|
471
|
-
|
472
|
-
### Return type
|
473
|
-
|
474
|
-
[**Array<Currency>**](Currency.md)
|
475
|
-
|
476
|
-
## list_all_currencies_rates
|
477
|
-
|
478
|
-
List currency exchange rates
|
479
|
-
|
480
|
-
### Example
|
481
|
-
|
482
|
-
```ruby
|
483
|
-
require 'snaptrade'
|
484
|
-
|
485
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
486
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
487
|
-
|
488
|
-
|
489
|
-
begin
|
490
|
-
# List currency exchange rates
|
491
|
-
result = SnapTrade::ReferenceData.list_all_currencies_rates
|
492
|
-
p result
|
493
|
-
rescue SnapTrade::ApiError => e
|
494
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies_rates: #{e}"
|
495
|
-
end
|
496
|
-
```
|
497
|
-
|
498
|
-
#### Using the list_all_currencies_rates_with_http_info variant
|
499
|
-
|
500
|
-
This returns an Array which contains the response data, status code and headers.
|
501
|
-
|
502
|
-
```ruby
|
503
|
-
|
504
|
-
begin
|
505
|
-
# List currency exchange rates
|
506
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.list_all_currencies_rates_with_http_info
|
507
|
-
p status_code # => 2xx
|
508
|
-
p headers # => { ... }
|
509
|
-
p data # => Array<ExchangeRatePairs>
|
510
|
-
rescue SnapTrade::ApiError => e
|
511
|
-
puts "Exception when calling SnapTrade::ReferenceData.list_all_currencies_rates: #{e}"
|
512
|
-
end
|
513
|
-
```
|
514
|
-
|
515
|
-
### Parameters
|
516
|
-
|
517
|
-
This endpoint does not need any parameter.
|
518
|
-
|
519
|
-
### Return type
|
520
|
-
|
521
|
-
[**Array<ExchangeRatePairs>**](ExchangeRatePairs.md)
|
522
|
-
|
523
|
-
## symbol_search_user_account
|
524
|
-
|
525
|
-
Search for symbols available in an account
|
526
|
-
|
527
|
-
### Example
|
528
|
-
|
529
|
-
```ruby
|
530
|
-
require 'snaptrade'
|
531
|
-
|
532
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
533
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
534
|
-
|
535
|
-
user_id = "John.doe@snaptrade.com"
|
536
|
-
user_secret = "USERSECRET123"
|
537
|
-
account_id = "accountId_example"
|
538
|
-
substring = "apple"
|
539
|
-
|
540
|
-
begin
|
541
|
-
# Search for symbols available in an account
|
542
|
-
result = SnapTrade::ReferenceData.symbol_search_user_account(
|
543
|
-
user_id: user_id,
|
544
|
-
user_secret: user_secret,
|
545
|
-
account_id: account_id,
|
546
|
-
substring: substring,
|
547
|
-
)
|
548
|
-
p result
|
549
|
-
rescue SnapTrade::ApiError => e
|
550
|
-
puts "Exception when calling SnapTrade::ReferenceData.symbol_search_user_account: #{e}"
|
551
|
-
end
|
552
|
-
```
|
553
|
-
|
554
|
-
#### Using the symbol_search_user_account_with_http_info variant
|
555
|
-
|
556
|
-
This returns an Array which contains the response data, status code and headers.
|
557
|
-
|
558
|
-
```ruby
|
559
|
-
user_id = "John.doe@snaptrade.com"
|
560
|
-
user_secret = "USERSECRET123"
|
561
|
-
account_id = "accountId_example"
|
562
|
-
substring = "apple"
|
563
|
-
|
564
|
-
begin
|
565
|
-
# Search for symbols available in an account
|
566
|
-
data, status_code, headers, response = SnapTrade::ReferenceData.symbol_search_user_account_with_http_info(
|
567
|
-
user_id: user_id,
|
568
|
-
user_secret: user_secret,
|
569
|
-
account_id: account_id,
|
570
|
-
substring: substring,
|
571
|
-
)
|
572
|
-
p status_code # => 2xx
|
573
|
-
p headers # => { ... }
|
574
|
-
p data # => Array<UniversalSymbol>
|
575
|
-
rescue SnapTrade::ApiError => e
|
576
|
-
puts "Exception when calling SnapTrade::ReferenceData.symbol_search_user_account: #{e}"
|
577
|
-
end
|
578
|
-
```
|
579
|
-
|
580
|
-
### Parameters
|
581
|
-
|
582
|
-
| Name | Type | Description | Notes |
|
583
|
-
| ---- | ---- | ----------- | ----- |
|
584
|
-
| **user_id** | **String** | | |
|
585
|
-
| **user_secret** | **String** | | |
|
586
|
-
| **account_id** | **String** | The ID of the account to search for symbols within. | |
|
587
|
-
| **symbol_query** | [**SymbolQuery**](SymbolQuery.md) | | [optional] |
|
588
|
-
|
589
|
-
### Return type
|
590
|
-
|
591
|
-
[**Array<UniversalSymbol>**](UniversalSymbol.md)
|
592
|
-
|
data/docs/SecurityType.md
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
# SnapTrade::SecurityType
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | | [optional] |
|
8
|
-
| **code** | **String** | | [optional] |
|
9
|
-
| **description** | **String** | | [optional] |
|
10
|
-
| **is_supported** | **Boolean** | | [optional] |
|
11
|
-
|
12
|
-
## Example
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'snaptrade'
|
16
|
-
|
17
|
-
instance = SnapTrade::SecurityType.new(
|
18
|
-
id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
|
19
|
-
code: cs,
|
20
|
-
description: Common Stock,
|
21
|
-
is_supported: true
|
22
|
-
)
|
23
|
-
```
|
24
|
-
|
data/docs/SessionEvent.md
DELETED
@@ -1,30 +0,0 @@
|
|
1
|
-
# SnapTrade::SessionEvent
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | | [optional] |
|
8
|
-
| **session_event_type** | [**SessionEventType**](SessionEventType.md) | | [optional] |
|
9
|
-
| **session_id** | **String** | | [optional] |
|
10
|
-
| **user_id** | **String** | SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user | [optional] |
|
11
|
-
| **created_date** | **String** | Time | [optional] |
|
12
|
-
| **brokerage_status_code** | **Integer** | | [optional] |
|
13
|
-
| **brokerage_authorization_id** | **String** | | [optional] |
|
14
|
-
|
15
|
-
## Example
|
16
|
-
|
17
|
-
```ruby
|
18
|
-
require 'snaptrade'
|
19
|
-
|
20
|
-
instance = SnapTrade::SessionEvent.new(
|
21
|
-
id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
|
22
|
-
session_event_type: null,
|
23
|
-
session_id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
|
24
|
-
user_id: snaptrade-user-123,
|
25
|
-
created_date: 2022-01-21T20:11:19.217Z,
|
26
|
-
brokerage_status_code: 400,
|
27
|
-
brokerage_authorization_id: 2bcd7cc3-e922-4976-bce1-9858296801c3
|
28
|
-
)
|
29
|
-
```
|
30
|
-
|
data/docs/SessionEventType.md
DELETED
@@ -1,20 +0,0 @@
|
|
1
|
-
# SnapTrade::SnapTradeAPIDisclaimerAcceptStatus
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **accepted** | **Boolean** | | [optional] |
|
8
|
-
| **timestamp** | **String** | | [optional] |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'snaptrade'
|
14
|
-
|
15
|
-
instance = SnapTrade::SnapTradeAPIDisclaimerAcceptStatus.new(
|
16
|
-
accepted: null,
|
17
|
-
timestamp: 2022-01-21T20:11:19.217Z
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|