Categorygithub.com/passiv/snaptrade-sdks/sdks/go
modulepackage
1.0.36
Repository: https://github.com/passiv/snaptrade-sdks.git
Documentation: pkg.go.dev

# README

Visit SnapTrade

SnapTrade

Connect brokerage accounts to your app for live positions and trading

Go Reference More Info

Installation

Add to your project:

go get github.com/passiv/snaptrade-sdks/sdks/go

Getting Started

package main

import (
	"fmt"
	"os"

	snaptrade "github.com/passiv/snaptrade-sdks/sdks/go"
)

func main() {
	configuration := snaptrade.NewConfiguration()
	configuration.SetPartnerClientId(os.Getenv("SNAPTRADE_CLIENT_ID"))
	configuration.SetConsumerKey(os.Getenv("SNAPTRADE_CONSUMER_KEY"))
	client := snaptrade.NewAPIClient(configuration)

	// 1) Create a new user
	requestBody := snaptrade.NewSnapTradeRegisterUserRequestBody()
	userId := "USER_ID_FROM_YOU"
	requestBody.SetUserId(userId)
	request := client.AuthenticationApi.RegisterSnapTradeUser(*requestBody)
	resp, _, _ := request.Execute()

	// 2) Get user secret
	userSecret := resp.UserSecret

	// 3) Get redirect URI
	loginResp, _, _ := client.AuthenticationApi.LoginSnapTradeUser(userId, *userSecret).Execute()
	fmt.Println("Login redirect URI:", loginResp.LoginRedirectURI)

	// 4) Obtain account holdings data
	holdingsResp, _, _ := client.AccountInformationApi.GetAllUserHoldings(userId, *userSecret).Execute()
	fmt.Println("Account holdings:", holdingsResp)
	// 5) Delete the user
	deleteResp, _, _ := client.AuthenticationApi.DeleteSnapTradeUser(userId).Execute()
	fmt.Println("User deletion response:", deleteResp)
}

Documentation for API Endpoints

All URIs are relative to https://api.snaptrade.com/api/v1

ClassMethodHTTP requestDescription
AccountInformationApiGetAllUserHoldingsGet /holdingsList all accounts for the user, plus balances, positions, and orders for each account.
AccountInformationApiGetUserAccountBalanceGet /accounts/{accountId}/balancesList account balances
AccountInformationApiGetUserAccountDetailsGet /accounts/{accountId}Get account detail
AccountInformationApiGetUserAccountOrdersGet /accounts/{accountId}/ordersList account recent orders
AccountInformationApiGetUserAccountPositionsGet /accounts/{accountId}/positionsList account positions
AccountInformationApiGetUserAccountRecentOrdersGet /accounts/{accountId}/recentOrdersList account recent executed orders
AccountInformationApiGetUserAccountReturnRatesGet /accounts/{accountId}/returnRatesList account rate of returns
AccountInformationApiGetUserHoldingsGet /accounts/{accountId}/holdingsList account holdings
AccountInformationApiListUserAccountsGet /accountsList accounts
AccountInformationApiUpdateUserAccountPut /accounts/{accountId}Update details of an investment account
APIStatusApiCheckGet /Get API Status
AuthenticationApiDeleteSnapTradeUserDelete /snapTrade/deleteUserDelete user
AuthenticationApiListSnapTradeUsersGet /snapTrade/listUsersList all users
AuthenticationApiLoginSnapTradeUserPost /snapTrade/loginGenerate Connection Portal URL
AuthenticationApiRegisterSnapTradeUserPost /snapTrade/registerUserRegister user
AuthenticationApiResetSnapTradeUserSecretPost /snapTrade/resetUserSecretRotate user secret
ConnectionsApiDetailBrokerageAuthorizationGet /authorizations/{authorizationId}Get connection detail
ConnectionsApiDisableBrokerageAuthorizationPost /authorizations/{authorizationId}/disableForce disable connection
ConnectionsApiListBrokerageAuthorizationsGet /authorizationsList all connections
ConnectionsApiRefreshBrokerageAuthorizationPost /authorizations/{authorizationId}/refreshRefresh holdings for a connection
ConnectionsApiRemoveBrokerageAuthorizationDelete /authorizations/{authorizationId}Delete connection
ConnectionsApiReturnRatesGet /authorizations/{authorizationId}/returnRatesList connection rate of returns
ConnectionsApiSessionEventsGet /sessionEventsGet all session events for a user
OptionsApiGetOptionStrategyPost /accounts/{accountId}/optionStrategyCreate options strategy
OptionsApiGetOptionsChainGet /accounts/{accountId}/optionsChainGet the options chain for a symbol
OptionsApiGetOptionsStrategyQuoteGet /accounts/{accountId}/optionStrategy/{optionStrategyId}Get options strategy quotes
OptionsApiListOptionHoldingsGet /accounts/{accountId}/optionsList account option positions
OptionsApiPlaceOptionStrategyPost /accounts/{accountId}/optionStrategy/{optionStrategyId}/executePlace an option strategy order
ReferenceDataApiGetCurrencyExchangeRatePairGet /currencies/rates/{currencyPair}Get exchange rate of a currency pair
ReferenceDataApiGetPartnerInfoGet /snapTrade/partnersGet Client Info
ReferenceDataApiGetSecurityTypesGet /securityTypesList security types
ReferenceDataApiGetStockExchangesGet /exchangesGet exchanges
ReferenceDataApiGetSymbolsPost /symbolsSearch symbols
ReferenceDataApiGetSymbolsByTickerGet /symbols/{query}Get symbol detail
ReferenceDataApiListAllBrokerageAuthorizationTypeGet /brokerageAuthorizationTypesGet all brokerage authorization types
ReferenceDataApiListAllBrokeragesGet /brokeragesGet brokerages
ReferenceDataApiListAllCurrenciesGet /currenciesGet currencies
ReferenceDataApiListAllCurrenciesRatesGet /currencies/ratesGet currency exchange rates
ReferenceDataApiSymbolSearchUserAccountPost /accounts/{accountId}/symbolsSearch account symbols
TradingApiCancelUserAccountOrderPost /accounts/{accountId}/orders/cancelCancel order
TradingApiGetOrderImpactPost /trade/impactCheck order impact
TradingApiGetUserAccountQuotesGet /accounts/{accountId}/quotesGet symbol quotes
TradingApiPlaceForceOrderPost /trade/placePlace order
TradingApiPlaceOrderPost /trade/{tradeId}Place checked order
TransactionsAndReportingApiGetActivitiesGet /activitiesGet transaction history for a user
TransactionsAndReportingApiGetReportingCustomRangeGet /performance/customGet performance information for a specific timeframe

Documentation For Models

# Packages

No description provided by the author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
EncryptedResponseAsAuthenticationLoginSnapTradeUser200Response is a convenience function that returns EncryptedResponse wrapped in AuthenticationLoginSnapTradeUser200Response.
float32AsNotionalValue is a convenience function that returns float32 wrapped in NotionalValue.
LoginRedirectURIAsAuthenticationLoginSnapTradeUser200Response is a convenience function that returns LoginRedirectURI wrapped in AuthenticationLoginSnapTradeUser200Response.
NewAccount instantiates a new Account object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountBalance instantiates a new AccountBalance object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountBalanceTotal instantiates a new AccountBalanceTotal object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountBalanceTotalWithDefaults instantiates a new AccountBalanceTotal object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountBalanceWithDefaults instantiates a new AccountBalance object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountHoldings instantiates a new AccountHoldings object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountHoldingsAccount instantiates a new AccountHoldingsAccount object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountHoldingsAccountWithDefaults instantiates a new AccountHoldingsAccount object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountHoldingsWithDefaults instantiates a new AccountHoldings object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountOrderRecord instantiates a new AccountOrderRecord object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountOrderRecordOptionSymbol instantiates a new AccountOrderRecordOptionSymbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountOrderRecordOptionSymbolWithDefaults instantiates a new AccountOrderRecordOptionSymbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountOrderRecordStatusFromValue returns a pointer to a valid AccountOrderRecordStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAccountOrderRecordUniversalSymbol instantiates a new AccountOrderRecordUniversalSymbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountOrderRecordUniversalSymbolWithDefaults instantiates a new AccountOrderRecordUniversalSymbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountOrderRecordWithDefaults instantiates a new AccountOrderRecord object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountSimple instantiates a new AccountSimple object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountSimpleWithDefaults instantiates a new AccountSimple object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountSyncStatus instantiates a new AccountSyncStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountSyncStatusWithDefaults instantiates a new AccountSyncStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountWithDefaults instantiates a new Account object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewActionStrictFromValue returns a pointer to a valid ActionStrict for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewActionStrictWithOptionsFromValue returns a pointer to a valid ActionStrictWithOptions for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewBalance instantiates a new Balance object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBalanceCurrency instantiates a new BalanceCurrency object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBalanceCurrencyWithDefaults instantiates a new BalanceCurrency object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBalanceWithDefaults instantiates a new Balance object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBrokerage instantiates a new Brokerage object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBrokerageAuthorization instantiates a new BrokerageAuthorization object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBrokerageAuthorizationDisabledConfirmation instantiates a new BrokerageAuthorizationDisabledConfirmation object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBrokerageAuthorizationDisabledConfirmationWithDefaults instantiates a new BrokerageAuthorizationDisabledConfirmation object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBrokerageAuthorizationRefreshConfirmation instantiates a new BrokerageAuthorizationRefreshConfirmation object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBrokerageAuthorizationRefreshConfirmationWithDefaults instantiates a new BrokerageAuthorizationRefreshConfirmation object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBrokerageAuthorizationTypeReadOnly instantiates a new BrokerageAuthorizationTypeReadOnly object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBrokerageAuthorizationTypeReadOnlyBrokerage instantiates a new BrokerageAuthorizationTypeReadOnlyBrokerage object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBrokerageAuthorizationTypeReadOnlyBrokerageWithDefaults instantiates a new BrokerageAuthorizationTypeReadOnlyBrokerage object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBrokerageAuthorizationTypeReadOnlyWithDefaults instantiates a new BrokerageAuthorizationTypeReadOnly object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBrokerageAuthorizationWithDefaults instantiates a new BrokerageAuthorization object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBrokerageType instantiates a new BrokerageType object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBrokerageTypeWithDefaults instantiates a new BrokerageType object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBrokerageWithDefaults instantiates a new Brokerage object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewCurrency instantiates a new Currency object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCurrencyWithDefaults instantiates a new Currency object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDeleteUserResponse instantiates a new DeleteUserResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDeleteUserResponseWithDefaults instantiates a new DeleteUserResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDividendAtDate instantiates a new DividendAtDate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDividendAtDateWithDefaults instantiates a new DividendAtDate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEncryptedResponse instantiates a new EncryptedResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEncryptedResponseEncryptedMessageData instantiates a new EncryptedResponseEncryptedMessageData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEncryptedResponseEncryptedMessageDataWithDefaults instantiates a new EncryptedResponseEncryptedMessageData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEncryptedResponseWithDefaults instantiates a new EncryptedResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExchange instantiates a new Exchange object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExchangeRatePairs instantiates a new ExchangeRatePairs object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExchangeRatePairsWithDefaults instantiates a new ExchangeRatePairs object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewExchangeWithDefaults instantiates a new Exchange object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFigiInstrument instantiates a new FigiInstrument object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFigiInstrumentWithDefaults instantiates a new FigiInstrument object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewHoldingsStatus instantiates a new HoldingsStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewHoldingsStatusWithDefaults instantiates a new HoldingsStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLoginRedirectURI instantiates a new LoginRedirectURI object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLoginRedirectURIWithDefaults instantiates a new LoginRedirectURI object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewManualTrade instantiates a new ManualTrade object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewManualTradeAndImpact instantiates a new ManualTradeAndImpact object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewManualTradeAndImpactWithDefaults instantiates a new ManualTradeAndImpact object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewManualTradeBalance instantiates a new ManualTradeBalance object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewManualTradeBalanceWithDefaults instantiates a new ManualTradeBalance object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewManualTradeForm instantiates a new ManualTradeForm object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewManualTradeFormNotionalValue instantiates a new ManualTradeFormNotionalValue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewManualTradeFormNotionalValueWithDefaults instantiates a new ManualTradeFormNotionalValue object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewManualTradeFormWithDefaults instantiates a new ManualTradeForm object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewManualTradeFormWithOptions instantiates a new ManualTradeFormWithOptions object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewManualTradeFormWithOptionsWithDefaults instantiates a new ManualTradeFormWithOptions object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewManualTradeImpact instantiates a new ManualTradeImpact object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewManualTradeImpactWithDefaults instantiates a new ManualTradeImpact object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewManualTradeSymbol instantiates a new ManualTradeSymbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewManualTradeSymbolWithDefaults instantiates a new ManualTradeSymbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewManualTradeWithDefaults instantiates a new ManualTrade object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModel400FailedRequestResponse instantiates a new Model400FailedRequestResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModel400FailedRequestResponseWithDefaults instantiates a new Model400FailedRequestResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModel401FailedRequestResponse instantiates a new Model401FailedRequestResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModel401FailedRequestResponseWithDefaults instantiates a new Model401FailedRequestResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModel402BrokerageAuthAlreadyDisabledException instantiates a new Model402BrokerageAuthAlreadyDisabledException object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModel402BrokerageAuthAlreadyDisabledExceptionWithDefaults instantiates a new Model402BrokerageAuthAlreadyDisabledException object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModel402BrokerageAuthDisabledResponse instantiates a new Model402BrokerageAuthDisabledResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModel402BrokerageAuthDisabledResponseWithDefaults instantiates a new Model402BrokerageAuthDisabledResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModel403FailedRequestResponse instantiates a new Model403FailedRequestResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModel403FailedRequestResponseWithDefaults instantiates a new Model403FailedRequestResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModel403FeatureNotEnabledResponse instantiates a new Model403FeatureNotEnabledResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModel403FeatureNotEnabledResponseWithDefaults instantiates a new Model403FeatureNotEnabledResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModel404FailedRequestResponse instantiates a new Model404FailedRequestResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModel404FailedRequestResponseWithDefaults instantiates a new Model404FailedRequestResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModel425FailedRequestResponse instantiates a new Model425FailedRequestResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModel425FailedRequestResponseWithDefaults instantiates a new Model425FailedRequestResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModel500UnexpectedExceptionResponse instantiates a new Model500UnexpectedExceptionResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModel500UnexpectedExceptionResponseWithDefaults instantiates a new Model500UnexpectedExceptionResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewMonthlyDividends instantiates a new MonthlyDividends object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewMonthlyDividendsWithDefaults instantiates a new MonthlyDividends object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNetContributions instantiates a new NetContributions object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNetContributionsWithDefaults instantiates a new NetContributions object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNetDividend instantiates a new NetDividend object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNetDividendWithDefaults instantiates a new NetDividend object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewOptionBrokerageSymbol instantiates a new OptionBrokerageSymbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionBrokerageSymbolWithDefaults instantiates a new OptionBrokerageSymbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionChainInner instantiates a new OptionChainInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionChainInnerChainPerRootInner instantiates a new OptionChainInnerChainPerRootInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionChainInnerChainPerRootInnerChainPerStrikePriceInner instantiates a new OptionChainInnerChainPerRootInnerChainPerStrikePriceInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionChainInnerChainPerRootInnerChainPerStrikePriceInnerWithDefaults instantiates a new OptionChainInnerChainPerRootInnerChainPerStrikePriceInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionChainInnerChainPerRootInnerWithDefaults instantiates a new OptionChainInnerChainPerRootInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionChainInnerWithDefaults instantiates a new OptionChainInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionLeg instantiates a new OptionLeg object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionLegWithDefaults instantiates a new OptionLeg object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionsGetOptionStrategyRequest instantiates a new OptionsGetOptionStrategyRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionsGetOptionStrategyRequestWithDefaults instantiates a new OptionsGetOptionStrategyRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionsPlaceOptionStrategyRequest instantiates a new OptionsPlaceOptionStrategyRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionsPlaceOptionStrategyRequestWithDefaults instantiates a new OptionsPlaceOptionStrategyRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionsPosition instantiates a new OptionsPosition object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionsPositionCurrency instantiates a new OptionsPositionCurrency object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionsPositionCurrencyWithDefaults instantiates a new OptionsPositionCurrency object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionsPositionWithDefaults instantiates a new OptionsPosition object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionsSymbol instantiates a new OptionsSymbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionsSymbolWithDefaults instantiates a new OptionsSymbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionStrategy instantiates a new OptionStrategy object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionStrategyLegsInner instantiates a new OptionStrategyLegsInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOptionStrategyLegsInnerWithDefaults instantiates a new OptionStrategyLegsInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOptionStrategyWithDefaults instantiates a new OptionStrategy object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOrderTypeStrictFromValue returns a pointer to a valid OrderTypeStrict for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewPartnerData instantiates a new PartnerData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPartnerDataWithDefaults instantiates a new PartnerData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPastValue instantiates a new PastValue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPastValueWithDefaults instantiates a new PastValue object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPerformanceCustom instantiates a new PerformanceCustom object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPerformanceCustomWithDefaults instantiates a new PerformanceCustom object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPosition instantiates a new Position object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPositionSymbol instantiates a new PositionSymbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPositionSymbolWithDefaults instantiates a new PositionSymbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPositionWithDefaults instantiates a new Position object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRateOfReturnObject instantiates a new RateOfReturnObject object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRateOfReturnObjectWithDefaults instantiates a new RateOfReturnObject object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRateOfReturnResponse instantiates a new RateOfReturnResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRateOfReturnResponseWithDefaults instantiates a new RateOfReturnResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRecentOrdersResponse instantiates a new RecentOrdersResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRecentOrdersResponseWithDefaults instantiates a new RecentOrdersResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSecurityType instantiates a new SecurityType object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSecurityTypeWithDefaults instantiates a new SecurityType object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSessionEvent instantiates a new SessionEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSessionEventWithDefaults instantiates a new SessionEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSnapTradeHoldingsAccount instantiates a new SnapTradeHoldingsAccount object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSnapTradeHoldingsAccountWithDefaults instantiates a new SnapTradeHoldingsAccount object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSnapTradeHoldingsTotalValue instantiates a new SnapTradeHoldingsTotalValue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSnapTradeHoldingsTotalValueWithDefaults instantiates a new SnapTradeHoldingsTotalValue object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSnapTradeLoginUserRequestBody instantiates a new SnapTradeLoginUserRequestBody object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSnapTradeLoginUserRequestBodyWithDefaults instantiates a new SnapTradeLoginUserRequestBody object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSnapTradeRegisterUserRequestBody instantiates a new SnapTradeRegisterUserRequestBody object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSnapTradeRegisterUserRequestBodyWithDefaults instantiates a new SnapTradeRegisterUserRequestBody object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStatus instantiates a new Status object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStatusWithDefaults instantiates a new Status object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStrategyOrderRecord instantiates a new StrategyOrderRecord object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStrategyOrderRecordWithDefaults instantiates a new StrategyOrderRecord object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStrategyQuotes instantiates a new StrategyQuotes object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStrategyQuotesGreek instantiates a new StrategyQuotesGreek object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStrategyQuotesGreekWithDefaults instantiates a new StrategyQuotesGreek object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStrategyQuotesWithDefaults instantiates a new StrategyQuotes object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSubPeriodReturnRate instantiates a new SubPeriodReturnRate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSubPeriodReturnRateWithDefaults instantiates a new SubPeriodReturnRate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSymbol instantiates a new Symbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSymbolCurrency instantiates a new SymbolCurrency object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSymbolCurrencyWithDefaults instantiates a new SymbolCurrency object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSymbolExchange instantiates a new SymbolExchange object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSymbolExchangeWithDefaults instantiates a new SymbolExchange object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSymbolFigiInstrument instantiates a new SymbolFigiInstrument object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSymbolFigiInstrumentWithDefaults instantiates a new SymbolFigiInstrument object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSymbolQuery instantiates a new SymbolQuery object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSymbolQueryWithDefaults instantiates a new SymbolQuery object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSymbolsQuotesInner instantiates a new SymbolsQuotesInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSymbolsQuotesInnerWithDefaults instantiates a new SymbolsQuotesInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSymbolWithDefaults instantiates a new Symbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTimeInForceStrictFromValue returns a pointer to a valid TimeInForceStrict for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewTradingCancelUserAccountOrderRequest instantiates a new TradingCancelUserAccountOrderRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTradingCancelUserAccountOrderRequestWithDefaults instantiates a new TradingCancelUserAccountOrderRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransactionsStatus instantiates a new TransactionsStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransactionsStatusWithDefaults instantiates a new TransactionsStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUnderlyingSymbol instantiates a new UnderlyingSymbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUnderlyingSymbolExchange instantiates a new UnderlyingSymbolExchange object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUnderlyingSymbolExchangeWithDefaults instantiates a new UnderlyingSymbolExchange object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUnderlyingSymbolType instantiates a new UnderlyingSymbolType object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUnderlyingSymbolTypeWithDefaults instantiates a new UnderlyingSymbolType object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUnderlyingSymbolWithDefaults instantiates a new UnderlyingSymbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUniversalActivity instantiates a new UniversalActivity object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUniversalActivityCurrency instantiates a new UniversalActivityCurrency object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUniversalActivityCurrencyWithDefaults instantiates a new UniversalActivityCurrency object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUniversalActivityOptionSymbol instantiates a new UniversalActivityOptionSymbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUniversalActivityOptionSymbolWithDefaults instantiates a new UniversalActivityOptionSymbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUniversalActivitySymbol instantiates a new UniversalActivitySymbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUniversalActivitySymbolWithDefaults instantiates a new UniversalActivitySymbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUniversalActivityWithDefaults instantiates a new UniversalActivity object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUniversalSymbol instantiates a new UniversalSymbol object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUniversalSymbolWithDefaults instantiates a new UniversalSymbol object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserIDandSecret instantiates a new UserIDandSecret object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserIDandSecretWithDefaults instantiates a new UserIDandSecret object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUSExchange instantiates a new USExchange object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUSExchangeWithDefaults instantiates a new USExchange object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewValidatedTradeBody instantiates a new ValidatedTradeBody object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewValidatedTradeBodyWithDefaults instantiates a new ValidatedTradeBody object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
stringAsNotionalValue is a convenience function that returns string wrapped in NotionalValue.

# Constants

List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of AccountOrderRecordStatus.
List of ActionStrict.
List of ActionStrict.
List of ActionStrictWithOptions.
List of ActionStrictWithOptions.
List of ActionStrictWithOptions.
List of ActionStrictWithOptions.
List of ActionStrictWithOptions.
List of ActionStrictWithOptions.
List of OrderTypeStrict.
List of OrderTypeStrict.
List of OrderTypeStrict.
List of OrderTypeStrict.
List of TimeInForceStrict.
List of TimeInForceStrict.
List of TimeInForceStrict.

# Variables

All allowed values of AccountOrderRecordStatus enum.
All allowed values of ActionStrict enum.
All allowed values of ActionStrictWithOptions enum.
All allowed values of OrderTypeStrict enum.
All allowed values of TimeInForceStrict enum.
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

Account A single account at a brokerage.
AccountBalance Contains balance related information for the account.
AccountBalanceTotal Total market value of this account (includes cash, equity, fixed income, etc).
AccountHoldings Account Holdings.
AccountHoldingsAccount A wrapper object containing holdings information for a single account.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AccountOrderRecord Describes a single recent order in an account.
AccountOrderRecordOptionSymbol Contains information about the option contract that the order is for.
AccountOrderRecordUniversalSymbol Contains information about the security that the order is for.
AccountSimple A single account at a brokerage.
AccountSyncStatus Contains status update for the account sync process between SnapTrade and the brokerage.
APIClient manages communication with the SnapTrade API v1.0.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AuthenticationLoginSnapTradeUser200Response - struct for AuthenticationLoginSnapTradeUser200Response.
Balance Holds balance information for a single currency in an account.
BalanceCurrency The currency of the balance.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Brokerage Describes a brokerage that SnapTrade supports.
BrokerageAuthorization A single connection with a brokerage.
BrokerageAuthorizationDisabledConfirmation Confirmation that the connection has been disabled.
BrokerageAuthorizationRefreshConfirmation Confirmation that the syncs have been scheduled.
BrokerageAuthorizationTypeReadOnly struct for BrokerageAuthorizationTypeReadOnly.
BrokerageAuthorizationTypeReadOnlyBrokerage struct for BrokerageAuthorizationTypeReadOnlyBrokerage.
BrokerageType Type of brokerage.
Configuration stores the configuration of the API client.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Currency Describes a currency object.
DeleteUserResponse struct for DeleteUserResponse.
DividendAtDate struct for DividendAtDate.
EncryptedResponse This response consists of 2 different components that must be decrypted to obtain the decrypted message * Decrypting the encryptedSharedKey The encrypted shared key is a shared key that was randomly generated by SnapTrade and encrypted using the users SSH public key provided when registering the user It is needed to decrypt the message in step 2.
EncryptedResponseEncryptedMessageData struct for EncryptedResponseEncryptedMessageData.
Exchange Describes a single stock or crypto exchange.
ExchangeRatePairs The exchange rate of a pair of currencies.
FigiInstrument Financial Instrument Global Identifier (FIGI) information for the security.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
HoldingsStatus Status of account holdings sync.
LoginRedirectURI Redirect uri upon successful login.
ManualTrade Contains the details of a submitted order.
ManualTradeAndImpact struct for ManualTradeAndImpact.
ManualTradeBalance Estimated remaining balance of the account after the trade is executed.
ManualTradeForm Inputs for placing an order with the brokerage.
ManualTradeFormNotionalValue struct for ManualTradeFormNotionalValue.
ManualTradeFormWithOptions Inputs for placing an order with the brokerage.
ManualTradeImpact struct for ManualTradeImpact.
ManualTradeSymbol Information about the security for the order.
Model400FailedRequestResponse Example for failed request response.
Model401FailedRequestResponse Example for failed request response.
Model402BrokerageAuthAlreadyDisabledException This connection is already disabled.
Model402BrokerageAuthDisabledResponse Cannot perform action because connection is disabled.
Model403FailedRequestResponse Example for failed request response.
Model403FeatureNotEnabledResponse Example for failed request response.
Model404FailedRequestResponse Example for failed request response.
Model425FailedRequestResponse Example for failed request response.
Model500UnexpectedExceptionResponse Example for a response that failed for unexpected reasons.
MonthlyDividends struct for MonthlyDividends.
NetContributions struct for NetContributions.
NetDividend Object representing total dividends received during a timeframe.
NotionalValue - Total notional amount for the order.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OptionBrokerageSymbol Uniquely describes a security for the option position within an account.
OptionChainInner struct for OptionChainInner.
OptionChainInnerChainPerRootInner struct for OptionChainInnerChainPerRootInner.
OptionChainInnerChainPerRootInnerChainPerStrikePriceInner struct for OptionChainInnerChainPerRootInnerChainPerStrikePriceInner.
OptionLeg Option Leg.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OptionsGetOptionStrategyRequest struct for OptionsGetOptionStrategyRequest.
OptionsPlaceOptionStrategyRequest struct for OptionsPlaceOptionStrategyRequest.
OptionsPosition Describes a single option position in an account.
OptionsPositionCurrency The currency of the price.
OptionsSymbol Uniquely describes an option security + exchange combination across all brokerages.
OptionStrategy struct for OptionStrategy.
OptionStrategyLegsInner struct for OptionStrategyLegsInner.
PartnerData Configurations for your SnapTrade Client ID, including allowed brokerages and data access.
PastValue struct for PastValue.
PerformanceCustom Performance Custom Response Object.
Position Describes a single stock/ETF/crypto/mutual fund position in an account.
PositionSymbol Uniquely describes a security for the position within an account.
RateOfReturnObject Individual rate of return object with return percent and timeframe.
RateOfReturnResponse List of return rates with their timeframe.
RecentOrdersResponse List of orders executed within the last 24 hours.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SecurityType The type of security.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
SessionEvent struct for SessionEvent.
SnapTradeHoldingsAccount SnapTradeUser Investment Account.
SnapTradeHoldingsTotalValue This field is deprecated.
SnapTradeLoginUserRequestBody Data to login a user via SnapTrade Partner.
SnapTradeRegisterUserRequestBody Data required to register a user via SnapTrade Partner.
Status Status of API.
StrategyOrderRecord Strategy order record.
StrategyQuotes struct for StrategyQuotes.
StrategyQuotesGreek struct for StrategyQuotesGreek.
SubPeriodReturnRate struct for SubPeriodReturnRate.
Symbol Uniquely describes a single security + exchange combination across all brokerages.
SymbolCurrency The currency in which the security is traded.
SymbolExchange The exchange on which the security is listed and traded.
SymbolFigiInstrument struct for SymbolFigiInstrument.
SymbolQuery struct for SymbolQuery.
SymbolsQuotesInner struct for SymbolsQuotesInner.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TradingCancelUserAccountOrderRequest struct for TradingCancelUserAccountOrderRequest.
No description provided by the author
No description provided by the author
TransactionsStatus Status of account transaction sync.
UnderlyingSymbol Symbol object for the underlying security of an option.
UnderlyingSymbolExchange The exchange on which the security is listed and traded.
UnderlyingSymbolType The type of security.
UniversalActivity A transaction or activity from an institution.
UniversalActivityCurrency The currency in which the transaction `price` and `amount` is denominated.
UniversalActivityOptionSymbol The option security for the transaction.
UniversalActivitySymbol The security for the transaction.
UniversalSymbol Uniquely describes a single security + exchange combination across all brokerages.
UserIDandSecret struct for UserIDandSecret.
USExchange US Stock Exchange.
ValidatedTradeBody struct for ValidatedTradeBody.

# Type aliases

AccountInformationApiService AccountInformationApi service.
AccountOrderRecordStatus Indicates the status of an order.
ActionStrict The action describes the intent or side of a trade.
ActionStrictWithOptions The action describes the intent or side of a trade.
APIStatusApiService APIStatusApi service.
AuthenticationApiService AuthenticationApi service.
ConnectionsApiService ConnectionsApi service.
OptionsApiService OptionsApi service.
OrderTypeStrict The type of order to place.
ReferenceDataApiService ReferenceDataApi service.
ServerConfigurations stores multiple ServerConfiguration items.
TimeInForceStrict The Time in Force type for the order.
TradingApiService TradingApi service.
TransactionsAndReportingApiService TransactionsAndReportingApi service.