snaptrade

package module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 7, 2026 License: MIT Imports: 27 Imported by: 0

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

// Commercial API key example: registers a SnapTrade user and uses userId/userSecret. SDK support for Personal API key users is coming soon.
package main

import (
	"bufio"
	"crypto/rand"
	"fmt"
	"os"

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

func main() {
	// 1) Initialize a client with your clientID and consumerKey.
	configuration := snaptrade.NewConfiguration()
	configuration.SetPartnerClientId(os.Getenv("SNAPTRADE_CLIENT_ID"))
	configuration.SetConsumerKey(os.Getenv("SNAPTRADE_CONSUMER_KEY"))
	client := snaptrade.NewAPIClient(configuration)

	// 2) Check that the client is able to make a request to the API server.
	apiResponse, _, _ := client.APIStatusApi.Check().Execute()
	fmt.Println(apiResponse)

	// 3) Create a new user on SnapTrade
	userId := generateUUID()
	requestBody := snaptrade.NewSnapTradeRegisterUserRequestBody(userId)
	request := client.AuthenticationApi.RegisterSnapTradeUser(*requestBody)
	registerResponse, _, _ := request.Execute()
	fmt.Println(registerResponse)

	// Note: A user secret is only generated once. It's required to access
	// resources for certain endpoints.
	userSecret := registerResponse.GetUserSecret()

	// 4) Get a redirect URI. Users will need this to connect
	// their brokerage to the SnapTrade server.
	redirectURI, _, _ := client.AuthenticationApi.LoginSnapTradeUser(userId, userSecret).Execute()
	if redirectURI.LoginRedirectURI != nil {
		fmt.Println(redirectURI.LoginRedirectURI.GetRedirectURI())
	} else {
		fmt.Println(redirectURI)
	}

	fmt.Print("Open the link in your browser. When done logging in, press Enter to continue...")
	_, _ = bufio.NewReader(os.Stdin).ReadString('\n')

	// 5) Get a list of connections
	connections, _, _ := client.ConnectionsApi.ListBrokerageAuthorizations(userId, userSecret).Execute()
	fmt.Println(connections)

	// 6) Get a list of accounts for the first connection, if available
	if len(connections) == 0 {
		fmt.Println("No brokerage connections found for the user.")
	} else {
		accounts, _, _ := client.ConnectionsApi.ListBrokerageAuthorizationAccounts(
			connections[0].GetId(),
			userId,
			userSecret,
		).Execute()
		fmt.Println(accounts)
	}

	// 6) Deleting a user
	deleteResp, _, _ := client.AuthenticationApi.DeleteSnapTradeUser(userId).Execute()
	fmt.Println(deleteResp)
}

func generateUUID() string {
	bytes := make([]byte, 16)
	if _, err := rand.Read(bytes); err != nil {
		panic(err)
	}
	bytes[6] = (bytes[6] & 0x0f) | 0x40
	bytes[8] = (bytes[8] & 0x3f) | 0x80
	return fmt.Sprintf("%x-%x-%x-%x-%x", bytes[0:4], bytes[4:6], bytes[6:8], bytes[8:10], bytes[10:])
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountInformationApi GetAccountActivities Get /accounts/{accountId}/activities List account activities
AccountInformationApi GetAccountBalanceHistory Get /accounts/{accountId}/balanceHistory List historical account total value
AccountInformationApi GetAllAccountPositions Get /accounts/{accountId}/positions/all List all account positions
AccountInformationApi GetAllUserHoldings Get /holdings List all accounts for the user, plus balances, positions, and orders for each account.
AccountInformationApi GetUserAccountBalance Get /accounts/{accountId}/balances List account balances
AccountInformationApi GetUserAccountDetails Get /accounts/{accountId} Get account detail
AccountInformationApi GetUserAccountOrderDetail Post /accounts/{accountId}/orders/details Get account order detail
AccountInformationApi GetUserAccountOrders Get /accounts/{accountId}/orders List account orders
AccountInformationApi GetUserAccountPositions Get /accounts/{accountId}/positions List account positions
AccountInformationApi GetUserAccountRecentOrders Get /accounts/{accountId}/recentOrders List account recent orders (last 24 hours only)
AccountInformationApi GetUserAccountReturnRates Get /accounts/{accountId}/returnRates List account rate of returns
AccountInformationApi GetUserHoldings Get /accounts/{accountId}/holdings List account holdings
AccountInformationApi ListUserAccounts Get /accounts List accounts
AccountInformationApi UpdateUserAccount Put /accounts/{accountId} Update details of an investment account
APIStatusApi Check Get / Get API Status
AuthenticationApi DeleteSnapTradeUser Delete /snapTrade/deleteUser Delete user
AuthenticationApi ListSnapTradeUsers Get /snapTrade/listUsers List all users
AuthenticationApi LoginSnapTradeUser Post /snapTrade/login Generate Connection Portal URL
AuthenticationApi RegisterSnapTradeUser Post /snapTrade/registerUser Register user
AuthenticationApi ResetSnapTradeUserSecret Post /snapTrade/resetUserSecret Rotate user secret
ConnectionsApi DeleteConnection Delete /connection/{connectionId} Delete connection
ConnectionsApi DetailBrokerageAuthorization Get /authorizations/{authorizationId} Get connection detail
ConnectionsApi DisableBrokerageAuthorization Post /authorizations/{authorizationId}/disable Force disable connection
ConnectionsApi ListBrokerageAuthorizationAccounts Get /authorizations/{authorizationId}/accounts List accounts for a connection
ConnectionsApi ListBrokerageAuthorizations Get /authorizations List all connections
ConnectionsApi RefreshBrokerageAuthorization Post /authorizations/{authorizationId}/refresh Refresh holdings for a connection
ConnectionsApi RemoveBrokerageAuthorization Delete /authorizations/{authorizationId} Delete connection
ConnectionsApi ReturnRates Get /authorizations/{authorizationId}/returnRates List connection rate of returns
ConnectionsApi SessionEvents Get /sessionEvents Get all session events for a user
ConnectionsApi SyncBrokerageAuthorizationTransactions Post /authorizations/{authorizationId}/transactions/sync Sync transactions for a connection
ExperimentalEndpointsApi AddSubscription Post /snapTrade/tradeDetection/subscriptions Add a Trade Detection subscription
ExperimentalEndpointsApi CancelSubscription Post /snapTrade/tradeDetection/subscriptions/cancel Cancel a Trade Detection subscription
ExperimentalEndpointsApi GetUserAccountOrderDetailV2 Get /accounts/{accountId}/orders/details/v2/{brokerageOrderId} Get account order detail (V2)
ExperimentalEndpointsApi GetUserAccountOrdersV2 Get /accounts/{accountId}/orders/v2 List account orders v2
ExperimentalEndpointsApi GetUserAccountRecentOrdersV2 Get /accounts/{accountId}/recentOrders/v2 List account recent orders (V2, last 24 hours only)
ExperimentalEndpointsApi ListConnectionAccounts Get /connections/{authorizationId}/accounts List accounts for a connection (discriminated union)
ExperimentalEndpointsApi ListSubscriptions Get /snapTrade/tradeDetection/subscriptions List active Trade Detection subscriptions
OptionsApi ListOptionHoldings Get /accounts/{accountId}/options List account option positions
ReferenceDataApi GetCurrencyExchangeRatePair Get /currencies/rates/{currencyPair} Get exchange rate of a currency pair
ReferenceDataApi GetPartnerInfo Get /snapTrade/partners Get Client Info
ReferenceDataApi GetSecurityTypes Get /securityTypes List security types
ReferenceDataApi GetStockExchanges Get /exchanges Get exchanges
ReferenceDataApi GetSymbols Post /symbols Search symbols
ReferenceDataApi GetSymbolsByTicker Get /symbols/{query} Get symbol detail
ReferenceDataApi ListAllBrokerageAuthorizationType Get /brokerageAuthorizationTypes Get all brokerage authorization types
ReferenceDataApi ListAllBrokerageInstruments Get /brokerages/{slug}/instruments Get brokerage instruments
ReferenceDataApi ListAllBrokerages Get /brokerages Get brokerages
ReferenceDataApi ListAllCurrencies Get /currencies Get currencies
ReferenceDataApi ListAllCurrenciesRates Get /currencies/rates Get currency exchange rates
ReferenceDataApi SymbolSearchUserAccount Post /accounts/{accountId}/symbols Search account symbols
TradingApi CancelOrder Post /accounts/{accountId}/trading/cancel Cancel order
TradingApi CancelUserAccountOrder Post /accounts/{accountId}/orders/cancel Cancel equity order
TradingApi GetCryptocurrencyPairQuote Get /accounts/{accountId}/trading/instruments/cryptocurrencyPairs/{instrumentSymbol}/quote Get crypto pair quote
TradingApi GetOptionImpact Post /accounts/{accountId}/trading/options/impact Get option order impact
TradingApi GetOrderImpact Post /trade/impact Check equity order impact
TradingApi GetUserAccountOptionQuotes Get /accounts/{accountId}/quotes/options Get option quote
TradingApi GetUserAccountQuotes Get /accounts/{accountId}/quotes Get equity symbol quotes
TradingApi PlaceBracketOrder Post /accounts/{accountId}/trading/bracket Place bracket order
TradingApi PlaceComplexOrder Post /accounts/{accountId}/trading/complex Place complex order
TradingApi PlaceCryptoOrder Post /accounts/{accountId}/trading/crypto Place crypto order
TradingApi PlaceForceOrder Post /trade/place Place equity order
TradingApi PlaceMlegOrder Post /accounts/{accountId}/trading/options Place option order
TradingApi PlaceOrder Post /trade/{tradeId} Place checked equity order
TradingApi PreviewCryptoOrder Post /accounts/{accountId}/trading/crypto/preview Preview crypto order
TradingApi ReplaceOrder Post /accounts/{accountId}/trading/replace Replace order
TradingApi SearchCryptocurrencyPairInstruments Get /accounts/{accountId}/trading/instruments/cryptocurrencyPairs Get crypto pairs
TransactionsAndReportingApi GetActivities Get /activities Get transaction history for a user
TransactionsAndReportingApi GetReportingCustomRange Get /performance/custom Get performance information for a specific timeframe

Documentation For Models

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)
View Source 
var AllowedAccountOrderRecordStatusEnumValues = []AccountOrderRecordStatus{
	"NONE",
	"PENDING",
	"ACCEPTED",
	"FAILED",
	"REJECTED",
	"CANCELED",
	"PARTIAL_CANCELED",
	"CANCEL_PENDING",
	"EXECUTED",
	"PARTIAL",
	"REPLACE_PENDING",
	"REPLACED",
	"STOPPED",
	"SUSPENDED",
	"EXPIRED",
	"QUEUED",
	"TRIGGERED",
	"ACTIVATED",
	"PENDING_RISK_REVIEW",
	"CONTINGENT_ORDER",
}

All allowed values of AccountOrderRecordStatus enum

View Source 
var AllowedAccountOrderRecordStatusV2EnumValues = []AccountOrderRecordStatusV2{
	"PENDING",
	"REJECTED",
	"CANCELED",
	"CANCEL_PENDING",
	"PARTIAL_CANCELED",
	"EXECUTED",
	"PARTIALLY_EXECUTED",
	"REPLACED",
	"REPLACE_PENDING",
	"EXPIRED",
}

All allowed values of AccountOrderRecordStatusV2 enum

View Source 
var AllowedAccountOrderRecordStatusV2NullableEnumValues = []AccountOrderRecordStatusV2Nullable{
	"PENDING",
	"REJECTED",
	"CANCELED",
	"CANCEL_PENDING",
	"PARTIAL_CANCELED",
	"EXECUTED",
	"PARTIALLY_EXECUTED",
	"REPLACED",
	"REPLACE_PENDING",
	"EXPIRED",
}

All allowed values of AccountOrderRecordStatusV2Nullable enum

View Source 
var AllowedActionStrictEnumValues = []ActionStrict{
	"BUY",
	"SELL",
}

All allowed values of ActionStrict enum

View Source 
var AllowedActionStrictWithOptionsEnumValues = []ActionStrictWithOptions{
	"BUY",
	"SELL",
	"BUY_TO_OPEN",
	"BUY_TO_CLOSE",
	"SELL_TO_OPEN",
	"SELL_TO_CLOSE",
}

All allowed values of ActionStrictWithOptions enum

View Source 
var AllowedManualTradePlaceTimeInForceStrictEnumValues = []ManualTradePlaceTimeInForceStrict{
	"FOK",
	"Day",
	"GTC",
	"IOC",
	"GTD",
}

All allowed values of ManualTradePlaceTimeInForceStrict enum

View Source 
var AllowedMlegActionStrictEnumValues = []MlegActionStrict{
	"BUY",
	"SELL",
	"BUY_TO_OPEN",
	"BUY_TO_CLOSE",
	"SELL_TO_OPEN",
	"SELL_TO_CLOSE",
}

All allowed values of MlegActionStrict enum

View Source 
var AllowedMlegInstrumentTypeEnumValues = []MlegInstrumentType{
	"OPTION",
	"EQUITY",
}

All allowed values of MlegInstrumentType enum

View Source 
var AllowedMlegOrderTypeStrictEnumValues = []MlegOrderTypeStrict{
	"MARKET",
	"LIMIT",
	"STOP_LOSS_MARKET",
	"STOP_LOSS_LIMIT",
}

All allowed values of MlegOrderTypeStrict enum

View Source 
var AllowedMlegPriceEffectStrictEnumValues = []MlegPriceEffectStrict{
	"CREDIT",
	"DEBIT",
	"EVEN",
}

All allowed values of MlegPriceEffectStrict enum

View Source 
var AllowedMlegPriceEffectStrictNullableEnumValues = []MlegPriceEffectStrictNullable{
	"CREDIT",
	"DEBIT",
	"EVEN",
}

All allowed values of MlegPriceEffectStrictNullable enum

View Source 
var AllowedOrderTypeStrictEnumValues = []OrderTypeStrict{
	"Limit",
	"Market",
	"StopLimit",
	"Stop",
}

All allowed values of OrderTypeStrict enum

View Source 
var AllowedTimeInForceStrictEnumValues = []TimeInForceStrict{
	"FOK",
	"Day",
	"GTC",
	"IOC",
}

All allowed values of TimeInForceStrict enum

View Source 
var AllowedTradingSessionEnumValues = []TradingSession{
	"REGULAR",
	"EXTENDED",
}

All allowed values of TradingSession enum

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	AccountInformationApi *AccountInformationApiService

	APIStatusApi *APIStatusApiService

	AuthenticationApi *AuthenticationApiService

	ConnectionsApi *ConnectionsApiService

	ExperimentalEndpointsApi *ExperimentalEndpointsApiService

	OptionsApi *OptionsApiService

	ReferenceDataApi *ReferenceDataApiService

	TradingApi *TradingApiService

	TransactionsAndReportingApi *TransactionsAndReportingApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the SnapTrade API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type APIStatusApiCheckRequest 

type APIStatusApiCheckRequest struct {
	ApiService *APIStatusApiService
	// contains filtered or unexported fields
}

func (APIStatusApiCheckRequest) Execute 

func (r APIStatusApiCheckRequest) Execute() (*Status, *http.Response, error)

type APIStatusApiService 

type APIStatusApiService service

APIStatusApiService APIStatusApi service

func (*APIStatusApiService) Check 

func (a *APIStatusApiService) Check() APIStatusApiCheckRequest

Check Get API Status

Check whether the API is operational and verify timestamps. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return APIStatusApiCheckRequest

func (*APIStatusApiService) CheckExecute 

func (a *APIStatusApiService) CheckExecute(r APIStatusApiCheckRequest) (*Status, *http.Response, error)

Execute executes the request 

@return Status

type Account 

type Account struct {
	// Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated.
	Id string `json:"id"`
	// Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.
	BrokerageAuthorization string `json:"brokerage_authorization"`
	// A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
	Name NullableString `json:"name"`
	// The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
	Number string `json:"number"`
	// A stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.
	InstitutionAccountId NullableString `json:"institution_account_id,omitempty"`
	// The name of the brokerage that holds the account.
	InstitutionName string `json:"institution_name"`
	// Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the brokerage.
	CreatedDate time.Time `json:"created_date"`
	// Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was funded.
	FundingDate NullableTime `json:"funding_date,omitempty"`
	// Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was opened at the brokerage.
	OpeningDate NullableTime      `json:"opening_date,omitempty"`
	SyncStatus  AccountSyncStatus `json:"sync_status"`
	Balance     AccountBalance    `json:"balance"`
	// The current status of the account. Can be either \"open\", \"closed\", \"archived\" or null if the status is unknown or not provided by the brokerage.
	Status NullableString `json:"status,omitempty"`
	// The account type as provided by the brokerage
	RawType NullableString `json:"raw_type,omitempty"`
	// The category of the account, normalized across institutions. Returns `null` if the category could not be determined. Use this field to filter out non-investment accounts if your integration only supports trading / holdings flows. See [Filtering Accounts by Category](https://docs.snaptrade.com/docs/filtering-accounts-by-category) for more information. - `INVESTMENT`: A brokerage / investment account (equities, options, crypto, etc.). - `DEPOSIT`: A bank deposit account (checking, savings). - `LOC`: A line of credit account.
	AccountCategory NullableString `json:"account_category,omitempty"`
	// Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.
	// Deprecated
	Meta map[string]interface{} `json:"meta,omitempty"`
	// Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a use case for it.
	// Deprecated
	PortfolioGroup NullableString `json:"portfolio_group,omitempty"`
	// This field is deprecated.
	// Deprecated
	CashRestrictions []string `json:"cash_restrictions,omitempty"`
	// Indicates whether the account is a paper (simulated) trading account.
	IsPaper              bool `json:"is_paper"`
	AdditionalProperties map[string]interface{}
}

Account A single account at a brokerage.

func NewAccount 

func NewAccount(id string, brokerageAuthorization string, name NullableString, number string, institutionName string, createdDate time.Time, syncStatus AccountSyncStatus, balance AccountBalance, isPaper bool) *Account

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

func NewAccountWithDefaults 

func NewAccountWithDefaults() *Account

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

func (*Account) GetAccountCategory added in v1.0.156 

func (o *Account) GetAccountCategory() string

GetAccountCategory returns the AccountCategory field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Account) GetAccountCategoryOk added in v1.0.156 

func (o *Account) GetAccountCategoryOk() (*string, bool)

GetAccountCategoryOk returns a tuple with the AccountCategory field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Account) GetBalance 

func (o *Account) GetBalance() AccountBalance

GetBalance returns the Balance field value

func (*Account) GetBalanceOk 

func (o *Account) GetBalanceOk() (*AccountBalance, bool)

GetBalanceOk returns a tuple with the Balance field value and a boolean to check if the value has been set.

func (*Account) GetBrokerageAuthorization 

func (o *Account) GetBrokerageAuthorization() string

GetBrokerageAuthorization returns the BrokerageAuthorization field value

func (*Account) GetBrokerageAuthorizationOk 

func (o *Account) GetBrokerageAuthorizationOk() (*string, bool)

GetBrokerageAuthorizationOk returns a tuple with the BrokerageAuthorization field value and a boolean to check if the value has been set.

func (*Account) GetCashRestrictions 

func (o *Account) GetCashRestrictions() []string

GetCashRestrictions returns the CashRestrictions field value if set, zero value otherwise. Deprecated

func (*Account) GetCashRestrictionsOk 

func (o *Account) GetCashRestrictionsOk() ([]string, bool)

GetCashRestrictionsOk returns a tuple with the CashRestrictions field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated

func (*Account) GetCreatedDate 

func (o *Account) GetCreatedDate() time.Time

GetCreatedDate returns the CreatedDate field value

func (*Account) GetCreatedDateOk 

func (o *Account) GetCreatedDateOk() (*time.Time, bool)

GetCreatedDateOk returns a tuple with the CreatedDate field value and a boolean to check if the value has been set.

func (*Account) GetFundingDate added in v1.0.130 

func (o *Account) GetFundingDate() time.Time

GetFundingDate returns the FundingDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Account) GetFundingDateOk added in v1.0.130 

func (o *Account) GetFundingDateOk() (*time.Time, bool)

GetFundingDateOk returns a tuple with the FundingDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Account) GetId 

func (o *Account) GetId() string

GetId returns the Id field value

func (*Account) GetIdOk 

func (o *Account) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*Account) GetInstitutionAccountId added in v1.0.137 

func (o *Account) GetInstitutionAccountId() string

GetInstitutionAccountId returns the InstitutionAccountId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Account) GetInstitutionAccountIdOk added in v1.0.137 

func (o *Account) GetInstitutionAccountIdOk() (*string, bool)

GetInstitutionAccountIdOk returns a tuple with the InstitutionAccountId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Account) GetInstitutionName 

func (o *Account) GetInstitutionName() string

GetInstitutionName returns the InstitutionName field value

func (*Account) GetInstitutionNameOk 

func (o *Account) GetInstitutionNameOk() (*string, bool)

GetInstitutionNameOk returns a tuple with the InstitutionName field value and a boolean to check if the value has been set.

func (*Account) GetIsPaper added in v1.0.121 

func (o *Account) GetIsPaper() bool

GetIsPaper returns the IsPaper field value

func (*Account) GetIsPaperOk added in v1.0.121 

func (o *Account) GetIsPaperOk() (*bool, bool)

GetIsPaperOk returns a tuple with the IsPaper field value and a boolean to check if the value has been set.

func (*Account) GetMeta 

func (o *Account) GetMeta() map[string]interface{}

GetMeta returns the Meta field value if set, zero value otherwise. Deprecated

func (*Account) GetMetaOk 

func (o *Account) GetMetaOk() (map[string]interface{}, bool)

GetMetaOk returns a tuple with the Meta field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated

func (*Account) GetName 

func (o *Account) GetName() string

GetName returns the Name field value If the value is explicit nil, the zero value for string will be returned

func (*Account) GetNameOk 

func (o *Account) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Account) GetNumber 

func (o *Account) GetNumber() string

GetNumber returns the Number field value

func (*Account) GetNumberOk 

func (o *Account) GetNumberOk() (*string, bool)

GetNumberOk returns a tuple with the Number field value and a boolean to check if the value has been set.

func (*Account) GetOpeningDate added in v1.0.130 

func (o *Account) GetOpeningDate() time.Time

GetOpeningDate returns the OpeningDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Account) GetOpeningDateOk added in v1.0.130 

func (o *Account) GetOpeningDateOk() (*time.Time, bool)

GetOpeningDateOk returns a tuple with the OpeningDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Account) GetPortfolioGroup 

func (o *Account) GetPortfolioGroup() string

GetPortfolioGroup returns the PortfolioGroup field value if set, zero value otherwise (both if not set or set to explicit null). Deprecated

func (*Account) GetPortfolioGroupOk 

func (o *Account) GetPortfolioGroupOk() (*string, bool)

GetPortfolioGroupOk returns a tuple with the PortfolioGroup field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned Deprecated

func (*Account) GetRawType added in v1.0.41 

func (o *Account) GetRawType() string

GetRawType returns the RawType field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Account) GetRawTypeOk added in v1.0.41 

func (o *Account) GetRawTypeOk() (*string, bool)

GetRawTypeOk returns a tuple with the RawType field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Account) GetStatus added in v1.0.76 

func (o *Account) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Account) GetStatusOk added in v1.0.76 

func (o *Account) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Account) GetSyncStatus 

func (o *Account) GetSyncStatus() AccountSyncStatus

GetSyncStatus returns the SyncStatus field value

func (*Account) GetSyncStatusOk 

func (o *Account) GetSyncStatusOk() (*AccountSyncStatus, bool)

GetSyncStatusOk returns a tuple with the SyncStatus field value and a boolean to check if the value has been set.

func (*Account) HasAccountCategory added in v1.0.156 

func (o *Account) HasAccountCategory() bool

HasAccountCategory returns a boolean if a field has been set.

func (*Account) HasCashRestrictions 

func (o *Account) HasCashRestrictions() bool

HasCashRestrictions returns a boolean if a field has been set.

func (*Account) HasFundingDate added in v1.0.130 

func (o *Account) HasFundingDate() bool

HasFundingDate returns a boolean if a field has been set.

func (*Account) HasInstitutionAccountId added in v1.0.137 

func (o *Account) HasInstitutionAccountId() bool

HasInstitutionAccountId returns a boolean if a field has been set.

func (*Account) HasMeta 

func (o *Account) HasMeta() bool

HasMeta returns a boolean if a field has been set.

func (*Account) HasOpeningDate added in v1.0.130 

func (o *Account) HasOpeningDate() bool

HasOpeningDate returns a boolean if a field has been set.

func (*Account) HasPortfolioGroup 

func (o *Account) HasPortfolioGroup() bool

HasPortfolioGroup returns a boolean if a field has been set.

func (*Account) HasRawType added in v1.0.41 

func (o *Account) HasRawType() bool

HasRawType returns a boolean if a field has been set.

func (*Account) HasStatus added in v1.0.76 

func (o *Account) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (Account) MarshalJSON 

func (o Account) MarshalJSON() ([]byte, error)

func (*Account) SetAccountCategory added in v1.0.156 

func (o *Account) SetAccountCategory(v string)

SetAccountCategory gets a reference to the given NullableString and assigns it to the AccountCategory field.

func (*Account) SetAccountCategoryNil added in v1.0.156 

func (o *Account) SetAccountCategoryNil()

SetAccountCategoryNil sets the value for AccountCategory to be an explicit nil

func (*Account) SetBalance 

func (o *Account) SetBalance(v AccountBalance)

SetBalance sets field value

func (*Account) SetBrokerageAuthorization 

func (o *Account) SetBrokerageAuthorization(v string)

SetBrokerageAuthorization sets field value

func (*Account) SetCashRestrictions 

func (o *Account) SetCashRestrictions(v []string)

SetCashRestrictions gets a reference to the given []string and assigns it to the CashRestrictions field. Deprecated

func (*Account) SetCreatedDate 

func (o *Account) SetCreatedDate(v time.Time)

SetCreatedDate sets field value

func (*Account) SetFundingDate added in v1.0.130 

func (o *Account) SetFundingDate(v time.Time)

SetFundingDate gets a reference to the given NullableTime and assigns it to the FundingDate field.

func (*Account) SetFundingDateNil added in v1.0.130 

func (o *Account) SetFundingDateNil()

SetFundingDateNil sets the value for FundingDate to be an explicit nil

func (*Account) SetId 

func (o *Account) SetId(v string)

SetId sets field value

func (*Account) SetInstitutionAccountId added in v1.0.137 

func (o *Account) SetInstitutionAccountId(v string)

SetInstitutionAccountId gets a reference to the given NullableString and assigns it to the InstitutionAccountId field.

func (*Account) SetInstitutionAccountIdNil added in v1.0.137 

func (o *Account) SetInstitutionAccountIdNil()

SetInstitutionAccountIdNil sets the value for InstitutionAccountId to be an explicit nil

func (*Account) SetInstitutionName 

func (o *Account) SetInstitutionName(v string)

SetInstitutionName sets field value

func (*Account) SetIsPaper added in v1.0.121 

func (o *Account) SetIsPaper(v bool)

SetIsPaper sets field value

func (*Account) SetMeta 

func (o *Account) SetMeta(v map[string]interface{})

SetMeta gets a reference to the given map[string]interface{} and assigns it to the Meta field. Deprecated

func (*Account) SetName 

func (o *Account) SetName(v string)

SetName sets field value

func (*Account) SetNumber 

func (o *Account) SetNumber(v string)

SetNumber sets field value

func (*Account) SetOpeningDate added in v1.0.130 

func (o *Account) SetOpeningDate(v time.Time)

SetOpeningDate gets a reference to the given NullableTime and assigns it to the OpeningDate field.

func (*Account) SetOpeningDateNil added in v1.0.130 

func (o *Account) SetOpeningDateNil()

SetOpeningDateNil sets the value for OpeningDate to be an explicit nil

func (*Account) SetPortfolioGroup 

func (o *Account) SetPortfolioGroup(v string)

SetPortfolioGroup gets a reference to the given NullableString and assigns it to the PortfolioGroup field. Deprecated

func (*Account) SetPortfolioGroupNil added in v1.0.166 

func (o *Account) SetPortfolioGroupNil()

SetPortfolioGroupNil sets the value for PortfolioGroup to be an explicit nil

func (*Account) SetRawType added in v1.0.41 

func (o *Account) SetRawType(v string)

SetRawType gets a reference to the given NullableString and assigns it to the RawType field.

func (*Account) SetRawTypeNil added in v1.0.41 

func (o *Account) SetRawTypeNil()

SetRawTypeNil sets the value for RawType to be an explicit nil

func (*Account) SetStatus added in v1.0.76 

func (o *Account) SetStatus(v string)

SetStatus gets a reference to the given NullableString and assigns it to the Status field.

func (*Account) SetStatusNil added in v1.0.76 

func (o *Account) SetStatusNil()

SetStatusNil sets the value for Status to be an explicit nil

func (*Account) SetSyncStatus 

func (o *Account) SetSyncStatus(v AccountSyncStatus)

SetSyncStatus sets field value

func (*Account) UnmarshalJSON 

func (o *Account) UnmarshalJSON(bytes []byte) (err error)

func (*Account) UnsetAccountCategory added in v1.0.156 

func (o *Account) UnsetAccountCategory()

UnsetAccountCategory ensures that no value is present for AccountCategory, not even an explicit nil

func (*Account) UnsetFundingDate added in v1.0.130 

func (o *Account) UnsetFundingDate()

UnsetFundingDate ensures that no value is present for FundingDate, not even an explicit nil

func (*Account) UnsetInstitutionAccountId added in v1.0.137 

func (o *Account) UnsetInstitutionAccountId()

UnsetInstitutionAccountId ensures that no value is present for InstitutionAccountId, not even an explicit nil

func (*Account) UnsetOpeningDate added in v1.0.130 

func (o *Account) UnsetOpeningDate()

UnsetOpeningDate ensures that no value is present for OpeningDate, not even an explicit nil

func (*Account) UnsetPortfolioGroup added in v1.0.166 

func (o *Account) UnsetPortfolioGroup()

UnsetPortfolioGroup ensures that no value is present for PortfolioGroup, not even an explicit nil

func (*Account) UnsetRawType added in v1.0.41 

func (o *Account) UnsetRawType()

UnsetRawType ensures that no value is present for RawType, not even an explicit nil

func (*Account) UnsetStatus added in v1.0.76 

func (o *Account) UnsetStatus()

UnsetStatus ensures that no value is present for Status, not even an explicit nil

type AccountBalance 

type AccountBalance struct {
	Total NullableAccountBalanceTotal `json:"total,omitempty"`
}

AccountBalance Contains balance related information for the account.

func NewAccountBalance 

func NewAccountBalance() *AccountBalance

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

func NewAccountBalanceWithDefaults 

func NewAccountBalanceWithDefaults() *AccountBalance

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

func (*AccountBalance) GetTotal 

func (o *AccountBalance) GetTotal() AccountBalanceTotal

GetTotal returns the Total field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountBalance) GetTotalOk 

func (o *AccountBalance) GetTotalOk() (*AccountBalanceTotal, bool)

GetTotalOk returns a tuple with the Total field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountBalance) HasTotal 

func (o *AccountBalance) HasTotal() bool

HasTotal returns a boolean if a field has been set.

func (AccountBalance) MarshalJSON 

func (o AccountBalance) MarshalJSON() ([]byte, error)

func (*AccountBalance) SetTotal 

func (o *AccountBalance) SetTotal(v AccountBalanceTotal)

SetTotal gets a reference to the given NullableAccountBalanceTotal and assigns it to the Total field.

func (*AccountBalance) SetTotalNil 

func (o *AccountBalance) SetTotalNil()

SetTotalNil sets the value for Total to be an explicit nil

func (*AccountBalance) UnsetTotal 

func (o *AccountBalance) UnsetTotal()

UnsetTotal ensures that no value is present for Total, not even an explicit nil

type AccountBalanceTotal 

type AccountBalanceTotal struct {
	// Total value denominated in the currency of the `currency` field.
	Amount *float32 `json:"amount,omitempty"`
	// The ISO-4217 currency code for the amount.
	Currency *string `json:"currency,omitempty"`
}

AccountBalanceTotal Total market value of this account (includes cash, equity, fixed income, etc). This value is directly obtained from the brokerage and should reflect the most accurate value of the account.

func NewAccountBalanceTotal 

func NewAccountBalanceTotal() *AccountBalanceTotal

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

func NewAccountBalanceTotalWithDefaults 

func NewAccountBalanceTotalWithDefaults() *AccountBalanceTotal

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

func (*AccountBalanceTotal) GetAmount 

func (o *AccountBalanceTotal) GetAmount() float32

GetAmount returns the Amount field value if set, zero value otherwise.

func (*AccountBalanceTotal) GetAmountOk 

func (o *AccountBalanceTotal) GetAmountOk() (*float32, bool)

GetAmountOk returns a tuple with the Amount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountBalanceTotal) GetCurrency 

func (o *AccountBalanceTotal) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise.

func (*AccountBalanceTotal) GetCurrencyOk 

func (o *AccountBalanceTotal) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountBalanceTotal) HasAmount 

func (o *AccountBalanceTotal) HasAmount() bool

HasAmount returns a boolean if a field has been set.

func (*AccountBalanceTotal) HasCurrency 

func (o *AccountBalanceTotal) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (AccountBalanceTotal) MarshalJSON 

func (o AccountBalanceTotal) MarshalJSON() ([]byte, error)

func (*AccountBalanceTotal) SetAmount 

func (o *AccountBalanceTotal) SetAmount(v float32)

SetAmount gets a reference to the given float32 and assigns it to the Amount field.

func (*AccountBalanceTotal) SetCurrency 

func (o *AccountBalanceTotal) SetCurrency(v string)

SetCurrency gets a reference to the given string and assigns it to the Currency field.

type AccountHoldings 

type AccountHoldings struct {
	Account   *SnapTradeHoldingsAccount `json:"account,omitempty"`
	Balances  []Balance                 `json:"balances,omitempty"`
	Positions []Position                `json:"positions,omitempty"`
	// Deprecated
	TotalValue           *SnapTradeHoldingsTotalValue `json:"total_value,omitempty"`
	AdditionalProperties map[string]interface{}
}

AccountHoldings Account Holdings

func NewAccountHoldings 

func NewAccountHoldings() *AccountHoldings

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

func NewAccountHoldingsWithDefaults 

func NewAccountHoldingsWithDefaults() *AccountHoldings

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

func (*AccountHoldings) GetAccount 

func (o *AccountHoldings) GetAccount() SnapTradeHoldingsAccount

GetAccount returns the Account field value if set, zero value otherwise.

func (*AccountHoldings) GetAccountOk 

func (o *AccountHoldings) GetAccountOk() (*SnapTradeHoldingsAccount, bool)

GetAccountOk returns a tuple with the Account field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountHoldings) GetBalances 

func (o *AccountHoldings) GetBalances() []Balance

GetBalances returns the Balances field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountHoldings) GetBalancesOk 

func (o *AccountHoldings) GetBalancesOk() ([]Balance, bool)

GetBalancesOk returns a tuple with the Balances field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountHoldings) GetPositions 

func (o *AccountHoldings) GetPositions() []Position

GetPositions returns the Positions field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountHoldings) GetPositionsOk 

func (o *AccountHoldings) GetPositionsOk() ([]Position, bool)

GetPositionsOk returns a tuple with the Positions field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountHoldings) GetTotalValue 

func (o *AccountHoldings) GetTotalValue() SnapTradeHoldingsTotalValue

GetTotalValue returns the TotalValue field value if set, zero value otherwise. Deprecated

func (*AccountHoldings) GetTotalValueOk 

func (o *AccountHoldings) GetTotalValueOk() (*SnapTradeHoldingsTotalValue, bool)

GetTotalValueOk returns a tuple with the TotalValue field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated

func (*AccountHoldings) HasAccount 

func (o *AccountHoldings) HasAccount() bool

HasAccount returns a boolean if a field has been set.

func (*AccountHoldings) HasBalances 

func (o *AccountHoldings) HasBalances() bool

HasBalances returns a boolean if a field has been set.

func (*AccountHoldings) HasPositions 

func (o *AccountHoldings) HasPositions() bool

HasPositions returns a boolean if a field has been set.

func (*AccountHoldings) HasTotalValue 

func (o *AccountHoldings) HasTotalValue() bool

HasTotalValue returns a boolean if a field has been set.

func (AccountHoldings) MarshalJSON 

func (o AccountHoldings) MarshalJSON() ([]byte, error)

func (*AccountHoldings) SetAccount 

func (o *AccountHoldings) SetAccount(v SnapTradeHoldingsAccount)

SetAccount gets a reference to the given SnapTradeHoldingsAccount and assigns it to the Account field.

func (*AccountHoldings) SetBalances 

func (o *AccountHoldings) SetBalances(v []Balance)

SetBalances gets a reference to the given []Balance and assigns it to the Balances field.

func (*AccountHoldings) SetPositions 

func (o *AccountHoldings) SetPositions(v []Position)

SetPositions gets a reference to the given []Position and assigns it to the Positions field.

func (*AccountHoldings) SetTotalValue 

func (o *AccountHoldings) SetTotalValue(v SnapTradeHoldingsTotalValue)

SetTotalValue gets a reference to the given SnapTradeHoldingsTotalValue and assigns it to the TotalValue field. Deprecated

func (*AccountHoldings) UnmarshalJSON 

func (o *AccountHoldings) UnmarshalJSON(bytes []byte) (err error)

type AccountHoldingsAccount 

type AccountHoldingsAccount struct {
	Account *Account `json:"account,omitempty"`
	// List of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
	Balances []Balance `json:"balances,omitempty"`
	// List of stock/ETF/crypto/mutual fund positions in the account.
	Positions []Position `json:"positions,omitempty"`
	// List of option positions in the account.
	OptionPositions []OptionsPosition `json:"option_positions,omitempty"`
	// List of recent orders in the account, including both pending and executed orders. Note that option orders are included in this list. Option orders will have a null `universal_symbol` field and a non-null `option_symbol` field.
	Orders []AccountOrderRecord `json:"orders,omitempty"`
	// Deprecated
	TotalValue           *SnapTradeHoldingsTotalValue `json:"total_value,omitempty"`
	AdditionalProperties map[string]interface{}
}

AccountHoldingsAccount A wrapper object containing holdings information for a single account.

func NewAccountHoldingsAccount 

func NewAccountHoldingsAccount() *AccountHoldingsAccount

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

func NewAccountHoldingsAccountWithDefaults 

func NewAccountHoldingsAccountWithDefaults() *AccountHoldingsAccount

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

func (*AccountHoldingsAccount) GetAccount 

func (o *AccountHoldingsAccount) GetAccount() Account

GetAccount returns the Account field value if set, zero value otherwise.

func (*AccountHoldingsAccount) GetAccountOk 

func (o *AccountHoldingsAccount) GetAccountOk() (*Account, bool)

GetAccountOk returns a tuple with the Account field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountHoldingsAccount) GetBalances 

func (o *AccountHoldingsAccount) GetBalances() []Balance

GetBalances returns the Balances field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountHoldingsAccount) GetBalancesOk 

func (o *AccountHoldingsAccount) GetBalancesOk() ([]Balance, bool)

GetBalancesOk returns a tuple with the Balances field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountHoldingsAccount) GetOptionPositions 

func (o *AccountHoldingsAccount) GetOptionPositions() []OptionsPosition

GetOptionPositions returns the OptionPositions field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountHoldingsAccount) GetOptionPositionsOk 

func (o *AccountHoldingsAccount) GetOptionPositionsOk() ([]OptionsPosition, bool)

GetOptionPositionsOk returns a tuple with the OptionPositions field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountHoldingsAccount) GetOrders 

func (o *AccountHoldingsAccount) GetOrders() []AccountOrderRecord

GetOrders returns the Orders field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountHoldingsAccount) GetOrdersOk 

func (o *AccountHoldingsAccount) GetOrdersOk() ([]AccountOrderRecord, bool)

GetOrdersOk returns a tuple with the Orders field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountHoldingsAccount) GetPositions 

func (o *AccountHoldingsAccount) GetPositions() []Position

GetPositions returns the Positions field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountHoldingsAccount) GetPositionsOk 

func (o *AccountHoldingsAccount) GetPositionsOk() ([]Position, bool)

GetPositionsOk returns a tuple with the Positions field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountHoldingsAccount) GetTotalValue 

func (o *AccountHoldingsAccount) GetTotalValue() SnapTradeHoldingsTotalValue

GetTotalValue returns the TotalValue field value if set, zero value otherwise. Deprecated

func (*AccountHoldingsAccount) GetTotalValueOk 

func (o *AccountHoldingsAccount) GetTotalValueOk() (*SnapTradeHoldingsTotalValue, bool)

GetTotalValueOk returns a tuple with the TotalValue field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated

func (*AccountHoldingsAccount) HasAccount 

func (o *AccountHoldingsAccount) HasAccount() bool

HasAccount returns a boolean if a field has been set.

func (*AccountHoldingsAccount) HasBalances 

func (o *AccountHoldingsAccount) HasBalances() bool

HasBalances returns a boolean if a field has been set.

func (*AccountHoldingsAccount) HasOptionPositions 

func (o *AccountHoldingsAccount) HasOptionPositions() bool

HasOptionPositions returns a boolean if a field has been set.

func (*AccountHoldingsAccount) HasOrders 

func (o *AccountHoldingsAccount) HasOrders() bool

HasOrders returns a boolean if a field has been set.

func (*AccountHoldingsAccount) HasPositions 

func (o *AccountHoldingsAccount) HasPositions() bool

HasPositions returns a boolean if a field has been set.

func (*AccountHoldingsAccount) HasTotalValue 

func (o *AccountHoldingsAccount) HasTotalValue() bool

HasTotalValue returns a boolean if a field has been set.

func (AccountHoldingsAccount) MarshalJSON 

func (o AccountHoldingsAccount) MarshalJSON() ([]byte, error)

func (*AccountHoldingsAccount) SetAccount 

func (o *AccountHoldingsAccount) SetAccount(v Account)

SetAccount gets a reference to the given Account and assigns it to the Account field.

func (*AccountHoldingsAccount) SetBalances 

func (o *AccountHoldingsAccount) SetBalances(v []Balance)

SetBalances gets a reference to the given []Balance and assigns it to the Balances field.

func (*AccountHoldingsAccount) SetOptionPositions 

func (o *AccountHoldingsAccount) SetOptionPositions(v []OptionsPosition)

SetOptionPositions gets a reference to the given []OptionsPosition and assigns it to the OptionPositions field.

func (*AccountHoldingsAccount) SetOrders 

func (o *AccountHoldingsAccount) SetOrders(v []AccountOrderRecord)

SetOrders gets a reference to the given []AccountOrderRecord and assigns it to the Orders field.

func (*AccountHoldingsAccount) SetPositions 

func (o *AccountHoldingsAccount) SetPositions(v []Position)

SetPositions gets a reference to the given []Position and assigns it to the Positions field.

func (*AccountHoldingsAccount) SetTotalValue 

func (o *AccountHoldingsAccount) SetTotalValue(v SnapTradeHoldingsTotalValue)

SetTotalValue gets a reference to the given SnapTradeHoldingsTotalValue and assigns it to the TotalValue field. Deprecated

func (*AccountHoldingsAccount) UnmarshalJSON 

func (o *AccountHoldingsAccount) UnmarshalJSON(bytes []byte) (err error)

type AccountInformationApiGetAccountActivitiesRequest added in v1.0.43 

type AccountInformationApiGetAccountActivitiesRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (*AccountInformationApiGetAccountActivitiesRequest) EndDate added in v1.0.43 

func (r *AccountInformationApiGetAccountActivitiesRequest) EndDate(endDate string) *AccountInformationApiGetAccountActivitiesRequest

The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.

func (AccountInformationApiGetAccountActivitiesRequest) Execute added in v1.0.43 

func (r AccountInformationApiGetAccountActivitiesRequest) Execute() (*PaginatedUniversalActivity, *http.Response, error)

func (*AccountInformationApiGetAccountActivitiesRequest) Limit added in v1.0.46 

func (r *AccountInformationApiGetAccountActivitiesRequest) Limit(limit int32) *AccountInformationApiGetAccountActivitiesRequest

An integer that specifies the maximum number of transactions to return. Default of 1000.

func (*AccountInformationApiGetAccountActivitiesRequest) Offset added in v1.0.46 

func (r *AccountInformationApiGetAccountActivitiesRequest) Offset(offset int32) *AccountInformationApiGetAccountActivitiesRequest

An integer that specifies the starting point of the paginated results. Default is 0.

func (*AccountInformationApiGetAccountActivitiesRequest) StartDate added in v1.0.43 

func (r *AccountInformationApiGetAccountActivitiesRequest) StartDate(startDate string) *AccountInformationApiGetAccountActivitiesRequest

The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.

func (*AccountInformationApiGetAccountActivitiesRequest) Type_ added in v1.0.43 

func (r *AccountInformationApiGetAccountActivitiesRequest) Type_(type_ string) *AccountInformationApiGetAccountActivitiesRequest

Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.

type AccountInformationApiGetAccountBalanceHistoryRequest added in v1.0.160 

type AccountInformationApiGetAccountBalanceHistoryRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiGetAccountBalanceHistoryRequest) Execute added in v1.0.160 

func (r AccountInformationApiGetAccountBalanceHistoryRequest) Execute() (*AccountValueHistoryResponse, *http.Response, error)

type AccountInformationApiGetAllAccountPositionsRequest added in v1.0.163 

type AccountInformationApiGetAllAccountPositionsRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiGetAllAccountPositionsRequest) Execute added in v1.0.163 

func (r AccountInformationApiGetAllAccountPositionsRequest) Execute() (*AllAccountPositionsResponse, *http.Response, error)

type AccountInformationApiGetAllUserHoldingsRequest 

type AccountInformationApiGetAllUserHoldingsRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (*AccountInformationApiGetAllUserHoldingsRequest) BrokerageAuthorizations 

func (r *AccountInformationApiGetAllUserHoldingsRequest) BrokerageAuthorizations(brokerageAuthorizations string) *AccountInformationApiGetAllUserHoldingsRequest

Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).

func (AccountInformationApiGetAllUserHoldingsRequest) Execute 

func (r AccountInformationApiGetAllUserHoldingsRequest) Execute() ([]AccountHoldings, *http.Response, error)

type AccountInformationApiGetUserAccountBalanceRequest 

type AccountInformationApiGetUserAccountBalanceRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiGetUserAccountBalanceRequest) Execute 

func (r AccountInformationApiGetUserAccountBalanceRequest) Execute() ([]Balance, *http.Response, error)

type AccountInformationApiGetUserAccountDetailsRequest 

type AccountInformationApiGetUserAccountDetailsRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiGetUserAccountDetailsRequest) Execute 

func (r AccountInformationApiGetUserAccountDetailsRequest) Execute() (*Account, *http.Response, error)

type AccountInformationApiGetUserAccountOrderDetailRequest added in v1.0.96 

type AccountInformationApiGetUserAccountOrderDetailRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiGetUserAccountOrderDetailRequest) Execute added in v1.0.96 

func (r AccountInformationApiGetUserAccountOrderDetailRequest) Execute() (*AccountOrderRecord, *http.Response, error)

type AccountInformationApiGetUserAccountOrdersRequest 

type AccountInformationApiGetUserAccountOrdersRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (*AccountInformationApiGetUserAccountOrdersRequest) Days 

func (r *AccountInformationApiGetUserAccountOrdersRequest) Days(days int32) *AccountInformationApiGetUserAccountOrdersRequest

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

func (AccountInformationApiGetUserAccountOrdersRequest) Execute 

func (r AccountInformationApiGetUserAccountOrdersRequest) Execute() ([]AccountOrderRecord, *http.Response, error)

func (*AccountInformationApiGetUserAccountOrdersRequest) State 

func (r *AccountInformationApiGetUserAccountOrdersRequest) State(state string) *AccountInformationApiGetUserAccountOrdersRequest

defaults to \"all\"

type AccountInformationApiGetUserAccountPositionsRequest 

type AccountInformationApiGetUserAccountPositionsRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiGetUserAccountPositionsRequest) Execute 

func (r AccountInformationApiGetUserAccountPositionsRequest) Execute() ([]Position, *http.Response, error)

type AccountInformationApiGetUserAccountRecentOrdersRequest added in v1.0.26 

type AccountInformationApiGetUserAccountRecentOrdersRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiGetUserAccountRecentOrdersRequest) Execute added in v1.0.26 

func (r AccountInformationApiGetUserAccountRecentOrdersRequest) Execute() (*RecentOrdersResponse, *http.Response, error)

func (*AccountInformationApiGetUserAccountRecentOrdersRequest) OnlyExecuted added in v1.0.29 

func (r *AccountInformationApiGetUserAccountRecentOrdersRequest) OnlyExecuted(onlyExecuted bool) *AccountInformationApiGetUserAccountRecentOrdersRequest

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

type AccountInformationApiGetUserAccountReturnRatesRequest added in v1.0.27 

type AccountInformationApiGetUserAccountReturnRatesRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiGetUserAccountReturnRatesRequest) Execute added in v1.0.27 

func (r AccountInformationApiGetUserAccountReturnRatesRequest) Execute() (*RateOfReturnResponse, *http.Response, error)

func (*AccountInformationApiGetUserAccountReturnRatesRequest) Timeframes added in v1.0.153 

func (r *AccountInformationApiGetUserAccountReturnRatesRequest) Timeframes(timeframes string) *AccountInformationApiGetUserAccountReturnRatesRequest

Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.

type AccountInformationApiGetUserHoldingsRequest 

type AccountInformationApiGetUserHoldingsRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiGetUserHoldingsRequest) Execute 

func (r AccountInformationApiGetUserHoldingsRequest) Execute() (*AccountHoldingsAccount, *http.Response, error)

type AccountInformationApiListUserAccountsRequest 

type AccountInformationApiListUserAccountsRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiListUserAccountsRequest) Execute 

func (r AccountInformationApiListUserAccountsRequest) Execute() ([]Account, *http.Response, error)

type AccountInformationApiService 

type AccountInformationApiService service

AccountInformationApiService AccountInformationApi service

func (*AccountInformationApiService) GetAccountActivities added in v1.0.43 

func (a *AccountInformationApiService) GetAccountActivities(accountId string, userId string, userSecret string) AccountInformationApiGetAccountActivitiesRequest

GetAccountActivities List account activities

This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`.

Returns all historical transactions for the specified account.

This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.

Transaction are returned in reverse chronological order, using the `trade_date` field.

This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param accountId
@param userId
@param userSecret
@return AccountInformationApiGetAccountActivitiesRequest

func (*AccountInformationApiService) GetAccountActivitiesExecute added in v1.0.43 

func (a *AccountInformationApiService) GetAccountActivitiesExecute(r AccountInformationApiGetAccountActivitiesRequest) (*PaginatedUniversalActivity, *http.Response, error)

Execute executes the request 

@return PaginatedUniversalActivity

func (*AccountInformationApiService) GetAccountBalanceHistory added in v1.0.160 

func (a *AccountInformationApiService) GetAccountBalanceHistory(userId string, userSecret string, accountId string) AccountInformationApiGetAccountBalanceHistoryRequest

GetAccountBalanceHistory List historical account total value

An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId
@return AccountInformationApiGetAccountBalanceHistoryRequest

func (*AccountInformationApiService) GetAccountBalanceHistoryExecute added in v1.0.160 

func (a *AccountInformationApiService) GetAccountBalanceHistoryExecute(r AccountInformationApiGetAccountBalanceHistoryRequest) (*AccountValueHistoryResponse, *http.Response, error)

Execute executes the request 

@return AccountValueHistoryResponse

func (*AccountInformationApiService) GetAllAccountPositions added in v1.0.163 

func (a *AccountInformationApiService) GetAllAccountPositions(userId string, userSecret string, accountId string) AccountInformationApiGetAllAccountPositionsRequest

GetAllAccountPositions List all account positions

Returns a list of all positions in the specified account.

The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.

`mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId
@return AccountInformationApiGetAllAccountPositionsRequest

func (*AccountInformationApiService) GetAllAccountPositionsExecute added in v1.0.163 

func (a *AccountInformationApiService) GetAllAccountPositionsExecute(r AccountInformationApiGetAllAccountPositionsRequest) (*AllAccountPositionsResponse, *http.Response, error)

Execute executes the request 

@return AllAccountPositionsResponse

func (*AccountInformationApiService) GetAllUserHoldings 

func (a *AccountInformationApiService) GetAllUserHoldings(userId string, userSecret string) AccountInformationApiGetAllUserHoldingsRequest

GetAllUserHoldings List all accounts for the user, plus balances, positions, and orders for each account.

**Deprecated.** Use the account-specific holdings endpoint instead.

This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.

List all accounts for the user, plus balances, positions, and orders for each account. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@return AccountInformationApiGetAllUserHoldingsRequest

Deprecated

func (*AccountInformationApiService) GetAllUserHoldingsExecute 

func (a *AccountInformationApiService) GetAllUserHoldingsExecute(r AccountInformationApiGetAllUserHoldingsRequest) ([]AccountHoldings, *http.Response, error)

Execute executes the request 

@return []AccountHoldings

Deprecated

func (*AccountInformationApiService) GetUserAccountBalance 

func (a *AccountInformationApiService) GetUserAccountBalance(userId string, userSecret string, accountId string) AccountInformationApiGetUserAccountBalanceRequest

GetUserAccountBalance List account balances

Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:

  • If you do, this endpoint returns real-time data.
  • If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId
@return AccountInformationApiGetUserAccountBalanceRequest

func (*AccountInformationApiService) GetUserAccountBalanceExecute 

func (a *AccountInformationApiService) GetUserAccountBalanceExecute(r AccountInformationApiGetUserAccountBalanceRequest) ([]Balance, *http.Response, error)

Execute executes the request 

@return []Balance

func (*AccountInformationApiService) GetUserAccountDetails 

func (a *AccountInformationApiService) GetUserAccountDetails(userId string, userSecret string, accountId string) AccountInformationApiGetUserAccountDetailsRequest

GetUserAccountDetails Get account detail

Returns account detail known to SnapTrade for the specified account.

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:

  • If you do, this endpoint returns real-time data.
  • If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId
@return AccountInformationApiGetUserAccountDetailsRequest

func (*AccountInformationApiService) GetUserAccountDetailsExecute 

func (a *AccountInformationApiService) GetUserAccountDetailsExecute(r AccountInformationApiGetUserAccountDetailsRequest) (*Account, *http.Response, error)

Execute executes the request 

@return Account

func (*AccountInformationApiService) GetUserAccountOrderDetail added in v1.0.96 

func (a *AccountInformationApiService) GetUserAccountOrderDetail(accountId string, userId string, userSecret string, accountInformationGetUserAccountOrderDetailRequest AccountInformationGetUserAccountOrderDetailRequest) AccountInformationApiGetUserAccountOrderDetailRequest

GetUserAccountOrderDetail Get account order detail

Returns the detail of a single order using the external order ID provided in the request body.

This endpoint only works for single-leg orders at this time. Support for multi-leg orders will be added in the future.

This endpoint is always realtime and does not rely on cached data.

This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param accountId
@param userId
@param userSecret
@param accountInformationGetUserAccountOrderDetailRequest
@return AccountInformationApiGetUserAccountOrderDetailRequest

func (*AccountInformationApiService) GetUserAccountOrderDetailExecute added in v1.0.96 

func (a *AccountInformationApiService) GetUserAccountOrderDetailExecute(r AccountInformationApiGetUserAccountOrderDetailRequest) (*AccountOrderRecord, *http.Response, error)

Execute executes the request 

@return AccountOrderRecord

func (*AccountInformationApiService) GetUserAccountOrders 

func (a *AccountInformationApiService) GetUserAccountOrders(userId string, userSecret string, accountId string) AccountInformationApiGetUserAccountOrdersRequest

GetUserAccountOrders List account orders

Returns a list of recent orders in the specified account.

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:

  • If you do, this endpoint returns real-time data.
  • If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId
@return AccountInformationApiGetUserAccountOrdersRequest

func (*AccountInformationApiService) GetUserAccountOrdersExecute 

func (a *AccountInformationApiService) GetUserAccountOrdersExecute(r AccountInformationApiGetUserAccountOrdersRequest) ([]AccountOrderRecord, *http.Response, error)

Execute executes the request 

@return []AccountOrderRecord

func (*AccountInformationApiService) GetUserAccountPositions 

func (a *AccountInformationApiService) GetUserAccountPositions(userId string, userSecret string, accountId string) AccountInformationApiGetUserAccountPositionsRequest

GetUserAccountPositions List account positions

**Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.

Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:

  • If you do, this endpoint returns real-time data.
  • If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId
@return AccountInformationApiGetUserAccountPositionsRequest

Deprecated

func (*AccountInformationApiService) GetUserAccountPositionsExecute 

func (a *AccountInformationApiService) GetUserAccountPositionsExecute(r AccountInformationApiGetUserAccountPositionsRequest) ([]Position, *http.Response, error)

Execute executes the request 

@return []Position

Deprecated

func (*AccountInformationApiService) GetUserAccountRecentOrders added in v1.0.26 

func (a *AccountInformationApiService) GetUserAccountRecentOrders(userId string, userSecret string, accountId string) AccountInformationApiGetUserAccountRecentOrdersRequest

GetUserAccountRecentOrders List account recent orders (last 24 hours only)

A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId
@return AccountInformationApiGetUserAccountRecentOrdersRequest

func (*AccountInformationApiService) GetUserAccountRecentOrdersExecute added in v1.0.26 

func (a *AccountInformationApiService) GetUserAccountRecentOrdersExecute(r AccountInformationApiGetUserAccountRecentOrdersRequest) (*RecentOrdersResponse, *http.Response, error)

Execute executes the request 

@return RecentOrdersResponse

func (*AccountInformationApiService) GetUserAccountReturnRates added in v1.0.27 

func (a *AccountInformationApiService) GetUserAccountReturnRates(userId string, userSecret string, accountId string) AccountInformationApiGetUserAccountReturnRatesRequest

GetUserAccountReturnRates List account rate of returns

Returns a list of rate of return percents for a given account. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId
@return AccountInformationApiGetUserAccountReturnRatesRequest

func (*AccountInformationApiService) GetUserAccountReturnRatesExecute added in v1.0.27 

func (a *AccountInformationApiService) GetUserAccountReturnRatesExecute(r AccountInformationApiGetUserAccountReturnRatesRequest) (*RateOfReturnResponse, *http.Response, error)

Execute executes the request 

@return RateOfReturnResponse

func (*AccountInformationApiService) GetUserHoldings 

func (a *AccountInformationApiService) GetUserHoldings(accountId string, userId string, userSecret string) AccountInformationApiGetUserHoldingsRequest

GetUserHoldings List account holdings

**Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).

This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.

Returns a list of balances, positions, and recent orders for the specified account.

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:

  • If you do, this endpoint returns real-time data.
  • If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param accountId
@param userId
@param userSecret
@return AccountInformationApiGetUserHoldingsRequest

Deprecated

func (*AccountInformationApiService) GetUserHoldingsExecute 

func (a *AccountInformationApiService) GetUserHoldingsExecute(r AccountInformationApiGetUserHoldingsRequest) (*AccountHoldingsAccount, *http.Response, error)

Execute executes the request 

@return AccountHoldingsAccount

Deprecated

func (*AccountInformationApiService) ListUserAccounts 

func (a *AccountInformationApiService) ListUserAccounts(userId string, userSecret string) AccountInformationApiListUserAccountsRequest

ListUserAccounts List accounts

Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.

This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@return AccountInformationApiListUserAccountsRequest

func (*AccountInformationApiService) ListUserAccountsExecute 

func (a *AccountInformationApiService) ListUserAccountsExecute(r AccountInformationApiListUserAccountsRequest) ([]Account, *http.Response, error)

Execute executes the request 

@return []Account

func (*AccountInformationApiService) UpdateUserAccount 

func (a *AccountInformationApiService) UpdateUserAccount(userId string, userSecret string, accountId string) AccountInformationApiUpdateUserAccountRequest

UpdateUserAccount Update details of an investment account

Updates various properties of a specified account. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId The ID of the account to update.
@return AccountInformationApiUpdateUserAccountRequest

func (*AccountInformationApiService) UpdateUserAccountExecute 

func (a *AccountInformationApiService) UpdateUserAccountExecute(r AccountInformationApiUpdateUserAccountRequest) ([]Account, *http.Response, error)

Execute executes the request 

@return []Account

type AccountInformationApiUpdateUserAccountRequest 

type AccountInformationApiUpdateUserAccountRequest struct {
	ApiService *AccountInformationApiService
	// contains filtered or unexported fields
}

func (AccountInformationApiUpdateUserAccountRequest) Execute 

func (r AccountInformationApiUpdateUserAccountRequest) Execute() ([]Account, *http.Response, error)

type AccountInformationGetUserAccountOrderDetailRequest added in v1.0.100 

type AccountInformationGetUserAccountOrderDetailRequest struct {
	// Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
	BrokerageOrderId string `json:"brokerage_order_id"`
}

AccountInformationGetUserAccountOrderDetailRequest struct for AccountInformationGetUserAccountOrderDetailRequest

func NewAccountInformationGetUserAccountOrderDetailRequest added in v1.0.100 

func NewAccountInformationGetUserAccountOrderDetailRequest(brokerageOrderId string) *AccountInformationGetUserAccountOrderDetailRequest

NewAccountInformationGetUserAccountOrderDetailRequest instantiates a new AccountInformationGetUserAccountOrderDetailRequest 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

func NewAccountInformationGetUserAccountOrderDetailRequestWithDefaults added in v1.0.100 

func NewAccountInformationGetUserAccountOrderDetailRequestWithDefaults() *AccountInformationGetUserAccountOrderDetailRequest

NewAccountInformationGetUserAccountOrderDetailRequestWithDefaults instantiates a new AccountInformationGetUserAccountOrderDetailRequest 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

func (*AccountInformationGetUserAccountOrderDetailRequest) GetBrokerageOrderId added in v1.0.102 

func (o *AccountInformationGetUserAccountOrderDetailRequest) GetBrokerageOrderId() string

GetBrokerageOrderId returns the BrokerageOrderId field value

func (*AccountInformationGetUserAccountOrderDetailRequest) GetBrokerageOrderIdOk added in v1.0.102 

func (o *AccountInformationGetUserAccountOrderDetailRequest) GetBrokerageOrderIdOk() (*string, bool)

GetBrokerageOrderIdOk returns a tuple with the BrokerageOrderId field value and a boolean to check if the value has been set.

func (AccountInformationGetUserAccountOrderDetailRequest) MarshalJSON added in v1.0.100 

func (o AccountInformationGetUserAccountOrderDetailRequest) MarshalJSON() ([]byte, error)

func (*AccountInformationGetUserAccountOrderDetailRequest) SetBrokerageOrderId added in v1.0.102 

func (o *AccountInformationGetUserAccountOrderDetailRequest) SetBrokerageOrderId(v string)

SetBrokerageOrderId sets field value

type AccountOrderRecord 

type AccountOrderRecord struct {
	// Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
	BrokerageOrderId *string `json:"brokerage_order_id,omitempty"`
	// The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier.
	BrokerageGroupOrderId NullableString `json:"brokerage_group_order_id,omitempty"`
	// The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders.
	OrderRole            NullableString                  `json:"order_role,omitempty"`
	Status               *AccountOrderRecordStatus       `json:"status,omitempty"`
	UniversalSymbol      NullableUniversalSymbolNullable `json:"universal_symbol,omitempty"`
	OptionSymbol         NullableOptionsSymbolNullable   `json:"option_symbol,omitempty"`
	QuoteUniversalSymbol NullableUniversalSymbolNullable `json:"quote_universal_symbol,omitempty"`
	QuoteCurrency        NullableCurrencyNullable        `json:"quote_currency,omitempty"`
	// The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage.   - BUY   - SELL   - BUY_COVER   - SELL_SHORT   - BUY_OPEN   - BUY_CLOSE   - SELL_OPEN   - SELL_CLOSE
	Action *string `json:"action,omitempty"`
	// The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
	TotalQuantity NullableString `json:"total_quantity,omitempty"`
	// The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
	OpenQuantity NullableString `json:"open_quantity,omitempty"`
	// The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
	CanceledQuantity NullableString `json:"canceled_quantity,omitempty"`
	// The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
	FilledQuantity NullableString `json:"filled_quantity,omitempty"`
	// The price at which the order was executed. For option orders, this represents the price per share.
	ExecutionPrice NullableFloat64 `json:"execution_price,omitempty"`
	// The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. For option orders, this represents the price per share.
	LimitPrice NullableFloat64 `json:"limit_price,omitempty"`
	// The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. For option orders, this represents the price per share.
	StopPrice    NullableFloat64              `json:"stop_price,omitempty"`
	TrailingStop NullableTrailingStopNullable `json:"trailing_stop,omitempty"`
	// The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value.
	OrderType NullableString `json:"order_type,omitempty"`
	// The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value.   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date.   - `MOO` - Market On Open. The order is to be executed at the day's opening price.   - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close.
	TimeInForce *string `json:"time_in_force,omitempty"`
	// The time the order was placed. This is the time the order was submitted to the brokerage.
	TimePlaced *time.Time `json:"time_placed,omitempty"`
	// The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
	TimeUpdated NullableTime `json:"time_updated,omitempty"`
	// The time the order was executed in the brokerage system. This value is not always available from the brokerage.
	TimeExecuted NullableTime `json:"time_executed,omitempty"`
	// The time the order expires. This value is not always available from the brokerage.
	ExpiryDate NullableTime `json:"expiry_date,omitempty"`
	// A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
	// Deprecated
	Symbol                 *string                                `json:"symbol,omitempty"`
	ChildBrokerageOrderIds NullableChildBrokerageOrderIDsNullable `json:"child_brokerage_order_ids,omitempty"`
	AdditionalProperties   map[string]interface{}
}

AccountOrderRecord Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records.

func NewAccountOrderRecord 

func NewAccountOrderRecord() *AccountOrderRecord

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

func NewAccountOrderRecordWithDefaults 

func NewAccountOrderRecordWithDefaults() *AccountOrderRecord

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

func (*AccountOrderRecord) GetAction 

func (o *AccountOrderRecord) GetAction() string

GetAction returns the Action field value if set, zero value otherwise.

func (*AccountOrderRecord) GetActionOk 

func (o *AccountOrderRecord) GetActionOk() (*string, bool)

GetActionOk returns a tuple with the Action field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecord) GetBrokerageGroupOrderId added in v1.0.159 

func (o *AccountOrderRecord) GetBrokerageGroupOrderId() string

GetBrokerageGroupOrderId returns the BrokerageGroupOrderId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetBrokerageGroupOrderIdOk added in v1.0.159 

func (o *AccountOrderRecord) GetBrokerageGroupOrderIdOk() (*string, bool)

GetBrokerageGroupOrderIdOk returns a tuple with the BrokerageGroupOrderId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetBrokerageOrderId 

func (o *AccountOrderRecord) GetBrokerageOrderId() string

GetBrokerageOrderId returns the BrokerageOrderId field value if set, zero value otherwise.

func (*AccountOrderRecord) GetBrokerageOrderIdOk 

func (o *AccountOrderRecord) GetBrokerageOrderIdOk() (*string, bool)

GetBrokerageOrderIdOk returns a tuple with the BrokerageOrderId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecord) GetCanceledQuantity 

func (o *AccountOrderRecord) GetCanceledQuantity() string

GetCanceledQuantity returns the CanceledQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetCanceledQuantityOk 

func (o *AccountOrderRecord) GetCanceledQuantityOk() (*string, bool)

GetCanceledQuantityOk returns a tuple with the CanceledQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetChildBrokerageOrderIds added in v1.0.55 

func (o *AccountOrderRecord) GetChildBrokerageOrderIds() ChildBrokerageOrderIDsNullable

GetChildBrokerageOrderIds returns the ChildBrokerageOrderIds field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetChildBrokerageOrderIdsOk added in v1.0.55 

func (o *AccountOrderRecord) GetChildBrokerageOrderIdsOk() (*ChildBrokerageOrderIDsNullable, bool)

GetChildBrokerageOrderIdsOk returns a tuple with the ChildBrokerageOrderIds field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetExecutionPrice 

func (o *AccountOrderRecord) GetExecutionPrice() float64

GetExecutionPrice returns the ExecutionPrice field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetExecutionPriceOk 

func (o *AccountOrderRecord) GetExecutionPriceOk() (*float64, bool)

GetExecutionPriceOk returns a tuple with the ExecutionPrice field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetExpiryDate 

func (o *AccountOrderRecord) GetExpiryDate() time.Time

GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetExpiryDateOk 

func (o *AccountOrderRecord) GetExpiryDateOk() (*time.Time, bool)

GetExpiryDateOk returns a tuple with the ExpiryDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetFilledQuantity 

func (o *AccountOrderRecord) GetFilledQuantity() string

GetFilledQuantity returns the FilledQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetFilledQuantityOk 

func (o *AccountOrderRecord) GetFilledQuantityOk() (*string, bool)

GetFilledQuantityOk returns a tuple with the FilledQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetLimitPrice 

func (o *AccountOrderRecord) GetLimitPrice() float64

GetLimitPrice returns the LimitPrice field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetLimitPriceOk 

func (o *AccountOrderRecord) GetLimitPriceOk() (*float64, bool)

GetLimitPriceOk returns a tuple with the LimitPrice field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetOpenQuantity 

func (o *AccountOrderRecord) GetOpenQuantity() string

GetOpenQuantity returns the OpenQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetOpenQuantityOk 

func (o *AccountOrderRecord) GetOpenQuantityOk() (*string, bool)

GetOpenQuantityOk returns a tuple with the OpenQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetOptionSymbol 

func (o *AccountOrderRecord) GetOptionSymbol() OptionsSymbolNullable

GetOptionSymbol returns the OptionSymbol field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetOptionSymbolOk 

func (o *AccountOrderRecord) GetOptionSymbolOk() (*OptionsSymbolNullable, bool)

GetOptionSymbolOk returns a tuple with the OptionSymbol field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetOrderRole added in v1.0.159 

func (o *AccountOrderRecord) GetOrderRole() string

GetOrderRole returns the OrderRole field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetOrderRoleOk added in v1.0.159 

func (o *AccountOrderRecord) GetOrderRoleOk() (*string, bool)

GetOrderRoleOk returns a tuple with the OrderRole field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetOrderType 

func (o *AccountOrderRecord) GetOrderType() string

GetOrderType returns the OrderType field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetOrderTypeOk 

func (o *AccountOrderRecord) GetOrderTypeOk() (*string, bool)

GetOrderTypeOk returns a tuple with the OrderType field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetQuoteCurrency added in v1.0.58 

func (o *AccountOrderRecord) GetQuoteCurrency() CurrencyNullable

GetQuoteCurrency returns the QuoteCurrency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetQuoteCurrencyOk added in v1.0.58 

func (o *AccountOrderRecord) GetQuoteCurrencyOk() (*CurrencyNullable, bool)

GetQuoteCurrencyOk returns a tuple with the QuoteCurrency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetQuoteUniversalSymbol added in v1.0.58 

func (o *AccountOrderRecord) GetQuoteUniversalSymbol() UniversalSymbolNullable

GetQuoteUniversalSymbol returns the QuoteUniversalSymbol field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetQuoteUniversalSymbolOk added in v1.0.58 

func (o *AccountOrderRecord) GetQuoteUniversalSymbolOk() (*UniversalSymbolNullable, bool)

GetQuoteUniversalSymbolOk returns a tuple with the QuoteUniversalSymbol field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetStatus 

func (o *AccountOrderRecord) GetStatus() AccountOrderRecordStatus

GetStatus returns the Status field value if set, zero value otherwise.

func (*AccountOrderRecord) GetStatusOk 

func (o *AccountOrderRecord) GetStatusOk() (*AccountOrderRecordStatus, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecord) GetStopPrice 

func (o *AccountOrderRecord) GetStopPrice() float64

GetStopPrice returns the StopPrice field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetStopPriceOk 

func (o *AccountOrderRecord) GetStopPriceOk() (*float64, bool)

GetStopPriceOk returns a tuple with the StopPrice field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetSymbol 

func (o *AccountOrderRecord) GetSymbol() string

GetSymbol returns the Symbol field value if set, zero value otherwise. Deprecated

func (*AccountOrderRecord) GetSymbolOk 

func (o *AccountOrderRecord) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated

func (*AccountOrderRecord) GetTimeExecuted 

func (o *AccountOrderRecord) GetTimeExecuted() time.Time

GetTimeExecuted returns the TimeExecuted field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetTimeExecutedOk 

func (o *AccountOrderRecord) GetTimeExecutedOk() (*time.Time, bool)

GetTimeExecutedOk returns a tuple with the TimeExecuted field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetTimeInForce 

func (o *AccountOrderRecord) GetTimeInForce() string

GetTimeInForce returns the TimeInForce field value if set, zero value otherwise.

func (*AccountOrderRecord) GetTimeInForceOk 

func (o *AccountOrderRecord) GetTimeInForceOk() (*string, bool)

GetTimeInForceOk returns a tuple with the TimeInForce field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecord) GetTimePlaced 

func (o *AccountOrderRecord) GetTimePlaced() time.Time

GetTimePlaced returns the TimePlaced field value if set, zero value otherwise.

func (*AccountOrderRecord) GetTimePlacedOk 

func (o *AccountOrderRecord) GetTimePlacedOk() (*time.Time, bool)

GetTimePlacedOk returns a tuple with the TimePlaced field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecord) GetTimeUpdated 

func (o *AccountOrderRecord) GetTimeUpdated() time.Time

GetTimeUpdated returns the TimeUpdated field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetTimeUpdatedOk 

func (o *AccountOrderRecord) GetTimeUpdatedOk() (*time.Time, bool)

GetTimeUpdatedOk returns a tuple with the TimeUpdated field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetTotalQuantity 

func (o *AccountOrderRecord) GetTotalQuantity() string

GetTotalQuantity returns the TotalQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetTotalQuantityOk 

func (o *AccountOrderRecord) GetTotalQuantityOk() (*string, bool)

GetTotalQuantityOk returns a tuple with the TotalQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetTrailingStop added in v1.0.150 

func (o *AccountOrderRecord) GetTrailingStop() TrailingStopNullable

GetTrailingStop returns the TrailingStop field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetTrailingStopOk added in v1.0.150 

func (o *AccountOrderRecord) GetTrailingStopOk() (*TrailingStopNullable, bool)

GetTrailingStopOk returns a tuple with the TrailingStop field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) GetUniversalSymbol 

func (o *AccountOrderRecord) GetUniversalSymbol() UniversalSymbolNullable

GetUniversalSymbol returns the UniversalSymbol field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecord) GetUniversalSymbolOk 

func (o *AccountOrderRecord) GetUniversalSymbolOk() (*UniversalSymbolNullable, bool)

GetUniversalSymbolOk returns a tuple with the UniversalSymbol field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecord) HasAction 

func (o *AccountOrderRecord) HasAction() bool

HasAction returns a boolean if a field has been set.

func (*AccountOrderRecord) HasBrokerageGroupOrderId added in v1.0.159 

func (o *AccountOrderRecord) HasBrokerageGroupOrderId() bool

HasBrokerageGroupOrderId returns a boolean if a field has been set.

func (*AccountOrderRecord) HasBrokerageOrderId 

func (o *AccountOrderRecord) HasBrokerageOrderId() bool

HasBrokerageOrderId returns a boolean if a field has been set.

func (*AccountOrderRecord) HasCanceledQuantity 

func (o *AccountOrderRecord) HasCanceledQuantity() bool

HasCanceledQuantity returns a boolean if a field has been set.

func (*AccountOrderRecord) HasChildBrokerageOrderIds added in v1.0.55 

func (o *AccountOrderRecord) HasChildBrokerageOrderIds() bool

HasChildBrokerageOrderIds returns a boolean if a field has been set.

func (*AccountOrderRecord) HasExecutionPrice 

func (o *AccountOrderRecord) HasExecutionPrice() bool

HasExecutionPrice returns a boolean if a field has been set.

func (*AccountOrderRecord) HasExpiryDate 

func (o *AccountOrderRecord) HasExpiryDate() bool

HasExpiryDate returns a boolean if a field has been set.

func (*AccountOrderRecord) HasFilledQuantity 

func (o *AccountOrderRecord) HasFilledQuantity() bool

HasFilledQuantity returns a boolean if a field has been set.

func (*AccountOrderRecord) HasLimitPrice 

func (o *AccountOrderRecord) HasLimitPrice() bool

HasLimitPrice returns a boolean if a field has been set.

func (*AccountOrderRecord) HasOpenQuantity 

func (o *AccountOrderRecord) HasOpenQuantity() bool

HasOpenQuantity returns a boolean if a field has been set.

func (*AccountOrderRecord) HasOptionSymbol 

func (o *AccountOrderRecord) HasOptionSymbol() bool

HasOptionSymbol returns a boolean if a field has been set.

func (*AccountOrderRecord) HasOrderRole added in v1.0.159 

func (o *AccountOrderRecord) HasOrderRole() bool

HasOrderRole returns a boolean if a field has been set.

func (*AccountOrderRecord) HasOrderType 

func (o *AccountOrderRecord) HasOrderType() bool

HasOrderType returns a boolean if a field has been set.

func (*AccountOrderRecord) HasQuoteCurrency added in v1.0.58 

func (o *AccountOrderRecord) HasQuoteCurrency() bool

HasQuoteCurrency returns a boolean if a field has been set.

func (*AccountOrderRecord) HasQuoteUniversalSymbol added in v1.0.58 

func (o *AccountOrderRecord) HasQuoteUniversalSymbol() bool

HasQuoteUniversalSymbol returns a boolean if a field has been set.

func (*AccountOrderRecord) HasStatus 

func (o *AccountOrderRecord) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*AccountOrderRecord) HasStopPrice 

func (o *AccountOrderRecord) HasStopPrice() bool

HasStopPrice returns a boolean if a field has been set.

func (*AccountOrderRecord) HasSymbol 

func (o *AccountOrderRecord) HasSymbol() bool

HasSymbol returns a boolean if a field has been set.

func (*AccountOrderRecord) HasTimeExecuted 

func (o *AccountOrderRecord) HasTimeExecuted() bool

HasTimeExecuted returns a boolean if a field has been set.

func (*AccountOrderRecord) HasTimeInForce 

func (o *AccountOrderRecord) HasTimeInForce() bool

HasTimeInForce returns a boolean if a field has been set.

func (*AccountOrderRecord) HasTimePlaced 

func (o *AccountOrderRecord) HasTimePlaced() bool

HasTimePlaced returns a boolean if a field has been set.

func (*AccountOrderRecord) HasTimeUpdated 

func (o *AccountOrderRecord) HasTimeUpdated() bool

HasTimeUpdated returns a boolean if a field has been set.

func (*AccountOrderRecord) HasTotalQuantity 

func (o *AccountOrderRecord) HasTotalQuantity() bool

HasTotalQuantity returns a boolean if a field has been set.

func (*AccountOrderRecord) HasTrailingStop added in v1.0.150 

func (o *AccountOrderRecord) HasTrailingStop() bool

HasTrailingStop returns a boolean if a field has been set.

func (*AccountOrderRecord) HasUniversalSymbol 

func (o *AccountOrderRecord) HasUniversalSymbol() bool

HasUniversalSymbol returns a boolean if a field has been set.

func (AccountOrderRecord) MarshalJSON 

func (o AccountOrderRecord) MarshalJSON() ([]byte, error)

func (*AccountOrderRecord) SetAction 

func (o *AccountOrderRecord) SetAction(v string)

SetAction gets a reference to the given string and assigns it to the Action field.

func (*AccountOrderRecord) SetBrokerageGroupOrderId added in v1.0.159 

func (o *AccountOrderRecord) SetBrokerageGroupOrderId(v string)

SetBrokerageGroupOrderId gets a reference to the given NullableString and assigns it to the BrokerageGroupOrderId field.

func (*AccountOrderRecord) SetBrokerageGroupOrderIdNil added in v1.0.159 

func (o *AccountOrderRecord) SetBrokerageGroupOrderIdNil()

SetBrokerageGroupOrderIdNil sets the value for BrokerageGroupOrderId to be an explicit nil

func (*AccountOrderRecord) SetBrokerageOrderId 

func (o *AccountOrderRecord) SetBrokerageOrderId(v string)

SetBrokerageOrderId gets a reference to the given string and assigns it to the BrokerageOrderId field.

func (*AccountOrderRecord) SetCanceledQuantity 

func (o *AccountOrderRecord) SetCanceledQuantity(v string)

SetCanceledQuantity gets a reference to the given NullableString and assigns it to the CanceledQuantity field.

func (*AccountOrderRecord) SetCanceledQuantityNil 

func (o *AccountOrderRecord) SetCanceledQuantityNil()

SetCanceledQuantityNil sets the value for CanceledQuantity to be an explicit nil

func (*AccountOrderRecord) SetChildBrokerageOrderIds added in v1.0.55 

func (o *AccountOrderRecord) SetChildBrokerageOrderIds(v ChildBrokerageOrderIDsNullable)

SetChildBrokerageOrderIds gets a reference to the given NullableChildBrokerageOrderIDsNullable and assigns it to the ChildBrokerageOrderIds field.

func (*AccountOrderRecord) SetChildBrokerageOrderIdsNil added in v1.0.55 

func (o *AccountOrderRecord) SetChildBrokerageOrderIdsNil()

SetChildBrokerageOrderIdsNil sets the value for ChildBrokerageOrderIds to be an explicit nil

func (*AccountOrderRecord) SetExecutionPrice 

func (o *AccountOrderRecord) SetExecutionPrice(v float64)

SetExecutionPrice gets a reference to the given NullableFloat64 and assigns it to the ExecutionPrice field.

func (*AccountOrderRecord) SetExecutionPriceNil 

func (o *AccountOrderRecord) SetExecutionPriceNil()

SetExecutionPriceNil sets the value for ExecutionPrice to be an explicit nil

func (*AccountOrderRecord) SetExpiryDate 

func (o *AccountOrderRecord) SetExpiryDate(v time.Time)

SetExpiryDate gets a reference to the given NullableTime and assigns it to the ExpiryDate field.

func (*AccountOrderRecord) SetExpiryDateNil added in v1.0.4 

func (o *AccountOrderRecord) SetExpiryDateNil()

SetExpiryDateNil sets the value for ExpiryDate to be an explicit nil

func (*AccountOrderRecord) SetFilledQuantity 

func (o *AccountOrderRecord) SetFilledQuantity(v string)

SetFilledQuantity gets a reference to the given NullableString and assigns it to the FilledQuantity field.

func (*AccountOrderRecord) SetFilledQuantityNil 

func (o *AccountOrderRecord) SetFilledQuantityNil()

SetFilledQuantityNil sets the value for FilledQuantity to be an explicit nil

func (*AccountOrderRecord) SetLimitPrice 

func (o *AccountOrderRecord) SetLimitPrice(v float64)

SetLimitPrice gets a reference to the given NullableFloat64 and assigns it to the LimitPrice field.

func (*AccountOrderRecord) SetLimitPriceNil 

func (o *AccountOrderRecord) SetLimitPriceNil()

SetLimitPriceNil sets the value for LimitPrice to be an explicit nil

func (*AccountOrderRecord) SetOpenQuantity 

func (o *AccountOrderRecord) SetOpenQuantity(v string)

SetOpenQuantity gets a reference to the given NullableString and assigns it to the OpenQuantity field.

func (*AccountOrderRecord) SetOpenQuantityNil 

func (o *AccountOrderRecord) SetOpenQuantityNil()

SetOpenQuantityNil sets the value for OpenQuantity to be an explicit nil

func (*AccountOrderRecord) SetOptionSymbol 

func (o *AccountOrderRecord) SetOptionSymbol(v OptionsSymbolNullable)

SetOptionSymbol gets a reference to the given NullableOptionsSymbolNullable and assigns it to the OptionSymbol field.

func (*AccountOrderRecord) SetOptionSymbolNil added in v1.0.174 

func (o *AccountOrderRecord) SetOptionSymbolNil()

SetOptionSymbolNil sets the value for OptionSymbol to be an explicit nil

func (*AccountOrderRecord) SetOrderRole added in v1.0.159 

func (o *AccountOrderRecord) SetOrderRole(v string)

SetOrderRole gets a reference to the given NullableString and assigns it to the OrderRole field.

func (*AccountOrderRecord) SetOrderRoleNil added in v1.0.159 

func (o *AccountOrderRecord) SetOrderRoleNil()

SetOrderRoleNil sets the value for OrderRole to be an explicit nil

func (*AccountOrderRecord) SetOrderType 

func (o *AccountOrderRecord) SetOrderType(v string)

SetOrderType gets a reference to the given NullableString and assigns it to the OrderType field.

func (*AccountOrderRecord) SetOrderTypeNil 

func (o *AccountOrderRecord) SetOrderTypeNil()

SetOrderTypeNil sets the value for OrderType to be an explicit nil

func (*AccountOrderRecord) SetQuoteCurrency added in v1.0.58 

func (o *AccountOrderRecord) SetQuoteCurrency(v CurrencyNullable)

SetQuoteCurrency gets a reference to the given NullableCurrencyNullable and assigns it to the QuoteCurrency field.

func (*AccountOrderRecord) SetQuoteCurrencyNil added in v1.0.174 

func (o *AccountOrderRecord) SetQuoteCurrencyNil()

SetQuoteCurrencyNil sets the value for QuoteCurrency to be an explicit nil

func (*AccountOrderRecord) SetQuoteUniversalSymbol added in v1.0.58 

func (o *AccountOrderRecord) SetQuoteUniversalSymbol(v UniversalSymbolNullable)

SetQuoteUniversalSymbol gets a reference to the given NullableUniversalSymbolNullable and assigns it to the QuoteUniversalSymbol field.

func (*AccountOrderRecord) SetQuoteUniversalSymbolNil added in v1.0.174 

func (o *AccountOrderRecord) SetQuoteUniversalSymbolNil()

SetQuoteUniversalSymbolNil sets the value for QuoteUniversalSymbol to be an explicit nil

func (*AccountOrderRecord) SetStatus 

func (o *AccountOrderRecord) SetStatus(v AccountOrderRecordStatus)

SetStatus gets a reference to the given AccountOrderRecordStatus and assigns it to the Status field.

func (*AccountOrderRecord) SetStopPrice 

func (o *AccountOrderRecord) SetStopPrice(v float64)

SetStopPrice gets a reference to the given NullableFloat64 and assigns it to the StopPrice field.

func (*AccountOrderRecord) SetStopPriceNil 

func (o *AccountOrderRecord) SetStopPriceNil()

SetStopPriceNil sets the value for StopPrice to be an explicit nil

func (*AccountOrderRecord) SetSymbol 

func (o *AccountOrderRecord) SetSymbol(v string)

SetSymbol gets a reference to the given string and assigns it to the Symbol field. Deprecated

func (*AccountOrderRecord) SetTimeExecuted 

func (o *AccountOrderRecord) SetTimeExecuted(v time.Time)

SetTimeExecuted gets a reference to the given NullableTime and assigns it to the TimeExecuted field.

func (*AccountOrderRecord) SetTimeExecutedNil 

func (o *AccountOrderRecord) SetTimeExecutedNil()

SetTimeExecutedNil sets the value for TimeExecuted to be an explicit nil

func (*AccountOrderRecord) SetTimeInForce 

func (o *AccountOrderRecord) SetTimeInForce(v string)

SetTimeInForce gets a reference to the given string and assigns it to the TimeInForce field.

func (*AccountOrderRecord) SetTimePlaced 

func (o *AccountOrderRecord) SetTimePlaced(v time.Time)

SetTimePlaced gets a reference to the given time.Time and assigns it to the TimePlaced field.

func (*AccountOrderRecord) SetTimeUpdated 

func (o *AccountOrderRecord) SetTimeUpdated(v time.Time)

SetTimeUpdated gets a reference to the given NullableTime and assigns it to the TimeUpdated field.

func (*AccountOrderRecord) SetTimeUpdatedNil 

func (o *AccountOrderRecord) SetTimeUpdatedNil()

SetTimeUpdatedNil sets the value for TimeUpdated to be an explicit nil

func (*AccountOrderRecord) SetTotalQuantity 

func (o *AccountOrderRecord) SetTotalQuantity(v string)

SetTotalQuantity gets a reference to the given NullableString and assigns it to the TotalQuantity field.

func (*AccountOrderRecord) SetTotalQuantityNil 

func (o *AccountOrderRecord) SetTotalQuantityNil()

SetTotalQuantityNil sets the value for TotalQuantity to be an explicit nil

func (*AccountOrderRecord) SetTrailingStop added in v1.0.150 

func (o *AccountOrderRecord) SetTrailingStop(v TrailingStopNullable)

SetTrailingStop gets a reference to the given NullableTrailingStopNullable and assigns it to the TrailingStop field.

func (*AccountOrderRecord) SetTrailingStopNil added in v1.0.150 

func (o *AccountOrderRecord) SetTrailingStopNil()

SetTrailingStopNil sets the value for TrailingStop to be an explicit nil

func (*AccountOrderRecord) SetUniversalSymbol 

func (o *AccountOrderRecord) SetUniversalSymbol(v UniversalSymbolNullable)

SetUniversalSymbol gets a reference to the given NullableUniversalSymbolNullable and assigns it to the UniversalSymbol field.

func (*AccountOrderRecord) SetUniversalSymbolNil added in v1.0.174 

func (o *AccountOrderRecord) SetUniversalSymbolNil()

SetUniversalSymbolNil sets the value for UniversalSymbol to be an explicit nil

func (*AccountOrderRecord) UnmarshalJSON 

func (o *AccountOrderRecord) UnmarshalJSON(bytes []byte) (err error)

func (*AccountOrderRecord) UnsetBrokerageGroupOrderId added in v1.0.159 

func (o *AccountOrderRecord) UnsetBrokerageGroupOrderId()

UnsetBrokerageGroupOrderId ensures that no value is present for BrokerageGroupOrderId, not even an explicit nil

func (*AccountOrderRecord) UnsetCanceledQuantity 

func (o *AccountOrderRecord) UnsetCanceledQuantity()

UnsetCanceledQuantity ensures that no value is present for CanceledQuantity, not even an explicit nil

func (*AccountOrderRecord) UnsetChildBrokerageOrderIds added in v1.0.55 

func (o *AccountOrderRecord) UnsetChildBrokerageOrderIds()

UnsetChildBrokerageOrderIds ensures that no value is present for ChildBrokerageOrderIds, not even an explicit nil

func (*AccountOrderRecord) UnsetExecutionPrice 

func (o *AccountOrderRecord) UnsetExecutionPrice()

UnsetExecutionPrice ensures that no value is present for ExecutionPrice, not even an explicit nil

func (*AccountOrderRecord) UnsetExpiryDate added in v1.0.4 

func (o *AccountOrderRecord) UnsetExpiryDate()

UnsetExpiryDate ensures that no value is present for ExpiryDate, not even an explicit nil

func (*AccountOrderRecord) UnsetFilledQuantity 

func (o *AccountOrderRecord) UnsetFilledQuantity()

UnsetFilledQuantity ensures that no value is present for FilledQuantity, not even an explicit nil

func (*AccountOrderRecord) UnsetLimitPrice 

func (o *AccountOrderRecord) UnsetLimitPrice()

UnsetLimitPrice ensures that no value is present for LimitPrice, not even an explicit nil

func (*AccountOrderRecord) UnsetOpenQuantity 

func (o *AccountOrderRecord) UnsetOpenQuantity()

UnsetOpenQuantity ensures that no value is present for OpenQuantity, not even an explicit nil

func (*AccountOrderRecord) UnsetOptionSymbol added in v1.0.174 

func (o *AccountOrderRecord) UnsetOptionSymbol()

UnsetOptionSymbol ensures that no value is present for OptionSymbol, not even an explicit nil

func (*AccountOrderRecord) UnsetOrderRole added in v1.0.159 

func (o *AccountOrderRecord) UnsetOrderRole()

UnsetOrderRole ensures that no value is present for OrderRole, not even an explicit nil

func (*AccountOrderRecord) UnsetOrderType 

func (o *AccountOrderRecord) UnsetOrderType()

UnsetOrderType ensures that no value is present for OrderType, not even an explicit nil

func (*AccountOrderRecord) UnsetQuoteCurrency added in v1.0.174 

func (o *AccountOrderRecord) UnsetQuoteCurrency()

UnsetQuoteCurrency ensures that no value is present for QuoteCurrency, not even an explicit nil

func (*AccountOrderRecord) UnsetQuoteUniversalSymbol added in v1.0.174 

func (o *AccountOrderRecord) UnsetQuoteUniversalSymbol()

UnsetQuoteUniversalSymbol ensures that no value is present for QuoteUniversalSymbol, not even an explicit nil

func (*AccountOrderRecord) UnsetStopPrice 

func (o *AccountOrderRecord) UnsetStopPrice()

UnsetStopPrice ensures that no value is present for StopPrice, not even an explicit nil

func (*AccountOrderRecord) UnsetTimeExecuted 

func (o *AccountOrderRecord) UnsetTimeExecuted()

UnsetTimeExecuted ensures that no value is present for TimeExecuted, not even an explicit nil

func (*AccountOrderRecord) UnsetTimeUpdated 

func (o *AccountOrderRecord) UnsetTimeUpdated()

UnsetTimeUpdated ensures that no value is present for TimeUpdated, not even an explicit nil

func (*AccountOrderRecord) UnsetTotalQuantity 

func (o *AccountOrderRecord) UnsetTotalQuantity()

UnsetTotalQuantity ensures that no value is present for TotalQuantity, not even an explicit nil

func (*AccountOrderRecord) UnsetTrailingStop added in v1.0.150 

func (o *AccountOrderRecord) UnsetTrailingStop()

UnsetTrailingStop ensures that no value is present for TrailingStop, not even an explicit nil

func (*AccountOrderRecord) UnsetUniversalSymbol added in v1.0.174 

func (o *AccountOrderRecord) UnsetUniversalSymbol()

UnsetUniversalSymbol ensures that no value is present for UniversalSymbol, not even an explicit nil

type AccountOrderRecordLeg added in v1.0.117 

type AccountOrderRecordLeg struct {
	// Brokerage order identifier for this leg, if available.
	LegId      NullableString                   `json:"leg_id,omitempty"`
	Instrument *AccountOrderRecordLegInstrument `json:"instrument,omitempty"`
	// The action describes the intent or side of a trade.   - BUY   - SELL   - BUY_COVER   - SELL_SHORT   - BUY_TO_OPEN   - BUY_TO_CLOSE   - SELL_TO_OPEN   - SELL_TO_CLOSE
	Action *string `json:"action,omitempty"`
	// Execution price for this leg, if available.
	ExecutionPrice NullableFloat64 `json:"execution_price,omitempty"`
	// The total number of shares or contracts associated with this leg. Can be a decimal number for fractional shares.
	TotalQuantity NullableString `json:"total_quantity,omitempty"`
	// The number of shares or contracts that have been canceled for this leg.
	CanceledQuantity NullableString `json:"canceled_quantity,omitempty"`
	// The number of shares or contracts that have been filled for this leg.
	FilledQuantity       NullableString                             `json:"filled_quantity,omitempty"`
	Status               NullableAccountOrderRecordStatusV2Nullable `json:"status,omitempty"`
	AdditionalProperties map[string]interface{}
}

AccountOrderRecordLeg Describes an individual leg that makes up an order in the V2 format.

func NewAccountOrderRecordLeg added in v1.0.117 

func NewAccountOrderRecordLeg() *AccountOrderRecordLeg

NewAccountOrderRecordLeg instantiates a new AccountOrderRecordLeg 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

func NewAccountOrderRecordLegWithDefaults added in v1.0.117 

func NewAccountOrderRecordLegWithDefaults() *AccountOrderRecordLeg

NewAccountOrderRecordLegWithDefaults instantiates a new AccountOrderRecordLeg 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

func (*AccountOrderRecordLeg) GetAction added in v1.0.117 

func (o *AccountOrderRecordLeg) GetAction() string

GetAction returns the Action field value if set, zero value otherwise.

func (*AccountOrderRecordLeg) GetActionOk added in v1.0.117 

func (o *AccountOrderRecordLeg) GetActionOk() (*string, bool)

GetActionOk returns a tuple with the Action field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordLeg) GetCanceledQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) GetCanceledQuantity() string

GetCanceledQuantity returns the CanceledQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordLeg) GetCanceledQuantityOk added in v1.0.117 

func (o *AccountOrderRecordLeg) GetCanceledQuantityOk() (*string, bool)

GetCanceledQuantityOk returns a tuple with the CanceledQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordLeg) GetExecutionPrice added in v1.0.117 

func (o *AccountOrderRecordLeg) GetExecutionPrice() float64

GetExecutionPrice returns the ExecutionPrice field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordLeg) GetExecutionPriceOk added in v1.0.117 

func (o *AccountOrderRecordLeg) GetExecutionPriceOk() (*float64, bool)

GetExecutionPriceOk returns a tuple with the ExecutionPrice field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordLeg) GetFilledQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) GetFilledQuantity() string

GetFilledQuantity returns the FilledQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordLeg) GetFilledQuantityOk added in v1.0.117 

func (o *AccountOrderRecordLeg) GetFilledQuantityOk() (*string, bool)

GetFilledQuantityOk returns a tuple with the FilledQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordLeg) GetInstrument added in v1.0.117 

func (o *AccountOrderRecordLeg) GetInstrument() AccountOrderRecordLegInstrument

GetInstrument returns the Instrument field value if set, zero value otherwise.

func (*AccountOrderRecordLeg) GetInstrumentOk added in v1.0.117 

func (o *AccountOrderRecordLeg) GetInstrumentOk() (*AccountOrderRecordLegInstrument, bool)

GetInstrumentOk returns a tuple with the Instrument field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordLeg) GetLegId added in v1.0.117 

func (o *AccountOrderRecordLeg) GetLegId() string

GetLegId returns the LegId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordLeg) GetLegIdOk added in v1.0.117 

func (o *AccountOrderRecordLeg) GetLegIdOk() (*string, bool)

GetLegIdOk returns a tuple with the LegId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordLeg) GetStatus added in v1.0.117 

func (o *AccountOrderRecordLeg) GetStatus() AccountOrderRecordStatusV2Nullable

GetStatus returns the Status field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordLeg) GetStatusOk added in v1.0.117 

func (o *AccountOrderRecordLeg) GetStatusOk() (*AccountOrderRecordStatusV2Nullable, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordLeg) GetTotalQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) GetTotalQuantity() string

GetTotalQuantity returns the TotalQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordLeg) GetTotalQuantityOk added in v1.0.117 

func (o *AccountOrderRecordLeg) GetTotalQuantityOk() (*string, bool)

GetTotalQuantityOk returns a tuple with the TotalQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordLeg) HasAction added in v1.0.117 

func (o *AccountOrderRecordLeg) HasAction() bool

HasAction returns a boolean if a field has been set.

func (*AccountOrderRecordLeg) HasCanceledQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) HasCanceledQuantity() bool

HasCanceledQuantity returns a boolean if a field has been set.

func (*AccountOrderRecordLeg) HasExecutionPrice added in v1.0.117 

func (o *AccountOrderRecordLeg) HasExecutionPrice() bool

HasExecutionPrice returns a boolean if a field has been set.

func (*AccountOrderRecordLeg) HasFilledQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) HasFilledQuantity() bool

HasFilledQuantity returns a boolean if a field has been set.

func (*AccountOrderRecordLeg) HasInstrument added in v1.0.117 

func (o *AccountOrderRecordLeg) HasInstrument() bool

HasInstrument returns a boolean if a field has been set.

func (*AccountOrderRecordLeg) HasLegId added in v1.0.117 

func (o *AccountOrderRecordLeg) HasLegId() bool

HasLegId returns a boolean if a field has been set.

func (*AccountOrderRecordLeg) HasStatus added in v1.0.117 

func (o *AccountOrderRecordLeg) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*AccountOrderRecordLeg) HasTotalQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) HasTotalQuantity() bool

HasTotalQuantity returns a boolean if a field has been set.

func (AccountOrderRecordLeg) MarshalJSON added in v1.0.117 

func (o AccountOrderRecordLeg) MarshalJSON() ([]byte, error)

func (*AccountOrderRecordLeg) SetAction added in v1.0.117 

func (o *AccountOrderRecordLeg) SetAction(v string)

SetAction gets a reference to the given string and assigns it to the Action field.

func (*AccountOrderRecordLeg) SetCanceledQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) SetCanceledQuantity(v string)

SetCanceledQuantity gets a reference to the given NullableString and assigns it to the CanceledQuantity field.

func (*AccountOrderRecordLeg) SetCanceledQuantityNil added in v1.0.117 

func (o *AccountOrderRecordLeg) SetCanceledQuantityNil()

SetCanceledQuantityNil sets the value for CanceledQuantity to be an explicit nil

func (*AccountOrderRecordLeg) SetExecutionPrice added in v1.0.117 

func (o *AccountOrderRecordLeg) SetExecutionPrice(v float64)

SetExecutionPrice gets a reference to the given NullableFloat64 and assigns it to the ExecutionPrice field.

func (*AccountOrderRecordLeg) SetExecutionPriceNil added in v1.0.117 

func (o *AccountOrderRecordLeg) SetExecutionPriceNil()

SetExecutionPriceNil sets the value for ExecutionPrice to be an explicit nil

func (*AccountOrderRecordLeg) SetFilledQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) SetFilledQuantity(v string)

SetFilledQuantity gets a reference to the given NullableString and assigns it to the FilledQuantity field.

func (*AccountOrderRecordLeg) SetFilledQuantityNil added in v1.0.117 

func (o *AccountOrderRecordLeg) SetFilledQuantityNil()

SetFilledQuantityNil sets the value for FilledQuantity to be an explicit nil

func (*AccountOrderRecordLeg) SetInstrument added in v1.0.117 

func (o *AccountOrderRecordLeg) SetInstrument(v AccountOrderRecordLegInstrument)

SetInstrument gets a reference to the given AccountOrderRecordLegInstrument and assigns it to the Instrument field.

func (*AccountOrderRecordLeg) SetLegId added in v1.0.117 

func (o *AccountOrderRecordLeg) SetLegId(v string)

SetLegId gets a reference to the given NullableString and assigns it to the LegId field.

func (*AccountOrderRecordLeg) SetLegIdNil added in v1.0.117 

func (o *AccountOrderRecordLeg) SetLegIdNil()

SetLegIdNil sets the value for LegId to be an explicit nil

func (*AccountOrderRecordLeg) SetStatus added in v1.0.117 

func (o *AccountOrderRecordLeg) SetStatus(v AccountOrderRecordStatusV2Nullable)

SetStatus gets a reference to the given NullableAccountOrderRecordStatusV2Nullable and assigns it to the Status field.

func (*AccountOrderRecordLeg) SetStatusNil added in v1.0.117 

func (o *AccountOrderRecordLeg) SetStatusNil()

SetStatusNil sets the value for Status to be an explicit nil

func (*AccountOrderRecordLeg) SetTotalQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) SetTotalQuantity(v string)

SetTotalQuantity gets a reference to the given NullableString and assigns it to the TotalQuantity field.

func (*AccountOrderRecordLeg) SetTotalQuantityNil added in v1.0.117 

func (o *AccountOrderRecordLeg) SetTotalQuantityNil()

SetTotalQuantityNil sets the value for TotalQuantity to be an explicit nil

func (*AccountOrderRecordLeg) UnmarshalJSON added in v1.0.117 

func (o *AccountOrderRecordLeg) UnmarshalJSON(bytes []byte) (err error)

func (*AccountOrderRecordLeg) UnsetCanceledQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) UnsetCanceledQuantity()

UnsetCanceledQuantity ensures that no value is present for CanceledQuantity, not even an explicit nil

func (*AccountOrderRecordLeg) UnsetExecutionPrice added in v1.0.117 

func (o *AccountOrderRecordLeg) UnsetExecutionPrice()

UnsetExecutionPrice ensures that no value is present for ExecutionPrice, not even an explicit nil

func (*AccountOrderRecordLeg) UnsetFilledQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) UnsetFilledQuantity()

UnsetFilledQuantity ensures that no value is present for FilledQuantity, not even an explicit nil

func (*AccountOrderRecordLeg) UnsetLegId added in v1.0.117 

func (o *AccountOrderRecordLeg) UnsetLegId()

UnsetLegId ensures that no value is present for LegId, not even an explicit nil

func (*AccountOrderRecordLeg) UnsetStatus added in v1.0.117 

func (o *AccountOrderRecordLeg) UnsetStatus()

UnsetStatus ensures that no value is present for Status, not even an explicit nil

func (*AccountOrderRecordLeg) UnsetTotalQuantity added in v1.0.117 

func (o *AccountOrderRecordLeg) UnsetTotalQuantity()

UnsetTotalQuantity ensures that no value is present for TotalQuantity, not even an explicit nil

type AccountOrderRecordLegInstrument added in v1.0.117 

type AccountOrderRecordLegInstrument struct {
	// The symbol or ticker for the security.
	Symbol *string `json:"symbol,omitempty"`
	// Human-readable description of the security.
	Description *string `json:"description,omitempty"`
	// Type of instrument for the leg. - EQUITY - OPTION - CRYPTO
	AssetType *string `json:"asset_type,omitempty"`
	// Market Identifier Code (MIC) for the exchange on which the instrument trades. Omitted for instruments with no listing exchange, such as index options (VIX, SPX).
	ExchangeMicCode *string `json:"exchange_mic_code,omitempty"`
	// Financial Instrument Global Identifier (FIGI) if available.
	FigiCode             NullableString `json:"figi_code,omitempty"`
	AdditionalProperties map[string]interface{}
}

AccountOrderRecordLegInstrument Instrument metadata for an order leg.

func NewAccountOrderRecordLegInstrument added in v1.0.117 

func NewAccountOrderRecordLegInstrument() *AccountOrderRecordLegInstrument

NewAccountOrderRecordLegInstrument instantiates a new AccountOrderRecordLegInstrument 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

func NewAccountOrderRecordLegInstrumentWithDefaults added in v1.0.117 

func NewAccountOrderRecordLegInstrumentWithDefaults() *AccountOrderRecordLegInstrument

NewAccountOrderRecordLegInstrumentWithDefaults instantiates a new AccountOrderRecordLegInstrument 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

func (*AccountOrderRecordLegInstrument) GetAssetType added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) GetAssetType() string

GetAssetType returns the AssetType field value if set, zero value otherwise.

func (*AccountOrderRecordLegInstrument) GetAssetTypeOk added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) GetAssetTypeOk() (*string, bool)

GetAssetTypeOk returns a tuple with the AssetType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordLegInstrument) GetDescription added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*AccountOrderRecordLegInstrument) GetDescriptionOk added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordLegInstrument) GetExchangeMicCode added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) GetExchangeMicCode() string

GetExchangeMicCode returns the ExchangeMicCode field value if set, zero value otherwise.

func (*AccountOrderRecordLegInstrument) GetExchangeMicCodeOk added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) GetExchangeMicCodeOk() (*string, bool)

GetExchangeMicCodeOk returns a tuple with the ExchangeMicCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordLegInstrument) GetFigiCode added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) GetFigiCode() string

GetFigiCode returns the FigiCode field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordLegInstrument) GetFigiCodeOk added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) GetFigiCodeOk() (*string, bool)

GetFigiCodeOk returns a tuple with the FigiCode field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordLegInstrument) GetSymbol added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) GetSymbol() string

GetSymbol returns the Symbol field value if set, zero value otherwise.

func (*AccountOrderRecordLegInstrument) GetSymbolOk added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordLegInstrument) HasAssetType added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) HasAssetType() bool

HasAssetType returns a boolean if a field has been set.

func (*AccountOrderRecordLegInstrument) HasDescription added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*AccountOrderRecordLegInstrument) HasExchangeMicCode added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) HasExchangeMicCode() bool

HasExchangeMicCode returns a boolean if a field has been set.

func (*AccountOrderRecordLegInstrument) HasFigiCode added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) HasFigiCode() bool

HasFigiCode returns a boolean if a field has been set.

func (*AccountOrderRecordLegInstrument) HasSymbol added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) HasSymbol() bool

HasSymbol returns a boolean if a field has been set.

func (AccountOrderRecordLegInstrument) MarshalJSON added in v1.0.117 

func (o AccountOrderRecordLegInstrument) MarshalJSON() ([]byte, error)

func (*AccountOrderRecordLegInstrument) SetAssetType added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) SetAssetType(v string)

SetAssetType gets a reference to the given string and assigns it to the AssetType field.

func (*AccountOrderRecordLegInstrument) SetDescription added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*AccountOrderRecordLegInstrument) SetExchangeMicCode added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) SetExchangeMicCode(v string)

SetExchangeMicCode gets a reference to the given string and assigns it to the ExchangeMicCode field.

func (*AccountOrderRecordLegInstrument) SetFigiCode added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) SetFigiCode(v string)

SetFigiCode gets a reference to the given NullableString and assigns it to the FigiCode field.

func (*AccountOrderRecordLegInstrument) SetFigiCodeNil added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) SetFigiCodeNil()

SetFigiCodeNil sets the value for FigiCode to be an explicit nil

func (*AccountOrderRecordLegInstrument) SetSymbol added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) SetSymbol(v string)

SetSymbol gets a reference to the given string and assigns it to the Symbol field.

func (*AccountOrderRecordLegInstrument) UnmarshalJSON added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) UnmarshalJSON(bytes []byte) (err error)

func (*AccountOrderRecordLegInstrument) UnsetFigiCode added in v1.0.117 

func (o *AccountOrderRecordLegInstrument) UnsetFigiCode()

UnsetFigiCode ensures that no value is present for FigiCode, not even an explicit nil

type AccountOrderRecordNullable added in v1.1.0 

type AccountOrderRecordNullable struct {
	// Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
	BrokerageOrderId *string `json:"brokerage_order_id,omitempty"`
	// The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier.
	BrokerageGroupOrderId NullableString `json:"brokerage_group_order_id,omitempty"`
	// The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders.
	OrderRole            NullableString                  `json:"order_role,omitempty"`
	Status               *AccountOrderRecordStatus       `json:"status,omitempty"`
	UniversalSymbol      NullableUniversalSymbolNullable `json:"universal_symbol,omitempty"`
	OptionSymbol         NullableOptionsSymbolNullable   `json:"option_symbol,omitempty"`
	QuoteUniversalSymbol NullableUniversalSymbolNullable `json:"quote_universal_symbol,omitempty"`
	QuoteCurrency        NullableCurrencyNullable        `json:"quote_currency,omitempty"`
	// The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage.   - BUY   - SELL   - BUY_COVER   - SELL_SHORT   - BUY_OPEN   - BUY_CLOSE   - SELL_OPEN   - SELL_CLOSE
	Action *string `json:"action,omitempty"`
	// The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
	TotalQuantity NullableString `json:"total_quantity,omitempty"`
	// The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
	OpenQuantity NullableString `json:"open_quantity,omitempty"`
	// The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
	CanceledQuantity NullableString `json:"canceled_quantity,omitempty"`
	// The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
	FilledQuantity NullableString `json:"filled_quantity,omitempty"`
	// The price at which the order was executed. For option orders, this represents the price per share.
	ExecutionPrice NullableFloat64 `json:"execution_price,omitempty"`
	// The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. For option orders, this represents the price per share.
	LimitPrice NullableFloat64 `json:"limit_price,omitempty"`
	// The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. For option orders, this represents the price per share.
	StopPrice    NullableFloat64              `json:"stop_price,omitempty"`
	TrailingStop NullableTrailingStopNullable `json:"trailing_stop,omitempty"`
	// The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value.
	OrderType NullableString `json:"order_type,omitempty"`
	// The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value.   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date.   - `MOO` - Market On Open. The order is to be executed at the day's opening price.   - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close.
	TimeInForce *string `json:"time_in_force,omitempty"`
	// The time the order was placed. This is the time the order was submitted to the brokerage.
	TimePlaced *time.Time `json:"time_placed,omitempty"`
	// The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
	TimeUpdated NullableTime `json:"time_updated,omitempty"`
	// The time the order was executed in the brokerage system. This value is not always available from the brokerage.
	TimeExecuted NullableTime `json:"time_executed,omitempty"`
	// The time the order expires. This value is not always available from the brokerage.
	ExpiryDate NullableTime `json:"expiry_date,omitempty"`
	// A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
	// Deprecated
	Symbol                 *string                                `json:"symbol,omitempty"`
	ChildBrokerageOrderIds NullableChildBrokerageOrderIDsNullable `json:"child_brokerage_order_ids,omitempty"`
	AdditionalProperties   map[string]interface{}
}

AccountOrderRecordNullable Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records.

func NewAccountOrderRecordNullable added in v1.1.0 

func NewAccountOrderRecordNullable() *AccountOrderRecordNullable

NewAccountOrderRecordNullable instantiates a new AccountOrderRecordNullable 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

func NewAccountOrderRecordNullableWithDefaults added in v1.1.0 

func NewAccountOrderRecordNullableWithDefaults() *AccountOrderRecordNullable

NewAccountOrderRecordNullableWithDefaults instantiates a new AccountOrderRecordNullable 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

func (*AccountOrderRecordNullable) GetAction added in v1.1.0 

func (o *AccountOrderRecordNullable) GetAction() string

GetAction returns the Action field value if set, zero value otherwise.

func (*AccountOrderRecordNullable) GetActionOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetActionOk() (*string, bool)

GetActionOk returns a tuple with the Action field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordNullable) GetBrokerageGroupOrderId added in v1.1.0 

func (o *AccountOrderRecordNullable) GetBrokerageGroupOrderId() string

GetBrokerageGroupOrderId returns the BrokerageGroupOrderId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetBrokerageGroupOrderIdOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetBrokerageGroupOrderIdOk() (*string, bool)

GetBrokerageGroupOrderIdOk returns a tuple with the BrokerageGroupOrderId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetBrokerageOrderId added in v1.1.0 

func (o *AccountOrderRecordNullable) GetBrokerageOrderId() string

GetBrokerageOrderId returns the BrokerageOrderId field value if set, zero value otherwise.

func (*AccountOrderRecordNullable) GetBrokerageOrderIdOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetBrokerageOrderIdOk() (*string, bool)

GetBrokerageOrderIdOk returns a tuple with the BrokerageOrderId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordNullable) GetCanceledQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) GetCanceledQuantity() string

GetCanceledQuantity returns the CanceledQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetCanceledQuantityOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetCanceledQuantityOk() (*string, bool)

GetCanceledQuantityOk returns a tuple with the CanceledQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetChildBrokerageOrderIds added in v1.1.0 

func (o *AccountOrderRecordNullable) GetChildBrokerageOrderIds() ChildBrokerageOrderIDsNullable

GetChildBrokerageOrderIds returns the ChildBrokerageOrderIds field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetChildBrokerageOrderIdsOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetChildBrokerageOrderIdsOk() (*ChildBrokerageOrderIDsNullable, bool)

GetChildBrokerageOrderIdsOk returns a tuple with the ChildBrokerageOrderIds field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetExecutionPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) GetExecutionPrice() float64

GetExecutionPrice returns the ExecutionPrice field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetExecutionPriceOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetExecutionPriceOk() (*float64, bool)

GetExecutionPriceOk returns a tuple with the ExecutionPrice field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetExpiryDate added in v1.1.0 

func (o *AccountOrderRecordNullable) GetExpiryDate() time.Time

GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetExpiryDateOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetExpiryDateOk() (*time.Time, bool)

GetExpiryDateOk returns a tuple with the ExpiryDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetFilledQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) GetFilledQuantity() string

GetFilledQuantity returns the FilledQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetFilledQuantityOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetFilledQuantityOk() (*string, bool)

GetFilledQuantityOk returns a tuple with the FilledQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetLimitPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) GetLimitPrice() float64

GetLimitPrice returns the LimitPrice field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetLimitPriceOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetLimitPriceOk() (*float64, bool)

GetLimitPriceOk returns a tuple with the LimitPrice field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetOpenQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) GetOpenQuantity() string

GetOpenQuantity returns the OpenQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetOpenQuantityOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetOpenQuantityOk() (*string, bool)

GetOpenQuantityOk returns a tuple with the OpenQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetOptionSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) GetOptionSymbol() OptionsSymbolNullable

GetOptionSymbol returns the OptionSymbol field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetOptionSymbolOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetOptionSymbolOk() (*OptionsSymbolNullable, bool)

GetOptionSymbolOk returns a tuple with the OptionSymbol field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetOrderRole added in v1.1.0 

func (o *AccountOrderRecordNullable) GetOrderRole() string

GetOrderRole returns the OrderRole field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetOrderRoleOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetOrderRoleOk() (*string, bool)

GetOrderRoleOk returns a tuple with the OrderRole field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetOrderType added in v1.1.0 

func (o *AccountOrderRecordNullable) GetOrderType() string

GetOrderType returns the OrderType field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetOrderTypeOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetOrderTypeOk() (*string, bool)

GetOrderTypeOk returns a tuple with the OrderType field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetQuoteCurrency added in v1.1.0 

func (o *AccountOrderRecordNullable) GetQuoteCurrency() CurrencyNullable

GetQuoteCurrency returns the QuoteCurrency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetQuoteCurrencyOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetQuoteCurrencyOk() (*CurrencyNullable, bool)

GetQuoteCurrencyOk returns a tuple with the QuoteCurrency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetQuoteUniversalSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) GetQuoteUniversalSymbol() UniversalSymbolNullable

GetQuoteUniversalSymbol returns the QuoteUniversalSymbol field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetQuoteUniversalSymbolOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetQuoteUniversalSymbolOk() (*UniversalSymbolNullable, bool)

GetQuoteUniversalSymbolOk returns a tuple with the QuoteUniversalSymbol field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetStatus added in v1.1.0 

func (o *AccountOrderRecordNullable) GetStatus() AccountOrderRecordStatus

GetStatus returns the Status field value if set, zero value otherwise.

func (*AccountOrderRecordNullable) GetStatusOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetStatusOk() (*AccountOrderRecordStatus, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordNullable) GetStopPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) GetStopPrice() float64

GetStopPrice returns the StopPrice field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetStopPriceOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetStopPriceOk() (*float64, bool)

GetStopPriceOk returns a tuple with the StopPrice field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) GetSymbol() string

GetSymbol returns the Symbol field value if set, zero value otherwise. Deprecated

func (*AccountOrderRecordNullable) GetSymbolOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated

func (*AccountOrderRecordNullable) GetTimeExecuted added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTimeExecuted() time.Time

GetTimeExecuted returns the TimeExecuted field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetTimeExecutedOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTimeExecutedOk() (*time.Time, bool)

GetTimeExecutedOk returns a tuple with the TimeExecuted field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetTimeInForce added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTimeInForce() string

GetTimeInForce returns the TimeInForce field value if set, zero value otherwise.

func (*AccountOrderRecordNullable) GetTimeInForceOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTimeInForceOk() (*string, bool)

GetTimeInForceOk returns a tuple with the TimeInForce field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordNullable) GetTimePlaced added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTimePlaced() time.Time

GetTimePlaced returns the TimePlaced field value if set, zero value otherwise.

func (*AccountOrderRecordNullable) GetTimePlacedOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTimePlacedOk() (*time.Time, bool)

GetTimePlacedOk returns a tuple with the TimePlaced field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordNullable) GetTimeUpdated added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTimeUpdated() time.Time

GetTimeUpdated returns the TimeUpdated field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetTimeUpdatedOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTimeUpdatedOk() (*time.Time, bool)

GetTimeUpdatedOk returns a tuple with the TimeUpdated field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetTotalQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTotalQuantity() string

GetTotalQuantity returns the TotalQuantity field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetTotalQuantityOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTotalQuantityOk() (*string, bool)

GetTotalQuantityOk returns a tuple with the TotalQuantity field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetTrailingStop added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTrailingStop() TrailingStopNullable

GetTrailingStop returns the TrailingStop field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetTrailingStopOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetTrailingStopOk() (*TrailingStopNullable, bool)

GetTrailingStopOk returns a tuple with the TrailingStop field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) GetUniversalSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) GetUniversalSymbol() UniversalSymbolNullable

GetUniversalSymbol returns the UniversalSymbol field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordNullable) GetUniversalSymbolOk added in v1.1.0 

func (o *AccountOrderRecordNullable) GetUniversalSymbolOk() (*UniversalSymbolNullable, bool)

GetUniversalSymbolOk returns a tuple with the UniversalSymbol field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordNullable) HasAction added in v1.1.0 

func (o *AccountOrderRecordNullable) HasAction() bool

HasAction returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasBrokerageGroupOrderId added in v1.1.0 

func (o *AccountOrderRecordNullable) HasBrokerageGroupOrderId() bool

HasBrokerageGroupOrderId returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasBrokerageOrderId added in v1.1.0 

func (o *AccountOrderRecordNullable) HasBrokerageOrderId() bool

HasBrokerageOrderId returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasCanceledQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) HasCanceledQuantity() bool

HasCanceledQuantity returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasChildBrokerageOrderIds added in v1.1.0 

func (o *AccountOrderRecordNullable) HasChildBrokerageOrderIds() bool

HasChildBrokerageOrderIds returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasExecutionPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) HasExecutionPrice() bool

HasExecutionPrice returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasExpiryDate added in v1.1.0 

func (o *AccountOrderRecordNullable) HasExpiryDate() bool

HasExpiryDate returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasFilledQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) HasFilledQuantity() bool

HasFilledQuantity returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasLimitPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) HasLimitPrice() bool

HasLimitPrice returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasOpenQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) HasOpenQuantity() bool

HasOpenQuantity returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasOptionSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) HasOptionSymbol() bool

HasOptionSymbol returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasOrderRole added in v1.1.0 

func (o *AccountOrderRecordNullable) HasOrderRole() bool

HasOrderRole returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasOrderType added in v1.1.0 

func (o *AccountOrderRecordNullable) HasOrderType() bool

HasOrderType returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasQuoteCurrency added in v1.1.0 

func (o *AccountOrderRecordNullable) HasQuoteCurrency() bool

HasQuoteCurrency returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasQuoteUniversalSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) HasQuoteUniversalSymbol() bool

HasQuoteUniversalSymbol returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasStatus added in v1.1.0 

func (o *AccountOrderRecordNullable) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasStopPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) HasStopPrice() bool

HasStopPrice returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) HasSymbol() bool

HasSymbol returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasTimeExecuted added in v1.1.0 

func (o *AccountOrderRecordNullable) HasTimeExecuted() bool

HasTimeExecuted returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasTimeInForce added in v1.1.0 

func (o *AccountOrderRecordNullable) HasTimeInForce() bool

HasTimeInForce returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasTimePlaced added in v1.1.0 

func (o *AccountOrderRecordNullable) HasTimePlaced() bool

HasTimePlaced returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasTimeUpdated added in v1.1.0 

func (o *AccountOrderRecordNullable) HasTimeUpdated() bool

HasTimeUpdated returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasTotalQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) HasTotalQuantity() bool

HasTotalQuantity returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasTrailingStop added in v1.1.0 

func (o *AccountOrderRecordNullable) HasTrailingStop() bool

HasTrailingStop returns a boolean if a field has been set.

func (*AccountOrderRecordNullable) HasUniversalSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) HasUniversalSymbol() bool

HasUniversalSymbol returns a boolean if a field has been set.

func (AccountOrderRecordNullable) MarshalJSON added in v1.1.0 

func (o AccountOrderRecordNullable) MarshalJSON() ([]byte, error)

func (*AccountOrderRecordNullable) SetAction added in v1.1.0 

func (o *AccountOrderRecordNullable) SetAction(v string)

SetAction gets a reference to the given string and assigns it to the Action field.

func (*AccountOrderRecordNullable) SetBrokerageGroupOrderId added in v1.1.0 

func (o *AccountOrderRecordNullable) SetBrokerageGroupOrderId(v string)

SetBrokerageGroupOrderId gets a reference to the given NullableString and assigns it to the BrokerageGroupOrderId field.

func (*AccountOrderRecordNullable) SetBrokerageGroupOrderIdNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetBrokerageGroupOrderIdNil()

SetBrokerageGroupOrderIdNil sets the value for BrokerageGroupOrderId to be an explicit nil

func (*AccountOrderRecordNullable) SetBrokerageOrderId added in v1.1.0 

func (o *AccountOrderRecordNullable) SetBrokerageOrderId(v string)

SetBrokerageOrderId gets a reference to the given string and assigns it to the BrokerageOrderId field.

func (*AccountOrderRecordNullable) SetCanceledQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) SetCanceledQuantity(v string)

SetCanceledQuantity gets a reference to the given NullableString and assigns it to the CanceledQuantity field.

func (*AccountOrderRecordNullable) SetCanceledQuantityNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetCanceledQuantityNil()

SetCanceledQuantityNil sets the value for CanceledQuantity to be an explicit nil

func (*AccountOrderRecordNullable) SetChildBrokerageOrderIds added in v1.1.0 

func (o *AccountOrderRecordNullable) SetChildBrokerageOrderIds(v ChildBrokerageOrderIDsNullable)

SetChildBrokerageOrderIds gets a reference to the given NullableChildBrokerageOrderIDsNullable and assigns it to the ChildBrokerageOrderIds field.

func (*AccountOrderRecordNullable) SetChildBrokerageOrderIdsNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetChildBrokerageOrderIdsNil()

SetChildBrokerageOrderIdsNil sets the value for ChildBrokerageOrderIds to be an explicit nil

func (*AccountOrderRecordNullable) SetExecutionPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) SetExecutionPrice(v float64)

SetExecutionPrice gets a reference to the given NullableFloat64 and assigns it to the ExecutionPrice field.

func (*AccountOrderRecordNullable) SetExecutionPriceNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetExecutionPriceNil()

SetExecutionPriceNil sets the value for ExecutionPrice to be an explicit nil

func (*AccountOrderRecordNullable) SetExpiryDate added in v1.1.0 

func (o *AccountOrderRecordNullable) SetExpiryDate(v time.Time)

SetExpiryDate gets a reference to the given NullableTime and assigns it to the ExpiryDate field.

func (*AccountOrderRecordNullable) SetExpiryDateNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetExpiryDateNil()

SetExpiryDateNil sets the value for ExpiryDate to be an explicit nil

func (*AccountOrderRecordNullable) SetFilledQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) SetFilledQuantity(v string)

SetFilledQuantity gets a reference to the given NullableString and assigns it to the FilledQuantity field.

func (*AccountOrderRecordNullable) SetFilledQuantityNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetFilledQuantityNil()

SetFilledQuantityNil sets the value for FilledQuantity to be an explicit nil

func (*AccountOrderRecordNullable) SetLimitPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) SetLimitPrice(v float64)

SetLimitPrice gets a reference to the given NullableFloat64 and assigns it to the LimitPrice field.

func (*AccountOrderRecordNullable) SetLimitPriceNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetLimitPriceNil()

SetLimitPriceNil sets the value for LimitPrice to be an explicit nil

func (*AccountOrderRecordNullable) SetOpenQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) SetOpenQuantity(v string)

SetOpenQuantity gets a reference to the given NullableString and assigns it to the OpenQuantity field.

func (*AccountOrderRecordNullable) SetOpenQuantityNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetOpenQuantityNil()

SetOpenQuantityNil sets the value for OpenQuantity to be an explicit nil

func (*AccountOrderRecordNullable) SetOptionSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) SetOptionSymbol(v OptionsSymbolNullable)

SetOptionSymbol gets a reference to the given NullableOptionsSymbolNullable and assigns it to the OptionSymbol field.

func (*AccountOrderRecordNullable) SetOptionSymbolNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetOptionSymbolNil()

SetOptionSymbolNil sets the value for OptionSymbol to be an explicit nil

func (*AccountOrderRecordNullable) SetOrderRole added in v1.1.0 

func (o *AccountOrderRecordNullable) SetOrderRole(v string)

SetOrderRole gets a reference to the given NullableString and assigns it to the OrderRole field.

func (*AccountOrderRecordNullable) SetOrderRoleNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetOrderRoleNil()

SetOrderRoleNil sets the value for OrderRole to be an explicit nil

func (*AccountOrderRecordNullable) SetOrderType added in v1.1.0 

func (o *AccountOrderRecordNullable) SetOrderType(v string)

SetOrderType gets a reference to the given NullableString and assigns it to the OrderType field.

func (*AccountOrderRecordNullable) SetOrderTypeNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetOrderTypeNil()

SetOrderTypeNil sets the value for OrderType to be an explicit nil

func (*AccountOrderRecordNullable) SetQuoteCurrency added in v1.1.0 

func (o *AccountOrderRecordNullable) SetQuoteCurrency(v CurrencyNullable)

SetQuoteCurrency gets a reference to the given NullableCurrencyNullable and assigns it to the QuoteCurrency field.

func (*AccountOrderRecordNullable) SetQuoteCurrencyNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetQuoteCurrencyNil()

SetQuoteCurrencyNil sets the value for QuoteCurrency to be an explicit nil

func (*AccountOrderRecordNullable) SetQuoteUniversalSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) SetQuoteUniversalSymbol(v UniversalSymbolNullable)

SetQuoteUniversalSymbol gets a reference to the given NullableUniversalSymbolNullable and assigns it to the QuoteUniversalSymbol field.

func (*AccountOrderRecordNullable) SetQuoteUniversalSymbolNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetQuoteUniversalSymbolNil()

SetQuoteUniversalSymbolNil sets the value for QuoteUniversalSymbol to be an explicit nil

func (*AccountOrderRecordNullable) SetStatus added in v1.1.0 

func (o *AccountOrderRecordNullable) SetStatus(v AccountOrderRecordStatus)

SetStatus gets a reference to the given AccountOrderRecordStatus and assigns it to the Status field.

func (*AccountOrderRecordNullable) SetStopPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) SetStopPrice(v float64)

SetStopPrice gets a reference to the given NullableFloat64 and assigns it to the StopPrice field.

func (*AccountOrderRecordNullable) SetStopPriceNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetStopPriceNil()

SetStopPriceNil sets the value for StopPrice to be an explicit nil

func (*AccountOrderRecordNullable) SetSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) SetSymbol(v string)

SetSymbol gets a reference to the given string and assigns it to the Symbol field. Deprecated

func (*AccountOrderRecordNullable) SetTimeExecuted added in v1.1.0 

func (o *AccountOrderRecordNullable) SetTimeExecuted(v time.Time)

SetTimeExecuted gets a reference to the given NullableTime and assigns it to the TimeExecuted field.

func (*AccountOrderRecordNullable) SetTimeExecutedNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetTimeExecutedNil()

SetTimeExecutedNil sets the value for TimeExecuted to be an explicit nil

func (*AccountOrderRecordNullable) SetTimeInForce added in v1.1.0 

func (o *AccountOrderRecordNullable) SetTimeInForce(v string)

SetTimeInForce gets a reference to the given string and assigns it to the TimeInForce field.

func (*AccountOrderRecordNullable) SetTimePlaced added in v1.1.0 

func (o *AccountOrderRecordNullable) SetTimePlaced(v time.Time)

SetTimePlaced gets a reference to the given time.Time and assigns it to the TimePlaced field.

func (*AccountOrderRecordNullable) SetTimeUpdated added in v1.1.0 

func (o *AccountOrderRecordNullable) SetTimeUpdated(v time.Time)

SetTimeUpdated gets a reference to the given NullableTime and assigns it to the TimeUpdated field.

func (*AccountOrderRecordNullable) SetTimeUpdatedNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetTimeUpdatedNil()

SetTimeUpdatedNil sets the value for TimeUpdated to be an explicit nil

func (*AccountOrderRecordNullable) SetTotalQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) SetTotalQuantity(v string)

SetTotalQuantity gets a reference to the given NullableString and assigns it to the TotalQuantity field.

func (*AccountOrderRecordNullable) SetTotalQuantityNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetTotalQuantityNil()

SetTotalQuantityNil sets the value for TotalQuantity to be an explicit nil

func (*AccountOrderRecordNullable) SetTrailingStop added in v1.1.0 

func (o *AccountOrderRecordNullable) SetTrailingStop(v TrailingStopNullable)

SetTrailingStop gets a reference to the given NullableTrailingStopNullable and assigns it to the TrailingStop field.

func (*AccountOrderRecordNullable) SetTrailingStopNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetTrailingStopNil()

SetTrailingStopNil sets the value for TrailingStop to be an explicit nil

func (*AccountOrderRecordNullable) SetUniversalSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) SetUniversalSymbol(v UniversalSymbolNullable)

SetUniversalSymbol gets a reference to the given NullableUniversalSymbolNullable and assigns it to the UniversalSymbol field.

func (*AccountOrderRecordNullable) SetUniversalSymbolNil added in v1.1.0 

func (o *AccountOrderRecordNullable) SetUniversalSymbolNil()

SetUniversalSymbolNil sets the value for UniversalSymbol to be an explicit nil

func (*AccountOrderRecordNullable) UnmarshalJSON added in v1.1.0 

func (o *AccountOrderRecordNullable) UnmarshalJSON(bytes []byte) (err error)

func (*AccountOrderRecordNullable) UnsetBrokerageGroupOrderId added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetBrokerageGroupOrderId()

UnsetBrokerageGroupOrderId ensures that no value is present for BrokerageGroupOrderId, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetCanceledQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetCanceledQuantity()

UnsetCanceledQuantity ensures that no value is present for CanceledQuantity, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetChildBrokerageOrderIds added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetChildBrokerageOrderIds()

UnsetChildBrokerageOrderIds ensures that no value is present for ChildBrokerageOrderIds, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetExecutionPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetExecutionPrice()

UnsetExecutionPrice ensures that no value is present for ExecutionPrice, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetExpiryDate added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetExpiryDate()

UnsetExpiryDate ensures that no value is present for ExpiryDate, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetFilledQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetFilledQuantity()

UnsetFilledQuantity ensures that no value is present for FilledQuantity, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetLimitPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetLimitPrice()

UnsetLimitPrice ensures that no value is present for LimitPrice, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetOpenQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetOpenQuantity()

UnsetOpenQuantity ensures that no value is present for OpenQuantity, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetOptionSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetOptionSymbol()

UnsetOptionSymbol ensures that no value is present for OptionSymbol, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetOrderRole added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetOrderRole()

UnsetOrderRole ensures that no value is present for OrderRole, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetOrderType added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetOrderType()

UnsetOrderType ensures that no value is present for OrderType, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetQuoteCurrency added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetQuoteCurrency()

UnsetQuoteCurrency ensures that no value is present for QuoteCurrency, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetQuoteUniversalSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetQuoteUniversalSymbol()

UnsetQuoteUniversalSymbol ensures that no value is present for QuoteUniversalSymbol, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetStopPrice added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetStopPrice()

UnsetStopPrice ensures that no value is present for StopPrice, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetTimeExecuted added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetTimeExecuted()

UnsetTimeExecuted ensures that no value is present for TimeExecuted, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetTimeUpdated added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetTimeUpdated()

UnsetTimeUpdated ensures that no value is present for TimeUpdated, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetTotalQuantity added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetTotalQuantity()

UnsetTotalQuantity ensures that no value is present for TotalQuantity, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetTrailingStop added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetTrailingStop()

UnsetTrailingStop ensures that no value is present for TrailingStop, not even an explicit nil

func (*AccountOrderRecordNullable) UnsetUniversalSymbol added in v1.1.0 

func (o *AccountOrderRecordNullable) UnsetUniversalSymbol()

UnsetUniversalSymbol ensures that no value is present for UniversalSymbol, not even an explicit nil

type AccountOrderRecordStatus 

type AccountOrderRecordStatus string

AccountOrderRecordStatus Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include: - NONE - PENDING - ACCEPTED - FAILED - REJECTED - CANCELED - PARTIAL_CANCELED - CANCEL_PENDING - EXECUTED - PARTIAL - REPLACE_PENDING - REPLACED - EXPIRED - QUEUED - TRIGGERED - ACTIVATED 

const (
	ACCOUNTORDERRECORDSTATUS_NONE                AccountOrderRecordStatus = "NONE"
	ACCOUNTORDERRECORDSTATUS_PENDING             AccountOrderRecordStatus = "PENDING"
	ACCOUNTORDERRECORDSTATUS_ACCEPTED            AccountOrderRecordStatus = "ACCEPTED"
	ACCOUNTORDERRECORDSTATUS_FAILED              AccountOrderRecordStatus = "FAILED"
	ACCOUNTORDERRECORDSTATUS_REJECTED            AccountOrderRecordStatus = "REJECTED"
	ACCOUNTORDERRECORDSTATUS_CANCELED            AccountOrderRecordStatus = "CANCELED"
	ACCOUNTORDERRECORDSTATUS_PARTIAL_CANCELED    AccountOrderRecordStatus = "PARTIAL_CANCELED"
	ACCOUNTORDERRECORDSTATUS_CANCEL_PENDING      AccountOrderRecordStatus = "CANCEL_PENDING"
	ACCOUNTORDERRECORDSTATUS_EXECUTED            AccountOrderRecordStatus = "EXECUTED"
	ACCOUNTORDERRECORDSTATUS_PARTIAL             AccountOrderRecordStatus = "PARTIAL"
	ACCOUNTORDERRECORDSTATUS_REPLACE_PENDING     AccountOrderRecordStatus = "REPLACE_PENDING"
	ACCOUNTORDERRECORDSTATUS_REPLACED            AccountOrderRecordStatus = "REPLACED"
	ACCOUNTORDERRECORDSTATUS_STOPPED             AccountOrderRecordStatus = "STOPPED"
	ACCOUNTORDERRECORDSTATUS_SUSPENDED           AccountOrderRecordStatus = "SUSPENDED"
	ACCOUNTORDERRECORDSTATUS_EXPIRED             AccountOrderRecordStatus = "EXPIRED"
	ACCOUNTORDERRECORDSTATUS_QUEUED              AccountOrderRecordStatus = "QUEUED"
	ACCOUNTORDERRECORDSTATUS_TRIGGERED           AccountOrderRecordStatus = "TRIGGERED"
	ACCOUNTORDERRECORDSTATUS_ACTIVATED           AccountOrderRecordStatus = "ACTIVATED"
	ACCOUNTORDERRECORDSTATUS_PENDING_RISK_REVIEW AccountOrderRecordStatus = "PENDING_RISK_REVIEW"
	ACCOUNTORDERRECORDSTATUS_CONTINGENT_ORDER    AccountOrderRecordStatus = "CONTINGENT_ORDER"
)

List of AccountOrderRecordStatus

func NewAccountOrderRecordStatusFromValue 

func NewAccountOrderRecordStatusFromValue(v string) (*AccountOrderRecordStatus, error)

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

func (AccountOrderRecordStatus) IsValid 

func (v AccountOrderRecordStatus) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (AccountOrderRecordStatus) Ptr 

func (v AccountOrderRecordStatus) Ptr() *AccountOrderRecordStatus

Ptr returns reference to AccountOrderRecordStatus value

func (*AccountOrderRecordStatus) UnmarshalJSON 

func (v *AccountOrderRecordStatus) UnmarshalJSON(src []byte) error

type AccountOrderRecordStatusV2 added in v1.0.117 

type AccountOrderRecordStatusV2 string

AccountOrderRecordStatusV2 Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. 

const (
	ACCOUNTORDERRECORDSTATUSV2_PENDING            AccountOrderRecordStatusV2 = "PENDING"
	ACCOUNTORDERRECORDSTATUSV2_REJECTED           AccountOrderRecordStatusV2 = "REJECTED"
	ACCOUNTORDERRECORDSTATUSV2_CANCELED           AccountOrderRecordStatusV2 = "CANCELED"
	ACCOUNTORDERRECORDSTATUSV2_CANCEL_PENDING     AccountOrderRecordStatusV2 = "CANCEL_PENDING"
	ACCOUNTORDERRECORDSTATUSV2_PARTIAL_CANCELED   AccountOrderRecordStatusV2 = "PARTIAL_CANCELED"
	ACCOUNTORDERRECORDSTATUSV2_EXECUTED           AccountOrderRecordStatusV2 = "EXECUTED"
	ACCOUNTORDERRECORDSTATUSV2_PARTIALLY_EXECUTED AccountOrderRecordStatusV2 = "PARTIALLY_EXECUTED"
	ACCOUNTORDERRECORDSTATUSV2_REPLACED           AccountOrderRecordStatusV2 = "REPLACED"
	ACCOUNTORDERRECORDSTATUSV2_REPLACE_PENDING    AccountOrderRecordStatusV2 = "REPLACE_PENDING"
	ACCOUNTORDERRECORDSTATUSV2_EXPIRED            AccountOrderRecordStatusV2 = "EXPIRED"
)

List of AccountOrderRecordStatusV2

func NewAccountOrderRecordStatusV2FromValue added in v1.0.117 

func NewAccountOrderRecordStatusV2FromValue(v string) (*AccountOrderRecordStatusV2, error)

NewAccountOrderRecordStatusV2FromValue returns a pointer to a valid AccountOrderRecordStatusV2 for the value passed as argument, or an error if the value passed is not allowed by the enum

func (AccountOrderRecordStatusV2) IsValid added in v1.0.117 

func (v AccountOrderRecordStatusV2) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (AccountOrderRecordStatusV2) Ptr added in v1.0.117 

func (v AccountOrderRecordStatusV2) Ptr() *AccountOrderRecordStatusV2

Ptr returns reference to AccountOrderRecordStatusV2 value

func (*AccountOrderRecordStatusV2) UnmarshalJSON added in v1.0.117 

func (v *AccountOrderRecordStatusV2) UnmarshalJSON(src []byte) error

type AccountOrderRecordStatusV2Nullable added in v1.1.0 

type AccountOrderRecordStatusV2Nullable string

AccountOrderRecordStatusV2Nullable Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. 

const (
	ACCOUNTORDERRECORDSTATUSV2NULLABLE_PENDING            AccountOrderRecordStatusV2Nullable = "PENDING"
	ACCOUNTORDERRECORDSTATUSV2NULLABLE_REJECTED           AccountOrderRecordStatusV2Nullable = "REJECTED"
	ACCOUNTORDERRECORDSTATUSV2NULLABLE_CANCELED           AccountOrderRecordStatusV2Nullable = "CANCELED"
	ACCOUNTORDERRECORDSTATUSV2NULLABLE_CANCEL_PENDING     AccountOrderRecordStatusV2Nullable = "CANCEL_PENDING"
	ACCOUNTORDERRECORDSTATUSV2NULLABLE_PARTIAL_CANCELED   AccountOrderRecordStatusV2Nullable = "PARTIAL_CANCELED"
	ACCOUNTORDERRECORDSTATUSV2NULLABLE_EXECUTED           AccountOrderRecordStatusV2Nullable = "EXECUTED"
	ACCOUNTORDERRECORDSTATUSV2NULLABLE_PARTIALLY_EXECUTED AccountOrderRecordStatusV2Nullable = "PARTIALLY_EXECUTED"
	ACCOUNTORDERRECORDSTATUSV2NULLABLE_REPLACED           AccountOrderRecordStatusV2Nullable = "REPLACED"
	ACCOUNTORDERRECORDSTATUSV2NULLABLE_REPLACE_PENDING    AccountOrderRecordStatusV2Nullable = "REPLACE_PENDING"
	ACCOUNTORDERRECORDSTATUSV2NULLABLE_EXPIRED            AccountOrderRecordStatusV2Nullable = "EXPIRED"
)

List of AccountOrderRecordStatusV2Nullable

func NewAccountOrderRecordStatusV2NullableFromValue added in v1.1.0 

func NewAccountOrderRecordStatusV2NullableFromValue(v string) (*AccountOrderRecordStatusV2Nullable, error)

NewAccountOrderRecordStatusV2NullableFromValue returns a pointer to a valid AccountOrderRecordStatusV2Nullable for the value passed as argument, or an error if the value passed is not allowed by the enum

func (AccountOrderRecordStatusV2Nullable) IsValid added in v1.1.0 

func (v AccountOrderRecordStatusV2Nullable) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (AccountOrderRecordStatusV2Nullable) Ptr added in v1.1.0 

func (v AccountOrderRecordStatusV2Nullable) Ptr() *AccountOrderRecordStatusV2Nullable

Ptr returns reference to AccountOrderRecordStatusV2Nullable value

func (*AccountOrderRecordStatusV2Nullable) UnmarshalJSON added in v1.1.0 

func (v *AccountOrderRecordStatusV2Nullable) UnmarshalJSON(src []byte) error

type AccountOrderRecordV2 added in v1.0.117 

type AccountOrderRecordV2 struct {
	// Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
	BrokerageOrderId *string `json:"brokerage_order_id,omitempty"`
	// The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier.
	BrokerageGroupOrderId NullableString `json:"brokerage_group_order_id,omitempty"`
	// The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders.
	OrderRole NullableString            `json:"order_role,omitempty"`
	Status    *AccountOrderRecordStatus `json:"status,omitempty"`
	// The type of order placed.   - `MARKET`   - `LIMIT`   - `STOP`   - `STOP_LIMIT`
	OrderType NullableString `json:"order_type,omitempty"`
	// The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value.   - `DAY` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date.   - `MOO` - Market On Open. The order is to be executed at the day's opening price.   - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close.
	TimeInForce *string `json:"time_in_force,omitempty"`
	// The time the order was placed. This is the time the order was submitted to the brokerage.
	TimePlaced *time.Time `json:"time_placed,omitempty"`
	// The time the order was executed in the brokerage system. This value is not always available from the brokerage.
	TimeExecuted NullableTime `json:"time_executed,omitempty"`
	// Quote currency code for the order.
	QuoteCurrency *string `json:"quote_currency,omitempty"`
	// The price at which the order was executed.
	ExecutionPrice NullableFloat64 `json:"execution_price,omitempty"`
	// The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders.
	LimitPrice NullableFloat64 `json:"limit_price,omitempty"`
	// The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders.
	StopPrice    NullableFloat64              `json:"stop_price,omitempty"`
	TrailingStop NullableTrailingStopNullable `json:"trailing_stop,omitempty"`
	// List of legs that make up the order.
	Legs                 []AccountOrderRecordLeg `json:"legs,omitempty"`
	AdditionalProperties map[string]interface{}
}

AccountOrderRecordV2 Describes a single order in the standardized V2 format.

func NewAccountOrderRecordV2 added in v1.0.117 

func NewAccountOrderRecordV2() *AccountOrderRecordV2

NewAccountOrderRecordV2 instantiates a new AccountOrderRecordV2 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

func NewAccountOrderRecordV2WithDefaults added in v1.0.117 

func NewAccountOrderRecordV2WithDefaults() *AccountOrderRecordV2

NewAccountOrderRecordV2WithDefaults instantiates a new AccountOrderRecordV2 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

func (*AccountOrderRecordV2) GetBrokerageGroupOrderId added in v1.0.159 

func (o *AccountOrderRecordV2) GetBrokerageGroupOrderId() string

GetBrokerageGroupOrderId returns the BrokerageGroupOrderId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordV2) GetBrokerageGroupOrderIdOk added in v1.0.159 

func (o *AccountOrderRecordV2) GetBrokerageGroupOrderIdOk() (*string, bool)

GetBrokerageGroupOrderIdOk returns a tuple with the BrokerageGroupOrderId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordV2) GetBrokerageOrderId added in v1.0.117 

func (o *AccountOrderRecordV2) GetBrokerageOrderId() string

GetBrokerageOrderId returns the BrokerageOrderId field value if set, zero value otherwise.

func (*AccountOrderRecordV2) GetBrokerageOrderIdOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetBrokerageOrderIdOk() (*string, bool)

GetBrokerageOrderIdOk returns a tuple with the BrokerageOrderId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordV2) GetExecutionPrice added in v1.0.117 

func (o *AccountOrderRecordV2) GetExecutionPrice() float64

GetExecutionPrice returns the ExecutionPrice field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordV2) GetExecutionPriceOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetExecutionPriceOk() (*float64, bool)

GetExecutionPriceOk returns a tuple with the ExecutionPrice field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordV2) GetLegs added in v1.0.117 

func (o *AccountOrderRecordV2) GetLegs() []AccountOrderRecordLeg

GetLegs returns the Legs field value if set, zero value otherwise.

func (*AccountOrderRecordV2) GetLegsOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetLegsOk() ([]AccountOrderRecordLeg, bool)

GetLegsOk returns a tuple with the Legs field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordV2) GetLimitPrice added in v1.0.117 

func (o *AccountOrderRecordV2) GetLimitPrice() float64

GetLimitPrice returns the LimitPrice field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordV2) GetLimitPriceOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetLimitPriceOk() (*float64, bool)

GetLimitPriceOk returns a tuple with the LimitPrice field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordV2) GetOrderRole added in v1.0.159 

func (o *AccountOrderRecordV2) GetOrderRole() string

GetOrderRole returns the OrderRole field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordV2) GetOrderRoleOk added in v1.0.159 

func (o *AccountOrderRecordV2) GetOrderRoleOk() (*string, bool)

GetOrderRoleOk returns a tuple with the OrderRole field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordV2) GetOrderType added in v1.0.117 

func (o *AccountOrderRecordV2) GetOrderType() string

GetOrderType returns the OrderType field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordV2) GetOrderTypeOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetOrderTypeOk() (*string, bool)

GetOrderTypeOk returns a tuple with the OrderType field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordV2) GetQuoteCurrency added in v1.0.117 

func (o *AccountOrderRecordV2) GetQuoteCurrency() string

GetQuoteCurrency returns the QuoteCurrency field value if set, zero value otherwise.

func (*AccountOrderRecordV2) GetQuoteCurrencyOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetQuoteCurrencyOk() (*string, bool)

GetQuoteCurrencyOk returns a tuple with the QuoteCurrency field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordV2) GetStatus added in v1.0.117 

func (o *AccountOrderRecordV2) GetStatus() AccountOrderRecordStatus

GetStatus returns the Status field value if set, zero value otherwise.

func (*AccountOrderRecordV2) GetStatusOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetStatusOk() (*AccountOrderRecordStatus, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordV2) GetStopPrice added in v1.0.117 

func (o *AccountOrderRecordV2) GetStopPrice() float64

GetStopPrice returns the StopPrice field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordV2) GetStopPriceOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetStopPriceOk() (*float64, bool)

GetStopPriceOk returns a tuple with the StopPrice field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordV2) GetTimeExecuted added in v1.0.117 

func (o *AccountOrderRecordV2) GetTimeExecuted() time.Time

GetTimeExecuted returns the TimeExecuted field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordV2) GetTimeExecutedOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetTimeExecutedOk() (*time.Time, bool)

GetTimeExecutedOk returns a tuple with the TimeExecuted field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordV2) GetTimeInForce added in v1.0.117 

func (o *AccountOrderRecordV2) GetTimeInForce() string

GetTimeInForce returns the TimeInForce field value if set, zero value otherwise.

func (*AccountOrderRecordV2) GetTimeInForceOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetTimeInForceOk() (*string, bool)

GetTimeInForceOk returns a tuple with the TimeInForce field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordV2) GetTimePlaced added in v1.0.117 

func (o *AccountOrderRecordV2) GetTimePlaced() time.Time

GetTimePlaced returns the TimePlaced field value if set, zero value otherwise.

func (*AccountOrderRecordV2) GetTimePlacedOk added in v1.0.117 

func (o *AccountOrderRecordV2) GetTimePlacedOk() (*time.Time, bool)

GetTimePlacedOk returns a tuple with the TimePlaced field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountOrderRecordV2) GetTrailingStop added in v1.0.150 

func (o *AccountOrderRecordV2) GetTrailingStop() TrailingStopNullable

GetTrailingStop returns the TrailingStop field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountOrderRecordV2) GetTrailingStopOk added in v1.0.150 

func (o *AccountOrderRecordV2) GetTrailingStopOk() (*TrailingStopNullable, bool)

GetTrailingStopOk returns a tuple with the TrailingStop field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountOrderRecordV2) HasBrokerageGroupOrderId added in v1.0.159 

func (o *AccountOrderRecordV2) HasBrokerageGroupOrderId() bool

HasBrokerageGroupOrderId returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasBrokerageOrderId added in v1.0.117 

func (o *AccountOrderRecordV2) HasBrokerageOrderId() bool

HasBrokerageOrderId returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasExecutionPrice added in v1.0.117 

func (o *AccountOrderRecordV2) HasExecutionPrice() bool

HasExecutionPrice returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasLegs added in v1.0.117 

func (o *AccountOrderRecordV2) HasLegs() bool

HasLegs returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasLimitPrice added in v1.0.117 

func (o *AccountOrderRecordV2) HasLimitPrice() bool

HasLimitPrice returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasOrderRole added in v1.0.159 

func (o *AccountOrderRecordV2) HasOrderRole() bool

HasOrderRole returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasOrderType added in v1.0.117 

func (o *AccountOrderRecordV2) HasOrderType() bool

HasOrderType returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasQuoteCurrency added in v1.0.117 

func (o *AccountOrderRecordV2) HasQuoteCurrency() bool

HasQuoteCurrency returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasStatus added in v1.0.117 

func (o *AccountOrderRecordV2) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasStopPrice added in v1.0.117 

func (o *AccountOrderRecordV2) HasStopPrice() bool

HasStopPrice returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasTimeExecuted added in v1.0.117 

func (o *AccountOrderRecordV2) HasTimeExecuted() bool

HasTimeExecuted returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasTimeInForce added in v1.0.117 

func (o *AccountOrderRecordV2) HasTimeInForce() bool

HasTimeInForce returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasTimePlaced added in v1.0.117 

func (o *AccountOrderRecordV2) HasTimePlaced() bool

HasTimePlaced returns a boolean if a field has been set.

func (*AccountOrderRecordV2) HasTrailingStop added in v1.0.150 

func (o *AccountOrderRecordV2) HasTrailingStop() bool

HasTrailingStop returns a boolean if a field has been set.

func (AccountOrderRecordV2) MarshalJSON added in v1.0.117 

func (o AccountOrderRecordV2) MarshalJSON() ([]byte, error)

func (*AccountOrderRecordV2) SetBrokerageGroupOrderId added in v1.0.159 

func (o *AccountOrderRecordV2) SetBrokerageGroupOrderId(v string)

SetBrokerageGroupOrderId gets a reference to the given NullableString and assigns it to the BrokerageGroupOrderId field.

func (*AccountOrderRecordV2) SetBrokerageGroupOrderIdNil added in v1.0.159 

func (o *AccountOrderRecordV2) SetBrokerageGroupOrderIdNil()

SetBrokerageGroupOrderIdNil sets the value for BrokerageGroupOrderId to be an explicit nil

func (*AccountOrderRecordV2) SetBrokerageOrderId added in v1.0.117 

func (o *AccountOrderRecordV2) SetBrokerageOrderId(v string)

SetBrokerageOrderId gets a reference to the given string and assigns it to the BrokerageOrderId field.

func (*AccountOrderRecordV2) SetExecutionPrice added in v1.0.117 

func (o *AccountOrderRecordV2) SetExecutionPrice(v float64)

SetExecutionPrice gets a reference to the given NullableFloat64 and assigns it to the ExecutionPrice field.

func (*AccountOrderRecordV2) SetExecutionPriceNil added in v1.0.117 

func (o *AccountOrderRecordV2) SetExecutionPriceNil()

SetExecutionPriceNil sets the value for ExecutionPrice to be an explicit nil

func (*AccountOrderRecordV2) SetLegs added in v1.0.117 

func (o *AccountOrderRecordV2) SetLegs(v []AccountOrderRecordLeg)

SetLegs gets a reference to the given []AccountOrderRecordLeg and assigns it to the Legs field.

func (*AccountOrderRecordV2) SetLimitPrice added in v1.0.117 

func (o *AccountOrderRecordV2) SetLimitPrice(v float64)

SetLimitPrice gets a reference to the given NullableFloat64 and assigns it to the LimitPrice field.

func (*AccountOrderRecordV2) SetLimitPriceNil added in v1.0.117 

func (o *AccountOrderRecordV2) SetLimitPriceNil()

SetLimitPriceNil sets the value for LimitPrice to be an explicit nil

func (*AccountOrderRecordV2) SetOrderRole added in v1.0.159 

func (o *AccountOrderRecordV2) SetOrderRole(v string)

SetOrderRole gets a reference to the given NullableString and assigns it to the OrderRole field.

func (*AccountOrderRecordV2) SetOrderRoleNil added in v1.0.159 

func (o *AccountOrderRecordV2) SetOrderRoleNil()

SetOrderRoleNil sets the value for OrderRole to be an explicit nil

func (*AccountOrderRecordV2) SetOrderType added in v1.0.117 

func (o *AccountOrderRecordV2) SetOrderType(v string)

SetOrderType gets a reference to the given NullableString and assigns it to the OrderType field.

func (*AccountOrderRecordV2) SetOrderTypeNil added in v1.0.117 

func (o *AccountOrderRecordV2) SetOrderTypeNil()

SetOrderTypeNil sets the value for OrderType to be an explicit nil

func (*AccountOrderRecordV2) SetQuoteCurrency added in v1.0.117 

func (o *AccountOrderRecordV2) SetQuoteCurrency(v string)

SetQuoteCurrency gets a reference to the given string and assigns it to the QuoteCurrency field.

func (*AccountOrderRecordV2) SetStatus added in v1.0.117 

func (o *AccountOrderRecordV2) SetStatus(v AccountOrderRecordStatus)

SetStatus gets a reference to the given AccountOrderRecordStatus and assigns it to the Status field.

func (*AccountOrderRecordV2) SetStopPrice added in v1.0.117 

func (o *AccountOrderRecordV2) SetStopPrice(v float64)

SetStopPrice gets a reference to the given NullableFloat64 and assigns it to the StopPrice field.

func (*AccountOrderRecordV2) SetStopPriceNil added in v1.0.117 

func (o *AccountOrderRecordV2) SetStopPriceNil()

SetStopPriceNil sets the value for StopPrice to be an explicit nil

func (*AccountOrderRecordV2) SetTimeExecuted added in v1.0.117 

func (o *AccountOrderRecordV2) SetTimeExecuted(v time.Time)

SetTimeExecuted gets a reference to the given NullableTime and assigns it to the TimeExecuted field.

func (*AccountOrderRecordV2) SetTimeExecutedNil added in v1.0.117 

func (o *AccountOrderRecordV2) SetTimeExecutedNil()

SetTimeExecutedNil sets the value for TimeExecuted to be an explicit nil

func (*AccountOrderRecordV2) SetTimeInForce added in v1.0.117 

func (o *AccountOrderRecordV2) SetTimeInForce(v string)

SetTimeInForce gets a reference to the given string and assigns it to the TimeInForce field.

func (*AccountOrderRecordV2) SetTimePlaced added in v1.0.117 

func (o *AccountOrderRecordV2) SetTimePlaced(v time.Time)

SetTimePlaced gets a reference to the given time.Time and assigns it to the TimePlaced field.

func (*AccountOrderRecordV2) SetTrailingStop added in v1.0.150 

func (o *AccountOrderRecordV2) SetTrailingStop(v TrailingStopNullable)

SetTrailingStop gets a reference to the given NullableTrailingStopNullable and assigns it to the TrailingStop field.

func (*AccountOrderRecordV2) SetTrailingStopNil added in v1.0.150 

func (o *AccountOrderRecordV2) SetTrailingStopNil()

SetTrailingStopNil sets the value for TrailingStop to be an explicit nil

func (*AccountOrderRecordV2) UnmarshalJSON added in v1.0.117 

func (o *AccountOrderRecordV2) UnmarshalJSON(bytes []byte) (err error)

func (*AccountOrderRecordV2) UnsetBrokerageGroupOrderId added in v1.0.159 

func (o *AccountOrderRecordV2) UnsetBrokerageGroupOrderId()

UnsetBrokerageGroupOrderId ensures that no value is present for BrokerageGroupOrderId, not even an explicit nil

func (*AccountOrderRecordV2) UnsetExecutionPrice added in v1.0.117 

func (o *AccountOrderRecordV2) UnsetExecutionPrice()

UnsetExecutionPrice ensures that no value is present for ExecutionPrice, not even an explicit nil

func (*AccountOrderRecordV2) UnsetLimitPrice added in v1.0.117 

func (o *AccountOrderRecordV2) UnsetLimitPrice()

UnsetLimitPrice ensures that no value is present for LimitPrice, not even an explicit nil

func (*AccountOrderRecordV2) UnsetOrderRole added in v1.0.159 

func (o *AccountOrderRecordV2) UnsetOrderRole()

UnsetOrderRole ensures that no value is present for OrderRole, not even an explicit nil

func (*AccountOrderRecordV2) UnsetOrderType added in v1.0.117 

func (o *AccountOrderRecordV2) UnsetOrderType()

UnsetOrderType ensures that no value is present for OrderType, not even an explicit nil

func (*AccountOrderRecordV2) UnsetStopPrice added in v1.0.117 

func (o *AccountOrderRecordV2) UnsetStopPrice()

UnsetStopPrice ensures that no value is present for StopPrice, not even an explicit nil

func (*AccountOrderRecordV2) UnsetTimeExecuted added in v1.0.117 

func (o *AccountOrderRecordV2) UnsetTimeExecuted()

UnsetTimeExecuted ensures that no value is present for TimeExecuted, not even an explicit nil

func (*AccountOrderRecordV2) UnsetTrailingStop added in v1.0.150 

func (o *AccountOrderRecordV2) UnsetTrailingStop()

UnsetTrailingStop ensures that no value is present for TrailingStop, not even an explicit nil

type AccountOrdersV2Response added in v1.0.117 

type AccountOrdersV2Response struct {
	// List of orders returned by the endpoint.
	Orders               []AccountOrderRecordV2 `json:"orders"`
	AdditionalProperties map[string]interface{}
}

AccountOrdersV2Response Contains a standardized list of account orders in the V2 format.

func NewAccountOrdersV2Response added in v1.0.117 

func NewAccountOrdersV2Response(orders []AccountOrderRecordV2) *AccountOrdersV2Response

NewAccountOrdersV2Response instantiates a new AccountOrdersV2Response 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

func NewAccountOrdersV2ResponseWithDefaults added in v1.0.117 

func NewAccountOrdersV2ResponseWithDefaults() *AccountOrdersV2Response

NewAccountOrdersV2ResponseWithDefaults instantiates a new AccountOrdersV2Response 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

func (*AccountOrdersV2Response) GetOrders added in v1.0.117 

func (o *AccountOrdersV2Response) GetOrders() []AccountOrderRecordV2

GetOrders returns the Orders field value

func (*AccountOrdersV2Response) GetOrdersOk added in v1.0.117 

func (o *AccountOrdersV2Response) GetOrdersOk() ([]AccountOrderRecordV2, bool)

GetOrdersOk returns a tuple with the Orders field value and a boolean to check if the value has been set.

func (AccountOrdersV2Response) MarshalJSON added in v1.0.117 

func (o AccountOrdersV2Response) MarshalJSON() ([]byte, error)

func (*AccountOrdersV2Response) SetOrders added in v1.0.117 

func (o *AccountOrdersV2Response) SetOrders(v []AccountOrderRecordV2)

SetOrders sets field value

func (*AccountOrdersV2Response) UnmarshalJSON added in v1.0.117 

func (o *AccountOrdersV2Response) UnmarshalJSON(bytes []byte) (err error)

type AccountPosition added in v1.0.158 

type AccountPosition struct {
	Instrument Instrument `json:"instrument"`
	// The number of units held in the position. Positive numbers indicate long positions and negative numbers indicate short positions.
	Units NullableFloat64 `json:"units,omitempty"`
	// Last known market price _per share_. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
	Price NullableFloat64 `json:"price,omitempty"`
	// Book price or average purchase price for the position. For options, this is per-share.
	CostBasis NullableFloat64 `json:"cost_basis,omitempty"`
	// ISO-4217 currency code for the position `price` and `cost_basis`.
	Currency NullableString `json:"currency,omitempty"`
	// Present for mutual fund positions that are also counted in cash balance or buying power.
	CashEquivalent *bool `json:"cash_equivalent,omitempty"`
	// List of tax lots for the given position (disabled by default, only available on paid plans, contact support if needed)
	TaxLots              []TaxLot `json:"tax_lots,omitempty"`
	AdditionalProperties map[string]interface{}
}

AccountPosition Describes a single position.

func NewAccountPosition added in v1.0.158 

func NewAccountPosition(instrument Instrument) *AccountPosition

NewAccountPosition instantiates a new AccountPosition 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

func NewAccountPositionWithDefaults added in v1.0.158 

func NewAccountPositionWithDefaults() *AccountPosition

NewAccountPositionWithDefaults instantiates a new AccountPosition 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

func (*AccountPosition) GetCashEquivalent added in v1.0.158 

func (o *AccountPosition) GetCashEquivalent() bool

GetCashEquivalent returns the CashEquivalent field value if set, zero value otherwise.

func (*AccountPosition) GetCashEquivalentOk added in v1.0.158 

func (o *AccountPosition) GetCashEquivalentOk() (*bool, bool)

GetCashEquivalentOk returns a tuple with the CashEquivalent field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountPosition) GetCostBasis added in v1.0.158 

func (o *AccountPosition) GetCostBasis() float64

GetCostBasis returns the CostBasis field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountPosition) GetCostBasisOk added in v1.0.158 

func (o *AccountPosition) GetCostBasisOk() (*float64, bool)

GetCostBasisOk returns a tuple with the CostBasis field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountPosition) GetCurrency added in v1.0.158 

func (o *AccountPosition) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountPosition) GetCurrencyOk added in v1.0.158 

func (o *AccountPosition) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountPosition) GetInstrument added in v1.0.158 

func (o *AccountPosition) GetInstrument() Instrument

GetInstrument returns the Instrument field value

func (*AccountPosition) GetInstrumentOk added in v1.0.158 

func (o *AccountPosition) GetInstrumentOk() (*Instrument, bool)

GetInstrumentOk returns a tuple with the Instrument field value and a boolean to check if the value has been set.

func (*AccountPosition) GetPrice added in v1.0.158 

func (o *AccountPosition) GetPrice() float64

GetPrice returns the Price field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountPosition) GetPriceOk added in v1.0.158 

func (o *AccountPosition) GetPriceOk() (*float64, bool)

GetPriceOk returns a tuple with the Price field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountPosition) GetTaxLots added in v1.0.158 

func (o *AccountPosition) GetTaxLots() []TaxLot

GetTaxLots returns the TaxLots field value if set, zero value otherwise.

func (*AccountPosition) GetTaxLotsOk added in v1.0.158 

func (o *AccountPosition) GetTaxLotsOk() ([]TaxLot, bool)

GetTaxLotsOk returns a tuple with the TaxLots field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountPosition) GetUnits added in v1.0.158 

func (o *AccountPosition) GetUnits() float64

GetUnits returns the Units field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountPosition) GetUnitsOk added in v1.0.158 

func (o *AccountPosition) GetUnitsOk() (*float64, bool)

GetUnitsOk returns a tuple with the Units field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountPosition) HasCashEquivalent added in v1.0.158 

func (o *AccountPosition) HasCashEquivalent() bool

HasCashEquivalent returns a boolean if a field has been set.

func (*AccountPosition) HasCostBasis added in v1.0.158 

func (o *AccountPosition) HasCostBasis() bool

HasCostBasis returns a boolean if a field has been set.

func (*AccountPosition) HasCurrency added in v1.0.158 

func (o *AccountPosition) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*AccountPosition) HasPrice added in v1.0.158 

func (o *AccountPosition) HasPrice() bool

HasPrice returns a boolean if a field has been set.

func (*AccountPosition) HasTaxLots added in v1.0.158 

func (o *AccountPosition) HasTaxLots() bool

HasTaxLots returns a boolean if a field has been set.

func (*AccountPosition) HasUnits added in v1.0.158 

func (o *AccountPosition) HasUnits() bool

HasUnits returns a boolean if a field has been set.

func (AccountPosition) MarshalJSON added in v1.0.158 

func (o AccountPosition) MarshalJSON() ([]byte, error)

func (*AccountPosition) SetCashEquivalent added in v1.0.158 

func (o *AccountPosition) SetCashEquivalent(v bool)

SetCashEquivalent gets a reference to the given bool and assigns it to the CashEquivalent field.

func (*AccountPosition) SetCostBasis added in v1.0.158 

func (o *AccountPosition) SetCostBasis(v float64)

SetCostBasis gets a reference to the given NullableFloat64 and assigns it to the CostBasis field.

func (*AccountPosition) SetCostBasisNil added in v1.0.158 

func (o *AccountPosition) SetCostBasisNil()

SetCostBasisNil sets the value for CostBasis to be an explicit nil

func (*AccountPosition) SetCurrency added in v1.0.158 

func (o *AccountPosition) SetCurrency(v string)

SetCurrency gets a reference to the given NullableString and assigns it to the Currency field.

func (*AccountPosition) SetCurrencyNil added in v1.0.158 

func (o *AccountPosition) SetCurrencyNil()

SetCurrencyNil sets the value for Currency to be an explicit nil

func (*AccountPosition) SetInstrument added in v1.0.158 

func (o *AccountPosition) SetInstrument(v Instrument)

SetInstrument sets field value

func (*AccountPosition) SetPrice added in v1.0.158 

func (o *AccountPosition) SetPrice(v float64)

SetPrice gets a reference to the given NullableFloat64 and assigns it to the Price field.

func (*AccountPosition) SetPriceNil added in v1.0.158 

func (o *AccountPosition) SetPriceNil()

SetPriceNil sets the value for Price to be an explicit nil

func (*AccountPosition) SetTaxLots added in v1.0.158 

func (o *AccountPosition) SetTaxLots(v []TaxLot)

SetTaxLots gets a reference to the given []TaxLot and assigns it to the TaxLots field.

func (*AccountPosition) SetUnits added in v1.0.158 

func (o *AccountPosition) SetUnits(v float64)

SetUnits gets a reference to the given NullableFloat64 and assigns it to the Units field.

func (*AccountPosition) SetUnitsNil added in v1.0.158 

func (o *AccountPosition) SetUnitsNil()

SetUnitsNil sets the value for Units to be an explicit nil

func (*AccountPosition) UnmarshalJSON added in v1.0.158 

func (o *AccountPosition) UnmarshalJSON(bytes []byte) (err error)

func (*AccountPosition) UnsetCostBasis added in v1.0.158 

func (o *AccountPosition) UnsetCostBasis()

UnsetCostBasis ensures that no value is present for CostBasis, not even an explicit nil

func (*AccountPosition) UnsetCurrency added in v1.0.158 

func (o *AccountPosition) UnsetCurrency()

UnsetCurrency ensures that no value is present for Currency, not even an explicit nil

func (*AccountPosition) UnsetPrice added in v1.0.158 

func (o *AccountPosition) UnsetPrice()

UnsetPrice ensures that no value is present for Price, not even an explicit nil

func (*AccountPosition) UnsetUnits added in v1.0.158 

func (o *AccountPosition) UnsetUnits()

UnsetUnits ensures that no value is present for Units, not even an explicit nil

type AccountSimple 

type AccountSimple struct {
	// Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
	Id *string `json:"id,omitempty"`
	// A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
	Name *string `json:"name,omitempty"`
	// The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
	Number *string `json:"number,omitempty"`
	// A stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.
	InstitutionAccountId NullableString     `json:"institution_account_id,omitempty"`
	SyncStatus           *AccountSyncStatus `json:"sync_status,omitempty"`
	AdditionalProperties map[string]interface{}
}

AccountSimple A single account at a brokerage.

func NewAccountSimple 

func NewAccountSimple() *AccountSimple

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

func NewAccountSimpleWithDefaults 

func NewAccountSimpleWithDefaults() *AccountSimple

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

func (*AccountSimple) GetId 

func (o *AccountSimple) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*AccountSimple) GetIdOk 

func (o *AccountSimple) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountSimple) GetInstitutionAccountId added in v1.0.137 

func (o *AccountSimple) GetInstitutionAccountId() string

GetInstitutionAccountId returns the InstitutionAccountId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountSimple) GetInstitutionAccountIdOk added in v1.0.137 

func (o *AccountSimple) GetInstitutionAccountIdOk() (*string, bool)

GetInstitutionAccountIdOk returns a tuple with the InstitutionAccountId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountSimple) GetName 

func (o *AccountSimple) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*AccountSimple) GetNameOk 

func (o *AccountSimple) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountSimple) GetNumber 

func (o *AccountSimple) GetNumber() string

GetNumber returns the Number field value if set, zero value otherwise.

func (*AccountSimple) GetNumberOk 

func (o *AccountSimple) GetNumberOk() (*string, bool)

GetNumberOk returns a tuple with the Number field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountSimple) GetSyncStatus 

func (o *AccountSimple) GetSyncStatus() AccountSyncStatus

GetSyncStatus returns the SyncStatus field value if set, zero value otherwise.

func (*AccountSimple) GetSyncStatusOk 

func (o *AccountSimple) GetSyncStatusOk() (*AccountSyncStatus, bool)

GetSyncStatusOk returns a tuple with the SyncStatus field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountSimple) HasId 

func (o *AccountSimple) HasId() bool

HasId returns a boolean if a field has been set.

func (*AccountSimple) HasInstitutionAccountId added in v1.0.137 

func (o *AccountSimple) HasInstitutionAccountId() bool

HasInstitutionAccountId returns a boolean if a field has been set.

func (*AccountSimple) HasName 

func (o *AccountSimple) HasName() bool

HasName returns a boolean if a field has been set.

func (*AccountSimple) HasNumber 

func (o *AccountSimple) HasNumber() bool

HasNumber returns a boolean if a field has been set.

func (*AccountSimple) HasSyncStatus 

func (o *AccountSimple) HasSyncStatus() bool

HasSyncStatus returns a boolean if a field has been set.

func (AccountSimple) MarshalJSON 

func (o AccountSimple) MarshalJSON() ([]byte, error)

func (*AccountSimple) SetId 

func (o *AccountSimple) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*AccountSimple) SetInstitutionAccountId added in v1.0.137 

func (o *AccountSimple) SetInstitutionAccountId(v string)

SetInstitutionAccountId gets a reference to the given NullableString and assigns it to the InstitutionAccountId field.

func (*AccountSimple) SetInstitutionAccountIdNil added in v1.0.137 

func (o *AccountSimple) SetInstitutionAccountIdNil()

SetInstitutionAccountIdNil sets the value for InstitutionAccountId to be an explicit nil

func (*AccountSimple) SetName 

func (o *AccountSimple) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*AccountSimple) SetNumber 

func (o *AccountSimple) SetNumber(v string)

SetNumber gets a reference to the given string and assigns it to the Number field.

func (*AccountSimple) SetSyncStatus 

func (o *AccountSimple) SetSyncStatus(v AccountSyncStatus)

SetSyncStatus gets a reference to the given AccountSyncStatus and assigns it to the SyncStatus field.

func (*AccountSimple) UnmarshalJSON 

func (o *AccountSimple) UnmarshalJSON(bytes []byte) (err error)

func (*AccountSimple) UnsetInstitutionAccountId added in v1.0.137 

func (o *AccountSimple) UnsetInstitutionAccountId()

UnsetInstitutionAccountId ensures that no value is present for InstitutionAccountId, not even an explicit nil

type AccountSyncStatus 

type AccountSyncStatus struct {
	Transactions *TransactionsStatus `json:"transactions,omitempty"`
	Holdings     *HoldingsStatus     `json:"holdings,omitempty"`
}

AccountSyncStatus Contains status update for the account sync process between SnapTrade and the brokerage.

func NewAccountSyncStatus 

func NewAccountSyncStatus() *AccountSyncStatus

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

func NewAccountSyncStatusWithDefaults 

func NewAccountSyncStatusWithDefaults() *AccountSyncStatus

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

func (*AccountSyncStatus) GetHoldings 

func (o *AccountSyncStatus) GetHoldings() HoldingsStatus

GetHoldings returns the Holdings field value if set, zero value otherwise.

func (*AccountSyncStatus) GetHoldingsOk 

func (o *AccountSyncStatus) GetHoldingsOk() (*HoldingsStatus, bool)

GetHoldingsOk returns a tuple with the Holdings field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountSyncStatus) GetTransactions 

func (o *AccountSyncStatus) GetTransactions() TransactionsStatus

GetTransactions returns the Transactions field value if set, zero value otherwise.

func (*AccountSyncStatus) GetTransactionsOk 

func (o *AccountSyncStatus) GetTransactionsOk() (*TransactionsStatus, bool)

GetTransactionsOk returns a tuple with the Transactions field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountSyncStatus) HasHoldings 

func (o *AccountSyncStatus) HasHoldings() bool

HasHoldings returns a boolean if a field has been set.

func (*AccountSyncStatus) HasTransactions 

func (o *AccountSyncStatus) HasTransactions() bool

HasTransactions returns a boolean if a field has been set.

func (AccountSyncStatus) MarshalJSON 

func (o AccountSyncStatus) MarshalJSON() ([]byte, error)

func (*AccountSyncStatus) SetHoldings 

func (o *AccountSyncStatus) SetHoldings(v HoldingsStatus)

SetHoldings gets a reference to the given HoldingsStatus and assigns it to the Holdings field.

func (*AccountSyncStatus) SetTransactions 

func (o *AccountSyncStatus) SetTransactions(v TransactionsStatus)

SetTransactions gets a reference to the given TransactionsStatus and assigns it to the Transactions field.

type AccountUniversalActivity added in v1.0.46 

type AccountUniversalActivity struct {
	// Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade.  Please note that this ID _can_ change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one.
	Id                      *string                       `json:"id,omitempty"`
	Symbol                  NullableSymbolNullable        `json:"symbol,omitempty"`
	CurrencyUniversalSymbol NullableSymbolNullable        `json:"currency_universal_symbol,omitempty"`
	OptionSymbol            NullableOptionsSymbolNullable `json:"option_symbol,omitempty"`
	// The price of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions. For option transactions, this represents the price per share of the option contract.
	Price *float32 `json:"price,omitempty"`
	// The number of units of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions.
	Units *float32 `json:"units,omitempty"`
	// The amount of the transaction denominated in `currency`. This can be positive or negative. In general, transactions that positively affect the account balance (like sell, deposits, dividends, etc) will have a positive amount, while transactions that negatively affect the account balance (like buy, withdrawals, fees, etc) will have a negative amount.
	Amount   NullableFloat32          `json:"amount,omitempty"`
	Currency NullableCurrencyNullable `json:"currency,omitempty"`
	// A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `TAX` - A tax related fee.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of asset(s) from one account to another.   - `EXTERNAL_ASSET_TRANSFER_IN` - Incoming transfer of an asset from an external account to this account.   - `EXTERNAL_ASSET_TRANSFER_OUT` - Outgoing transfer of an asset from this account to an external account.   - `SPLIT` - A stock share split.   - `ADJUSTMENT` - A one time adjustment of the account's cash balance or shares of an asset
	Type *string `json:"type,omitempty"`
	// If an option `BUY` or `SELL` transaction, this further specifies the type of action. The possible values are: - BUY_TO_OPEN - BUY_TO_CLOSE - SELL_TO_OPEN - SELL_TO_CLOSE
	OptionType *string `json:"option_type,omitempty"`
	// A human-readable description of the transaction. This is usually the brokerage's description of the transaction.
	Description *string `json:"description,omitempty"`
	// The recorded time for the transaction. The granularity of this timestamp depends on the brokerage. Some brokerages provide the exact time of the transaction, while others provide only the date. Please check the [integrations page](https://support.snaptrade.com/brokerages-table?v=6fab8012ade6441fa0c6d9af9c55ce3a) for the specific brokerage to see the granularity of the timestamps. Note that even though the field is named `trade_date`, it can represent any type of transaction, not just trades.
	TradeDate NullableTime `json:"trade_date,omitempty"`
	// The date on which the transaction is settled.
	SettlementDate *time.Time `json:"settlement_date,omitempty"`
	// Any fee associated with the transaction if provided by the brokerage.
	Fee *float32 `json:"fee,omitempty"`
	// The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -> currency)
	FxRate NullableFloat32 `json:"fx_rate,omitempty"`
	// The institution that the transaction is associated with. This is usually the brokerage name.
	Institution *string `json:"institution,omitempty"`
	// Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same `external_reference_id`
	ExternalReferenceId  NullableString `json:"external_reference_id,omitempty"`
	AdditionalProperties map[string]interface{}
}

AccountUniversalActivity A transaction or activity from an institution

func NewAccountUniversalActivity added in v1.0.46 

func NewAccountUniversalActivity() *AccountUniversalActivity

NewAccountUniversalActivity instantiates a new AccountUniversalActivity 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

func NewAccountUniversalActivityWithDefaults added in v1.0.46 

func NewAccountUniversalActivityWithDefaults() *AccountUniversalActivity

NewAccountUniversalActivityWithDefaults instantiates a new AccountUniversalActivity 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

func (*AccountUniversalActivity) GetAmount added in v1.0.46 

func (o *AccountUniversalActivity) GetAmount() float32

GetAmount returns the Amount field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountUniversalActivity) GetAmountOk added in v1.0.46 

func (o *AccountUniversalActivity) GetAmountOk() (*float32, bool)

GetAmountOk returns a tuple with the Amount field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountUniversalActivity) GetCurrency added in v1.0.46 

func (o *AccountUniversalActivity) GetCurrency() CurrencyNullable

GetCurrency returns the Currency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountUniversalActivity) GetCurrencyOk added in v1.0.46 

func (o *AccountUniversalActivity) GetCurrencyOk() (*CurrencyNullable, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountUniversalActivity) GetCurrencyUniversalSymbol added in v1.0.177 

func (o *AccountUniversalActivity) GetCurrencyUniversalSymbol() SymbolNullable

GetCurrencyUniversalSymbol returns the CurrencyUniversalSymbol field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountUniversalActivity) GetCurrencyUniversalSymbolOk added in v1.0.177 

func (o *AccountUniversalActivity) GetCurrencyUniversalSymbolOk() (*SymbolNullable, bool)

GetCurrencyUniversalSymbolOk returns a tuple with the CurrencyUniversalSymbol field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountUniversalActivity) GetDescription added in v1.0.46 

func (o *AccountUniversalActivity) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*AccountUniversalActivity) GetDescriptionOk added in v1.0.46 

func (o *AccountUniversalActivity) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountUniversalActivity) GetExternalReferenceId added in v1.0.46 

func (o *AccountUniversalActivity) GetExternalReferenceId() string

GetExternalReferenceId returns the ExternalReferenceId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountUniversalActivity) GetExternalReferenceIdOk added in v1.0.46 

func (o *AccountUniversalActivity) GetExternalReferenceIdOk() (*string, bool)

GetExternalReferenceIdOk returns a tuple with the ExternalReferenceId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountUniversalActivity) GetFee added in v1.0.46 

func (o *AccountUniversalActivity) GetFee() float32

GetFee returns the Fee field value if set, zero value otherwise.

func (*AccountUniversalActivity) GetFeeOk added in v1.0.46 

func (o *AccountUniversalActivity) GetFeeOk() (*float32, bool)

GetFeeOk returns a tuple with the Fee field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountUniversalActivity) GetFxRate added in v1.0.46 

func (o *AccountUniversalActivity) GetFxRate() float32

GetFxRate returns the FxRate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountUniversalActivity) GetFxRateOk added in v1.0.46 

func (o *AccountUniversalActivity) GetFxRateOk() (*float32, bool)

GetFxRateOk returns a tuple with the FxRate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountUniversalActivity) GetId added in v1.0.46 

func (o *AccountUniversalActivity) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*AccountUniversalActivity) GetIdOk added in v1.0.46 

func (o *AccountUniversalActivity) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountUniversalActivity) GetInstitution added in v1.0.46 

func (o *AccountUniversalActivity) GetInstitution() string

GetInstitution returns the Institution field value if set, zero value otherwise.

func (*AccountUniversalActivity) GetInstitutionOk added in v1.0.46 

func (o *AccountUniversalActivity) GetInstitutionOk() (*string, bool)

GetInstitutionOk returns a tuple with the Institution field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountUniversalActivity) GetOptionSymbol added in v1.0.46 

func (o *AccountUniversalActivity) GetOptionSymbol() OptionsSymbolNullable

GetOptionSymbol returns the OptionSymbol field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountUniversalActivity) GetOptionSymbolOk added in v1.0.46 

func (o *AccountUniversalActivity) GetOptionSymbolOk() (*OptionsSymbolNullable, bool)

GetOptionSymbolOk returns a tuple with the OptionSymbol field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountUniversalActivity) GetOptionType added in v1.0.46 

func (o *AccountUniversalActivity) GetOptionType() string

GetOptionType returns the OptionType field value if set, zero value otherwise.

func (*AccountUniversalActivity) GetOptionTypeOk added in v1.0.46 

func (o *AccountUniversalActivity) GetOptionTypeOk() (*string, bool)

GetOptionTypeOk returns a tuple with the OptionType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountUniversalActivity) GetPrice added in v1.0.46 

func (o *AccountUniversalActivity) GetPrice() float32

GetPrice returns the Price field value if set, zero value otherwise.

func (*AccountUniversalActivity) GetPriceOk added in v1.0.46 

func (o *AccountUniversalActivity) GetPriceOk() (*float32, bool)

GetPriceOk returns a tuple with the Price field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountUniversalActivity) GetSettlementDate added in v1.0.46 

func (o *AccountUniversalActivity) GetSettlementDate() time.Time

GetSettlementDate returns the SettlementDate field value if set, zero value otherwise.

func (*AccountUniversalActivity) GetSettlementDateOk added in v1.0.46 

func (o *AccountUniversalActivity) GetSettlementDateOk() (*time.Time, bool)

GetSettlementDateOk returns a tuple with the SettlementDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountUniversalActivity) GetSymbol added in v1.0.46 

func (o *AccountUniversalActivity) GetSymbol() SymbolNullable

GetSymbol returns the Symbol field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountUniversalActivity) GetSymbolOk added in v1.0.46 

func (o *AccountUniversalActivity) GetSymbolOk() (*SymbolNullable, bool)

GetSymbolOk returns a tuple with the Symbol field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountUniversalActivity) GetTradeDate added in v1.0.46 

func (o *AccountUniversalActivity) GetTradeDate() time.Time

GetTradeDate returns the TradeDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountUniversalActivity) GetTradeDateOk added in v1.0.46 

func (o *AccountUniversalActivity) GetTradeDateOk() (*time.Time, bool)

GetTradeDateOk returns a tuple with the TradeDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountUniversalActivity) GetType added in v1.0.46 

func (o *AccountUniversalActivity) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*AccountUniversalActivity) GetTypeOk added in v1.0.46 

func (o *AccountUniversalActivity) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountUniversalActivity) GetUnits added in v1.0.46 

func (o *AccountUniversalActivity) GetUnits() float32

GetUnits returns the Units field value if set, zero value otherwise.

func (*AccountUniversalActivity) GetUnitsOk added in v1.0.46 

func (o *AccountUniversalActivity) GetUnitsOk() (*float32, bool)

GetUnitsOk returns a tuple with the Units field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountUniversalActivity) HasAmount added in v1.0.46 

func (o *AccountUniversalActivity) HasAmount() bool

HasAmount returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasCurrency added in v1.0.46 

func (o *AccountUniversalActivity) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasCurrencyUniversalSymbol added in v1.0.177 

func (o *AccountUniversalActivity) HasCurrencyUniversalSymbol() bool

HasCurrencyUniversalSymbol returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasDescription added in v1.0.46 

func (o *AccountUniversalActivity) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasExternalReferenceId added in v1.0.46 

func (o *AccountUniversalActivity) HasExternalReferenceId() bool

HasExternalReferenceId returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasFee added in v1.0.46 

func (o *AccountUniversalActivity) HasFee() bool

HasFee returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasFxRate added in v1.0.46 

func (o *AccountUniversalActivity) HasFxRate() bool

HasFxRate returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasId added in v1.0.46 

func (o *AccountUniversalActivity) HasId() bool

HasId returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasInstitution added in v1.0.46 

func (o *AccountUniversalActivity) HasInstitution() bool

HasInstitution returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasOptionSymbol added in v1.0.46 

func (o *AccountUniversalActivity) HasOptionSymbol() bool

HasOptionSymbol returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasOptionType added in v1.0.46 

func (o *AccountUniversalActivity) HasOptionType() bool

HasOptionType returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasPrice added in v1.0.46 

func (o *AccountUniversalActivity) HasPrice() bool

HasPrice returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasSettlementDate added in v1.0.46 

func (o *AccountUniversalActivity) HasSettlementDate() bool

HasSettlementDate returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasSymbol added in v1.0.46 

func (o *AccountUniversalActivity) HasSymbol() bool

HasSymbol returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasTradeDate added in v1.0.46 

func (o *AccountUniversalActivity) HasTradeDate() bool

HasTradeDate returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasType added in v1.0.46 

func (o *AccountUniversalActivity) HasType() bool

HasType returns a boolean if a field has been set.

func (*AccountUniversalActivity) HasUnits added in v1.0.46 

func (o *AccountUniversalActivity) HasUnits() bool

HasUnits returns a boolean if a field has been set.

func (AccountUniversalActivity) MarshalJSON added in v1.0.46 

func (o AccountUniversalActivity) MarshalJSON() ([]byte, error)

func (*AccountUniversalActivity) SetAmount added in v1.0.46 

func (o *AccountUniversalActivity) SetAmount(v float32)

SetAmount gets a reference to the given NullableFloat32 and assigns it to the Amount field.

func (*AccountUniversalActivity) SetAmountNil added in v1.0.46 

func (o *AccountUniversalActivity) SetAmountNil()

SetAmountNil sets the value for Amount to be an explicit nil

func (*AccountUniversalActivity) SetCurrency added in v1.0.46 

func (o *AccountUniversalActivity) SetCurrency(v CurrencyNullable)

SetCurrency gets a reference to the given NullableCurrencyNullable and assigns it to the Currency field.

func (*AccountUniversalActivity) SetCurrencyNil added in v1.0.177 

func (o *AccountUniversalActivity) SetCurrencyNil()

SetCurrencyNil sets the value for Currency to be an explicit nil

func (*AccountUniversalActivity) SetCurrencyUniversalSymbol added in v1.0.177 

func (o *AccountUniversalActivity) SetCurrencyUniversalSymbol(v SymbolNullable)

SetCurrencyUniversalSymbol gets a reference to the given NullableSymbolNullable and assigns it to the CurrencyUniversalSymbol field.

func (*AccountUniversalActivity) SetCurrencyUniversalSymbolNil added in v1.0.177 

func (o *AccountUniversalActivity) SetCurrencyUniversalSymbolNil()

SetCurrencyUniversalSymbolNil sets the value for CurrencyUniversalSymbol to be an explicit nil

func (*AccountUniversalActivity) SetDescription added in v1.0.46 

func (o *AccountUniversalActivity) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*AccountUniversalActivity) SetExternalReferenceId added in v1.0.46 

func (o *AccountUniversalActivity) SetExternalReferenceId(v string)

SetExternalReferenceId gets a reference to the given NullableString and assigns it to the ExternalReferenceId field.

func (*AccountUniversalActivity) SetExternalReferenceIdNil added in v1.0.46 

func (o *AccountUniversalActivity) SetExternalReferenceIdNil()

SetExternalReferenceIdNil sets the value for ExternalReferenceId to be an explicit nil

func (*AccountUniversalActivity) SetFee added in v1.0.46 

func (o *AccountUniversalActivity) SetFee(v float32)

SetFee gets a reference to the given float32 and assigns it to the Fee field.

func (*AccountUniversalActivity) SetFxRate added in v1.0.46 

func (o *AccountUniversalActivity) SetFxRate(v float32)

SetFxRate gets a reference to the given NullableFloat32 and assigns it to the FxRate field.

func (*AccountUniversalActivity) SetFxRateNil added in v1.0.46 

func (o *AccountUniversalActivity) SetFxRateNil()

SetFxRateNil sets the value for FxRate to be an explicit nil

func (*AccountUniversalActivity) SetId added in v1.0.46 

func (o *AccountUniversalActivity) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*AccountUniversalActivity) SetInstitution added in v1.0.46 

func (o *AccountUniversalActivity) SetInstitution(v string)

SetInstitution gets a reference to the given string and assigns it to the Institution field.

func (*AccountUniversalActivity) SetOptionSymbol added in v1.0.46 

func (o *AccountUniversalActivity) SetOptionSymbol(v OptionsSymbolNullable)

SetOptionSymbol gets a reference to the given NullableOptionsSymbolNullable and assigns it to the OptionSymbol field.

func (*AccountUniversalActivity) SetOptionSymbolNil added in v1.0.46 

func (o *AccountUniversalActivity) SetOptionSymbolNil()

SetOptionSymbolNil sets the value for OptionSymbol to be an explicit nil

func (*AccountUniversalActivity) SetOptionType added in v1.0.46 

func (o *AccountUniversalActivity) SetOptionType(v string)

SetOptionType gets a reference to the given string and assigns it to the OptionType field.

func (*AccountUniversalActivity) SetPrice added in v1.0.46 

func (o *AccountUniversalActivity) SetPrice(v float32)

SetPrice gets a reference to the given float32 and assigns it to the Price field.

func (*AccountUniversalActivity) SetSettlementDate added in v1.0.46 

func (o *AccountUniversalActivity) SetSettlementDate(v time.Time)

SetSettlementDate gets a reference to the given time.Time and assigns it to the SettlementDate field.

func (*AccountUniversalActivity) SetSymbol added in v1.0.46 

func (o *AccountUniversalActivity) SetSymbol(v SymbolNullable)

SetSymbol gets a reference to the given NullableSymbolNullable and assigns it to the Symbol field.

func (*AccountUniversalActivity) SetSymbolNil added in v1.0.46 

func (o *AccountUniversalActivity) SetSymbolNil()

SetSymbolNil sets the value for Symbol to be an explicit nil

func (*AccountUniversalActivity) SetTradeDate added in v1.0.46 

func (o *AccountUniversalActivity) SetTradeDate(v time.Time)

SetTradeDate gets a reference to the given NullableTime and assigns it to the TradeDate field.

func (*AccountUniversalActivity) SetTradeDateNil added in v1.0.46 

func (o *AccountUniversalActivity) SetTradeDateNil()

SetTradeDateNil sets the value for TradeDate to be an explicit nil

func (*AccountUniversalActivity) SetType added in v1.0.46 

func (o *AccountUniversalActivity) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (*AccountUniversalActivity) SetUnits added in v1.0.46 

func (o *AccountUniversalActivity) SetUnits(v float32)

SetUnits gets a reference to the given float32 and assigns it to the Units field.

func (*AccountUniversalActivity) UnmarshalJSON added in v1.0.46 

func (o *AccountUniversalActivity) UnmarshalJSON(bytes []byte) (err error)

func (*AccountUniversalActivity) UnsetAmount added in v1.0.46 

func (o *AccountUniversalActivity) UnsetAmount()

UnsetAmount ensures that no value is present for Amount, not even an explicit nil

func (*AccountUniversalActivity) UnsetCurrency added in v1.0.177 

func (o *AccountUniversalActivity) UnsetCurrency()

UnsetCurrency ensures that no value is present for Currency, not even an explicit nil

func (*AccountUniversalActivity) UnsetCurrencyUniversalSymbol added in v1.0.177 

func (o *AccountUniversalActivity) UnsetCurrencyUniversalSymbol()

UnsetCurrencyUniversalSymbol ensures that no value is present for CurrencyUniversalSymbol, not even an explicit nil

func (*AccountUniversalActivity) UnsetExternalReferenceId added in v1.0.46 

func (o *AccountUniversalActivity) UnsetExternalReferenceId()

UnsetExternalReferenceId ensures that no value is present for ExternalReferenceId, not even an explicit nil

func (*AccountUniversalActivity) UnsetFxRate added in v1.0.46 

func (o *AccountUniversalActivity) UnsetFxRate()

UnsetFxRate ensures that no value is present for FxRate, not even an explicit nil

func (*AccountUniversalActivity) UnsetOptionSymbol added in v1.0.46 

func (o *AccountUniversalActivity) UnsetOptionSymbol()

UnsetOptionSymbol ensures that no value is present for OptionSymbol, not even an explicit nil

func (*AccountUniversalActivity) UnsetSymbol added in v1.0.46 

func (o *AccountUniversalActivity) UnsetSymbol()

UnsetSymbol ensures that no value is present for Symbol, not even an explicit nil

func (*AccountUniversalActivity) UnsetTradeDate added in v1.0.46 

func (o *AccountUniversalActivity) UnsetTradeDate()

UnsetTradeDate ensures that no value is present for TradeDate, not even an explicit nil

type AccountValueHistoryItem added in v1.0.139 

type AccountValueHistoryItem struct {
	// The date of the estimated account value
	Date *string `json:"date,omitempty"`
	// Estimate of the total market value of this account (includes cash, equity, fixed income, etc) at the given date.
	TotalValue           *string `json:"total_value,omitempty"`
	AdditionalProperties map[string]interface{}
}

AccountValueHistoryItem The estimated account value at a specific point in time.

func NewAccountValueHistoryItem added in v1.0.139 

func NewAccountValueHistoryItem() *AccountValueHistoryItem

NewAccountValueHistoryItem instantiates a new AccountValueHistoryItem 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

func NewAccountValueHistoryItemWithDefaults added in v1.0.139 

func NewAccountValueHistoryItemWithDefaults() *AccountValueHistoryItem

NewAccountValueHistoryItemWithDefaults instantiates a new AccountValueHistoryItem 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

func (*AccountValueHistoryItem) GetDate added in v1.0.139 

func (o *AccountValueHistoryItem) GetDate() string

GetDate returns the Date field value if set, zero value otherwise.

func (*AccountValueHistoryItem) GetDateOk added in v1.0.139 

func (o *AccountValueHistoryItem) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountValueHistoryItem) GetTotalValue added in v1.0.139 

func (o *AccountValueHistoryItem) GetTotalValue() string

GetTotalValue returns the TotalValue field value if set, zero value otherwise.

func (*AccountValueHistoryItem) GetTotalValueOk added in v1.0.139 

func (o *AccountValueHistoryItem) GetTotalValueOk() (*string, bool)

GetTotalValueOk returns a tuple with the TotalValue field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountValueHistoryItem) HasDate added in v1.0.139 

func (o *AccountValueHistoryItem) HasDate() bool

HasDate returns a boolean if a field has been set.

func (*AccountValueHistoryItem) HasTotalValue added in v1.0.139 

func (o *AccountValueHistoryItem) HasTotalValue() bool

HasTotalValue returns a boolean if a field has been set.

func (AccountValueHistoryItem) MarshalJSON added in v1.0.139 

func (o AccountValueHistoryItem) MarshalJSON() ([]byte, error)

func (*AccountValueHistoryItem) SetDate added in v1.0.139 

func (o *AccountValueHistoryItem) SetDate(v string)

SetDate gets a reference to the given string and assigns it to the Date field.

func (*AccountValueHistoryItem) SetTotalValue added in v1.0.139 

func (o *AccountValueHistoryItem) SetTotalValue(v string)

SetTotalValue gets a reference to the given string and assigns it to the TotalValue field.

func (*AccountValueHistoryItem) UnmarshalJSON added in v1.0.139 

func (o *AccountValueHistoryItem) UnmarshalJSON(bytes []byte) (err error)

type AccountValueHistoryResponse added in v1.0.139 

type AccountValueHistoryResponse struct {
	// List of estimated account values over time returned by the endpoint.
	History []AccountValueHistoryItem `json:"history,omitempty"`
	// The ISO-4217 currency code for the account values.
	Currency             *string `json:"currency,omitempty"`
	AdditionalProperties map[string]interface{}
}

AccountValueHistoryResponse The response to the account value history endpoint, containing a list of estimated account values at different points in time.

func NewAccountValueHistoryResponse added in v1.0.139 

func NewAccountValueHistoryResponse() *AccountValueHistoryResponse

NewAccountValueHistoryResponse instantiates a new AccountValueHistoryResponse 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

func NewAccountValueHistoryResponseWithDefaults added in v1.0.139 

func NewAccountValueHistoryResponseWithDefaults() *AccountValueHistoryResponse

NewAccountValueHistoryResponseWithDefaults instantiates a new AccountValueHistoryResponse 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

func (*AccountValueHistoryResponse) GetCurrency added in v1.0.139 

func (o *AccountValueHistoryResponse) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise.

func (*AccountValueHistoryResponse) GetCurrencyOk added in v1.0.139 

func (o *AccountValueHistoryResponse) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountValueHistoryResponse) GetHistory added in v1.0.139 

func (o *AccountValueHistoryResponse) GetHistory() []AccountValueHistoryItem

GetHistory returns the History field value if set, zero value otherwise.

func (*AccountValueHistoryResponse) GetHistoryOk added in v1.0.139 

func (o *AccountValueHistoryResponse) GetHistoryOk() ([]AccountValueHistoryItem, bool)

GetHistoryOk returns a tuple with the History field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AccountValueHistoryResponse) HasCurrency added in v1.0.139 

func (o *AccountValueHistoryResponse) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*AccountValueHistoryResponse) HasHistory added in v1.0.139 

func (o *AccountValueHistoryResponse) HasHistory() bool

HasHistory returns a boolean if a field has been set.

func (AccountValueHistoryResponse) MarshalJSON added in v1.0.139 

func (o AccountValueHistoryResponse) MarshalJSON() ([]byte, error)

func (*AccountValueHistoryResponse) SetCurrency added in v1.0.139 

func (o *AccountValueHistoryResponse) SetCurrency(v string)

SetCurrency gets a reference to the given string and assigns it to the Currency field.

func (*AccountValueHistoryResponse) SetHistory added in v1.0.139 

func (o *AccountValueHistoryResponse) SetHistory(v []AccountValueHistoryItem)

SetHistory gets a reference to the given []AccountValueHistoryItem and assigns it to the History field.

func (*AccountValueHistoryResponse) UnmarshalJSON added in v1.0.139 

func (o *AccountValueHistoryResponse) UnmarshalJSON(bytes []byte) (err error)

type ActionStrict 

type ActionStrict string

ActionStrict The action describes the intent or side of a trade. This is either `BUY` or `SELL`. 

const (
	ACTIONSTRICT_BUY  ActionStrict = "BUY"
	ACTIONSTRICT_SELL ActionStrict = "SELL"
)

List of ActionStrict

func NewActionStrictFromValue 

func NewActionStrictFromValue(v string) (*ActionStrict, error)

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

func (ActionStrict) IsValid 

func (v ActionStrict) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (ActionStrict) Ptr 

func (v ActionStrict) Ptr() *ActionStrict

Ptr returns reference to ActionStrict value

func (*ActionStrict) UnmarshalJSON 

func (v *ActionStrict) UnmarshalJSON(src []byte) error

type ActionStrictWithOptions added in v1.0.18 

type ActionStrictWithOptions string

ActionStrictWithOptions The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options. 

const (
	ACTIONSTRICTWITHOPTIONS_BUY           ActionStrictWithOptions = "BUY"
	ACTIONSTRICTWITHOPTIONS_SELL          ActionStrictWithOptions = "SELL"
	ACTIONSTRICTWITHOPTIONS_BUY_TO_OPEN   ActionStrictWithOptions = "BUY_TO_OPEN"
	ACTIONSTRICTWITHOPTIONS_BUY_TO_CLOSE  ActionStrictWithOptions = "BUY_TO_CLOSE"
	ACTIONSTRICTWITHOPTIONS_SELL_TO_OPEN  ActionStrictWithOptions = "SELL_TO_OPEN"
	ACTIONSTRICTWITHOPTIONS_SELL_TO_CLOSE ActionStrictWithOptions = "SELL_TO_CLOSE"
)

List of ActionStrictWithOptions

func NewActionStrictWithOptionsFromValue added in v1.0.18 

func NewActionStrictWithOptionsFromValue(v string) (*ActionStrictWithOptions, error)

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

func (ActionStrictWithOptions) IsValid added in v1.0.18 

func (v ActionStrictWithOptions) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (ActionStrictWithOptions) Ptr added in v1.0.18 

func (v ActionStrictWithOptions) Ptr() *ActionStrictWithOptions

Ptr returns reference to ActionStrictWithOptions value

func (*ActionStrictWithOptions) UnmarshalJSON added in v1.0.18 

func (v *ActionStrictWithOptions) UnmarshalJSON(src []byte) error

type AdrInstrument added in v1.0.160 

type AdrInstrument struct {
	// Type of security instrument.
	Kind string `json:"kind"`
	// Unique identifier for the instrument.
	Id string `json:"id"`
	// The formatted trading symbol for the security.
	Symbol string `json:"symbol"`
	// The raw symbol without any exchange suffix.
	RawSymbol string `json:"raw_symbol"`
	// Human-readable description of the security.
	Description NullableString `json:"description,omitempty"`
	// ISO-4217 currency code for the security listing.
	Currency NullableString `json:"currency,omitempty"`
	// Exchange MIC code or exchange code for the security.
	Exchange             NullableString                 `json:"exchange,omitempty"`
	FigiInstrument       NullableFigiInstrumentNullable `json:"figi_instrument,omitempty"`
	AdditionalProperties map[string]interface{}
}

AdrInstrument Security instrument metadata for ADR positions.

func NewAdrInstrument added in v1.0.160 

func NewAdrInstrument(kind string, id string, symbol string, rawSymbol string) *AdrInstrument

NewAdrInstrument instantiates a new AdrInstrument 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

func NewAdrInstrumentWithDefaults added in v1.0.160 

func NewAdrInstrumentWithDefaults() *AdrInstrument

NewAdrInstrumentWithDefaults instantiates a new AdrInstrument 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

func (*AdrInstrument) GetCurrency added in v1.0.160 

func (o *AdrInstrument) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AdrInstrument) GetCurrencyOk added in v1.0.160 

func (o *AdrInstrument) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AdrInstrument) GetDescription added in v1.0.160 

func (o *AdrInstrument) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AdrInstrument) GetDescriptionOk added in v1.0.160 

func (o *AdrInstrument) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AdrInstrument) GetExchange added in v1.0.160 

func (o *AdrInstrument) GetExchange() string

GetExchange returns the Exchange field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AdrInstrument) GetExchangeOk added in v1.0.160 

func (o *AdrInstrument) GetExchangeOk() (*string, bool)

GetExchangeOk returns a tuple with the Exchange field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AdrInstrument) GetFigiInstrument added in v1.0.160 

func (o *AdrInstrument) GetFigiInstrument() FigiInstrumentNullable

GetFigiInstrument returns the FigiInstrument field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AdrInstrument) GetFigiInstrumentOk added in v1.0.160 

func (o *AdrInstrument) GetFigiInstrumentOk() (*FigiInstrumentNullable, bool)

GetFigiInstrumentOk returns a tuple with the FigiInstrument field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AdrInstrument) GetId added in v1.0.160 

func (o *AdrInstrument) GetId() string

GetId returns the Id field value

func (*AdrInstrument) GetIdOk added in v1.0.160 

func (o *AdrInstrument) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*AdrInstrument) GetKind added in v1.0.160 

func (o *AdrInstrument) GetKind() string

GetKind returns the Kind field value

func (*AdrInstrument) GetKindOk added in v1.0.160 

func (o *AdrInstrument) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value and a boolean to check if the value has been set.

func (*AdrInstrument) GetRawSymbol added in v1.0.160 

func (o *AdrInstrument) GetRawSymbol() string

GetRawSymbol returns the RawSymbol field value

func (*AdrInstrument) GetRawSymbolOk added in v1.0.160 

func (o *AdrInstrument) GetRawSymbolOk() (*string, bool)

GetRawSymbolOk returns a tuple with the RawSymbol field value and a boolean to check if the value has been set.

func (*AdrInstrument) GetSymbol added in v1.0.160 

func (o *AdrInstrument) GetSymbol() string

GetSymbol returns the Symbol field value

func (*AdrInstrument) GetSymbolOk added in v1.0.160 

func (o *AdrInstrument) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value and a boolean to check if the value has been set.

func (*AdrInstrument) HasCurrency added in v1.0.160 

func (o *AdrInstrument) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*AdrInstrument) HasDescription added in v1.0.160 

func (o *AdrInstrument) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*AdrInstrument) HasExchange added in v1.0.160 

func (o *AdrInstrument) HasExchange() bool

HasExchange returns a boolean if a field has been set.

func (*AdrInstrument) HasFigiInstrument added in v1.0.160 

func (o *AdrInstrument) HasFigiInstrument() bool

HasFigiInstrument returns a boolean if a field has been set.

func (AdrInstrument) MarshalJSON added in v1.0.160 

func (o AdrInstrument) MarshalJSON() ([]byte, error)

func (*AdrInstrument) SetCurrency added in v1.0.160 

func (o *AdrInstrument) SetCurrency(v string)

SetCurrency gets a reference to the given NullableString and assigns it to the Currency field.

func (*AdrInstrument) SetCurrencyNil added in v1.0.160 

func (o *AdrInstrument) SetCurrencyNil()

SetCurrencyNil sets the value for Currency to be an explicit nil

func (*AdrInstrument) SetDescription added in v1.0.160 

func (o *AdrInstrument) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*AdrInstrument) SetDescriptionNil added in v1.0.160 

func (o *AdrInstrument) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*AdrInstrument) SetExchange added in v1.0.160 

func (o *AdrInstrument) SetExchange(v string)

SetExchange gets a reference to the given NullableString and assigns it to the Exchange field.

func (*AdrInstrument) SetExchangeNil added in v1.0.160 

func (o *AdrInstrument) SetExchangeNil()

SetExchangeNil sets the value for Exchange to be an explicit nil

func (*AdrInstrument) SetFigiInstrument added in v1.0.160 

func (o *AdrInstrument) SetFigiInstrument(v FigiInstrumentNullable)

SetFigiInstrument gets a reference to the given NullableFigiInstrumentNullable and assigns it to the FigiInstrument field.

func (*AdrInstrument) SetFigiInstrumentNil added in v1.0.160 

func (o *AdrInstrument) SetFigiInstrumentNil()

SetFigiInstrumentNil sets the value for FigiInstrument to be an explicit nil

func (*AdrInstrument) SetId added in v1.0.160 

func (o *AdrInstrument) SetId(v string)

SetId sets field value

func (*AdrInstrument) SetKind added in v1.0.160 

func (o *AdrInstrument) SetKind(v string)

SetKind sets field value

func (*AdrInstrument) SetRawSymbol added in v1.0.160 

func (o *AdrInstrument) SetRawSymbol(v string)

SetRawSymbol sets field value

func (*AdrInstrument) SetSymbol added in v1.0.160 

func (o *AdrInstrument) SetSymbol(v string)

SetSymbol sets field value

func (*AdrInstrument) UnmarshalJSON added in v1.0.160 

func (o *AdrInstrument) UnmarshalJSON(bytes []byte) (err error)

func (*AdrInstrument) UnsetCurrency added in v1.0.160 

func (o *AdrInstrument) UnsetCurrency()

UnsetCurrency ensures that no value is present for Currency, not even an explicit nil

func (*AdrInstrument) UnsetDescription added in v1.0.160 

func (o *AdrInstrument) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*AdrInstrument) UnsetExchange added in v1.0.160 

func (o *AdrInstrument) UnsetExchange()

UnsetExchange ensures that no value is present for Exchange, not even an explicit nil

func (*AdrInstrument) UnsetFigiInstrument added in v1.0.160 

func (o *AdrInstrument) UnsetFigiInstrument()

UnsetFigiInstrument ensures that no value is present for FigiInstrument, not even an explicit nil

type AllAccountPositionsResponse added in v1.0.158 

type AllAccountPositionsResponse struct {
	// Positions returned for the request.
	Results              []AccountPosition                        `json:"results"`
	DataFreshness        AllAccountPositionsResponseDataFreshness `json:"data_freshness"`
	AdditionalProperties map[string]interface{}
}

AllAccountPositionsResponse Information about all account positions.

func NewAllAccountPositionsResponse added in v1.0.158 

func NewAllAccountPositionsResponse(results []AccountPosition, dataFreshness AllAccountPositionsResponseDataFreshness) *AllAccountPositionsResponse

NewAllAccountPositionsResponse instantiates a new AllAccountPositionsResponse 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

func NewAllAccountPositionsResponseWithDefaults added in v1.0.158 

func NewAllAccountPositionsResponseWithDefaults() *AllAccountPositionsResponse

NewAllAccountPositionsResponseWithDefaults instantiates a new AllAccountPositionsResponse 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

func (*AllAccountPositionsResponse) GetDataFreshness added in v1.0.175 

func (o *AllAccountPositionsResponse) GetDataFreshness() AllAccountPositionsResponseDataFreshness

GetDataFreshness returns the DataFreshness field value

func (*AllAccountPositionsResponse) GetDataFreshnessOk added in v1.0.175 

func (o *AllAccountPositionsResponse) GetDataFreshnessOk() (*AllAccountPositionsResponseDataFreshness, bool)

GetDataFreshnessOk returns a tuple with the DataFreshness field value and a boolean to check if the value has been set.

func (*AllAccountPositionsResponse) GetResults added in v1.0.158 

func (o *AllAccountPositionsResponse) GetResults() []AccountPosition

GetResults returns the Results field value

func (*AllAccountPositionsResponse) GetResultsOk added in v1.0.158 

func (o *AllAccountPositionsResponse) GetResultsOk() ([]AccountPosition, bool)

GetResultsOk returns a tuple with the Results field value and a boolean to check if the value has been set.

func (AllAccountPositionsResponse) MarshalJSON added in v1.0.158 

func (o AllAccountPositionsResponse) MarshalJSON() ([]byte, error)

func (*AllAccountPositionsResponse) SetDataFreshness added in v1.0.175 

func (o *AllAccountPositionsResponse) SetDataFreshness(v AllAccountPositionsResponseDataFreshness)

SetDataFreshness sets field value

func (*AllAccountPositionsResponse) SetResults added in v1.0.158 

func (o *AllAccountPositionsResponse) SetResults(v []AccountPosition)

SetResults sets field value

func (*AllAccountPositionsResponse) UnmarshalJSON added in v1.0.158 

func (o *AllAccountPositionsResponse) UnmarshalJSON(bytes []byte) (err error)

type AllAccountPositionsResponseDataFreshness added in v1.0.175 

type AllAccountPositionsResponseDataFreshness struct {
	// The time the returned positions data was fetched from the brokerage.
	AsOf                 time.Time `json:"as_of"`
	AdditionalProperties map[string]interface{}
}

AllAccountPositionsResponseDataFreshness Metadata describing freshness of the returned positions data.

func NewAllAccountPositionsResponseDataFreshness added in v1.0.175 

func NewAllAccountPositionsResponseDataFreshness(asOf time.Time) *AllAccountPositionsResponseDataFreshness

NewAllAccountPositionsResponseDataFreshness instantiates a new AllAccountPositionsResponseDataFreshness 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

func NewAllAccountPositionsResponseDataFreshnessWithDefaults added in v1.0.175 

func NewAllAccountPositionsResponseDataFreshnessWithDefaults() *AllAccountPositionsResponseDataFreshness

NewAllAccountPositionsResponseDataFreshnessWithDefaults instantiates a new AllAccountPositionsResponseDataFreshness 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

func (*AllAccountPositionsResponseDataFreshness) GetAsOf added in v1.0.175 

func (o *AllAccountPositionsResponseDataFreshness) GetAsOf() time.Time

GetAsOf returns the AsOf field value

func (*AllAccountPositionsResponseDataFreshness) GetAsOfOk added in v1.0.175 

func (o *AllAccountPositionsResponseDataFreshness) GetAsOfOk() (*time.Time, bool)

GetAsOfOk returns a tuple with the AsOf field value and a boolean to check if the value has been set.

func (AllAccountPositionsResponseDataFreshness) MarshalJSON added in v1.0.175 

func (o AllAccountPositionsResponseDataFreshness) MarshalJSON() ([]byte, error)

func (*AllAccountPositionsResponseDataFreshness) SetAsOf added in v1.0.175 

func (o *AllAccountPositionsResponseDataFreshness) SetAsOf(v time.Time)

SetAsOf sets field value

func (*AllAccountPositionsResponseDataFreshness) UnmarshalJSON added in v1.0.175 

func (o *AllAccountPositionsResponseDataFreshness) UnmarshalJSON(bytes []byte) (err error)

type AuthenticationApiDeleteSnapTradeUserRequest 

type AuthenticationApiDeleteSnapTradeUserRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (AuthenticationApiDeleteSnapTradeUserRequest) Execute 

func (r AuthenticationApiDeleteSnapTradeUserRequest) Execute() (*DeleteUserResponse, *http.Response, error)

type AuthenticationApiListSnapTradeUsersRequest 

type AuthenticationApiListSnapTradeUsersRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (AuthenticationApiListSnapTradeUsersRequest) Execute 

func (r AuthenticationApiListSnapTradeUsersRequest) Execute() ([]string, *http.Response, error)

type AuthenticationApiLoginSnapTradeUserRequest 

type AuthenticationApiLoginSnapTradeUserRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (AuthenticationApiLoginSnapTradeUserRequest) Execute 

func (r AuthenticationApiLoginSnapTradeUserRequest) Execute() (*AuthenticationLoginSnapTradeUser200Response, *http.Response, error)

func (*AuthenticationApiLoginSnapTradeUserRequest) SnapTradeLoginUserRequestBody 

func (r *AuthenticationApiLoginSnapTradeUserRequest) SnapTradeLoginUserRequestBody(snapTradeLoginUserRequestBody SnapTradeLoginUserRequestBody) *AuthenticationApiLoginSnapTradeUserRequest

type AuthenticationApiRegisterSnapTradeUserRequest 

type AuthenticationApiRegisterSnapTradeUserRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (AuthenticationApiRegisterSnapTradeUserRequest) Execute 

func (r AuthenticationApiRegisterSnapTradeUserRequest) Execute() (*UserIDandSecret, *http.Response, error)

type AuthenticationApiResetSnapTradeUserSecretRequest 

type AuthenticationApiResetSnapTradeUserSecretRequest struct {
	ApiService *AuthenticationApiService
	// contains filtered or unexported fields
}

func (AuthenticationApiResetSnapTradeUserSecretRequest) Execute 

func (r AuthenticationApiResetSnapTradeUserSecretRequest) Execute() (*UserIDandSecret, *http.Response, error)

type AuthenticationApiService 

type AuthenticationApiService service

AuthenticationApiService AuthenticationApi service

func (*AuthenticationApiService) DeleteSnapTradeUser 

func (a *AuthenticationApiService) DeleteSnapTradeUser(userId string) AuthenticationApiDeleteSnapTradeUserRequest

DeleteSnapTradeUser Delete user

Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@return AuthenticationApiDeleteSnapTradeUserRequest

func (*AuthenticationApiService) DeleteSnapTradeUserExecute 

func (a *AuthenticationApiService) DeleteSnapTradeUserExecute(r AuthenticationApiDeleteSnapTradeUserRequest) (*DeleteUserResponse, *http.Response, error)

Execute executes the request 

@return DeleteUserResponse

func (*AuthenticationApiService) ListSnapTradeUsers 

func (a *AuthenticationApiService) ListSnapTradeUsers() AuthenticationApiListSnapTradeUsersRequest

ListSnapTradeUsers List all users

Returns a list of all registered user IDs. Please note that the response is not currently paginated. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return AuthenticationApiListSnapTradeUsersRequest

func (*AuthenticationApiService) ListSnapTradeUsersExecute 

func (a *AuthenticationApiService) ListSnapTradeUsersExecute(r AuthenticationApiListSnapTradeUsersRequest) ([]string, *http.Response, error)

Execute executes the request 

@return []string

func (*AuthenticationApiService) LoginSnapTradeUser 

func (a *AuthenticationApiService) LoginSnapTradeUser(userId string, userSecret string) AuthenticationApiLoginSnapTradeUserRequest

LoginSnapTradeUser Generate Connection Portal URL

Authenticates a SnapTrade user and returns the Connection Portal URL used for connecting brokerage accounts. Please check [this guide](/docs/implement-connection-portal) for how to integrate the Connection Portal into your app.

Please note that the returned URL expires in 5 minutes. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@return AuthenticationApiLoginSnapTradeUserRequest

func (*AuthenticationApiService) LoginSnapTradeUserExecute 

func (a *AuthenticationApiService) LoginSnapTradeUserExecute(r AuthenticationApiLoginSnapTradeUserRequest) (*AuthenticationLoginSnapTradeUser200Response, *http.Response, error)

Execute executes the request 

@return AuthenticationLoginSnapTradeUser200Response

func (*AuthenticationApiService) RegisterSnapTradeUser 

func (a *AuthenticationApiService) RegisterSnapTradeUser(snapTradeRegisterUserRequestBody SnapTradeRegisterUserRequestBody) AuthenticationApiRegisterSnapTradeUserRequest

RegisterSnapTradeUser Register user

Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param snapTradeRegisterUserRequestBody
@return AuthenticationApiRegisterSnapTradeUserRequest

func (*AuthenticationApiService) RegisterSnapTradeUserExecute 

func (a *AuthenticationApiService) RegisterSnapTradeUserExecute(r AuthenticationApiRegisterSnapTradeUserRequest) (*UserIDandSecret, *http.Response, error)

Execute executes the request 

@return UserIDandSecret

func (*AuthenticationApiService) ResetSnapTradeUserSecret 

func (a *AuthenticationApiService) ResetSnapTradeUserSecret(userIDandSecret UserIDandSecret) AuthenticationApiResetSnapTradeUserSecretRequest

ResetSnapTradeUserSecret Rotate user secret

Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userIDandSecret
@return AuthenticationApiResetSnapTradeUserSecretRequest

func (*AuthenticationApiService) ResetSnapTradeUserSecretExecute 

func (a *AuthenticationApiService) ResetSnapTradeUserSecretExecute(r AuthenticationApiResetSnapTradeUserSecretRequest) (*UserIDandSecret, *http.Response, error)

Execute executes the request 

@return UserIDandSecret

type AuthenticationLoginSnapTradeUser200Response 

type AuthenticationLoginSnapTradeUser200Response struct {
	EncryptedResponse *EncryptedResponse
	LoginRedirectURI  *LoginRedirectURI
}

AuthenticationLoginSnapTradeUser200Response - struct for AuthenticationLoginSnapTradeUser200Response

func EncryptedResponseAsAuthenticationLoginSnapTradeUser200Response 

func EncryptedResponseAsAuthenticationLoginSnapTradeUser200Response(v *EncryptedResponse) AuthenticationLoginSnapTradeUser200Response

EncryptedResponseAsAuthenticationLoginSnapTradeUser200Response is a convenience function that returns EncryptedResponse wrapped in AuthenticationLoginSnapTradeUser200Response

func LoginRedirectURIAsAuthenticationLoginSnapTradeUser200Response 

func LoginRedirectURIAsAuthenticationLoginSnapTradeUser200Response(v *LoginRedirectURI) AuthenticationLoginSnapTradeUser200Response

LoginRedirectURIAsAuthenticationLoginSnapTradeUser200Response is a convenience function that returns LoginRedirectURI wrapped in AuthenticationLoginSnapTradeUser200Response

func (*AuthenticationLoginSnapTradeUser200Response) GetActualInstance 

func (obj *AuthenticationLoginSnapTradeUser200Response) GetActualInstance() interface{}

Get the actual instance

func (AuthenticationLoginSnapTradeUser200Response) MarshalJSON 

func (src AuthenticationLoginSnapTradeUser200Response) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*AuthenticationLoginSnapTradeUser200Response) UnmarshalJSON 

func (dst *AuthenticationLoginSnapTradeUser200Response) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

type Balance 

type Balance struct {
	Currency *BalanceCurrency `json:"currency,omitempty"`
	// The amount of available cash in the account denominated in the currency of the `currency` field. This value can be negative in a margin account with a margin balance. Money market funds will be included in this field, and also returned in positions endpoints with `cash_equivalent` = true
	Cash NullableFloat32 `json:"cash,omitempty"`
	// Buying power only applies to margin accounts. For non-margin accounts, buying power should be the same as cash. Please note that this field is not always available for all brokerages.
	BuyingPower          NullableFloat32 `json:"buying_power,omitempty"`
	AdditionalProperties map[string]interface{}
}

Balance Holds balance information for a single currency in an account.

func NewBalance 

func NewBalance() *Balance

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

func NewBalanceWithDefaults 

func NewBalanceWithDefaults() *Balance

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

func (*Balance) GetBuyingPower 

func (o *Balance) GetBuyingPower() float32

GetBuyingPower returns the BuyingPower field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Balance) GetBuyingPowerOk 

func (o *Balance) GetBuyingPowerOk() (*float32, bool)

GetBuyingPowerOk returns a tuple with the BuyingPower field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Balance) GetCash 

func (o *Balance) GetCash() float32

GetCash returns the Cash field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Balance) GetCashOk 

func (o *Balance) GetCashOk() (*float32, bool)

GetCashOk returns a tuple with the Cash field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Balance) GetCurrency 

func (o *Balance) GetCurrency() BalanceCurrency

GetCurrency returns the Currency field value if set, zero value otherwise.

func (*Balance) GetCurrencyOk 

func (o *Balance) GetCurrencyOk() (*BalanceCurrency, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Balance) HasBuyingPower 

func (o *Balance) HasBuyingPower() bool

HasBuyingPower returns a boolean if a field has been set.

func (*Balance) HasCash 

func (o *Balance) HasCash() bool

HasCash returns a boolean if a field has been set.

func (*Balance) HasCurrency 

func (o *Balance) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (Balance) MarshalJSON 

func (o Balance) MarshalJSON() ([]byte, error)

func (*Balance) SetBuyingPower 

func (o *Balance) SetBuyingPower(v float32)

SetBuyingPower gets a reference to the given NullableFloat32 and assigns it to the BuyingPower field.

func (*Balance) SetBuyingPowerNil 

func (o *Balance) SetBuyingPowerNil()

SetBuyingPowerNil sets the value for BuyingPower to be an explicit nil

func (*Balance) SetCash 

func (o *Balance) SetCash(v float32)

SetCash gets a reference to the given NullableFloat32 and assigns it to the Cash field.

func (*Balance) SetCashNil 

func (o *Balance) SetCashNil()

SetCashNil sets the value for Cash to be an explicit nil

func (*Balance) SetCurrency 

func (o *Balance) SetCurrency(v BalanceCurrency)

SetCurrency gets a reference to the given BalanceCurrency and assigns it to the Currency field.

func (*Balance) UnmarshalJSON 

func (o *Balance) UnmarshalJSON(bytes []byte) (err error)

func (*Balance) UnsetBuyingPower 

func (o *Balance) UnsetBuyingPower()

UnsetBuyingPower ensures that no value is present for BuyingPower, not even an explicit nil

func (*Balance) UnsetCash 

func (o *Balance) UnsetCash()

UnsetCash ensures that no value is present for Cash, not even an explicit nil

type BalanceCurrency added in v1.0.5 

type BalanceCurrency struct {
	// Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
	Id *string `json:"id,omitempty"`
	// The ISO-4217 currency code for the currency.
	Code *string `json:"code,omitempty"`
	// A human-friendly name of the currency.
	Name *string `json:"name,omitempty"`
}

BalanceCurrency The currency of the balance. This applies to both `cash` and `buying_power`.

func NewBalanceCurrency added in v1.0.5 

func NewBalanceCurrency() *BalanceCurrency

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

func NewBalanceCurrencyWithDefaults added in v1.0.5 

func NewBalanceCurrencyWithDefaults() *BalanceCurrency

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

func (*BalanceCurrency) GetCode added in v1.0.5 

func (o *BalanceCurrency) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*BalanceCurrency) GetCodeOk added in v1.0.5 

func (o *BalanceCurrency) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BalanceCurrency) GetId added in v1.0.5 

func (o *BalanceCurrency) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*BalanceCurrency) GetIdOk added in v1.0.5 

func (o *BalanceCurrency) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BalanceCurrency) GetName added in v1.0.5 

func (o *BalanceCurrency) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*BalanceCurrency) GetNameOk added in v1.0.5 

func (o *BalanceCurrency) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BalanceCurrency) HasCode added in v1.0.5 

func (o *BalanceCurrency) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*BalanceCurrency) HasId added in v1.0.5 

func (o *BalanceCurrency) HasId() bool

HasId returns a boolean if a field has been set.

func (*BalanceCurrency) HasName added in v1.0.5 

func (o *BalanceCurrency) HasName() bool

HasName returns a boolean if a field has been set.

func (BalanceCurrency) MarshalJSON added in v1.0.5 

func (o BalanceCurrency) MarshalJSON() ([]byte, error)

func (*BalanceCurrency) SetCode added in v1.0.5 

func (o *BalanceCurrency) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*BalanceCurrency) SetId added in v1.0.5 

func (o *BalanceCurrency) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*BalanceCurrency) SetName added in v1.0.5 

func (o *BalanceCurrency) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Brokerage 

type Brokerage struct {
	// Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.
	Id *string `json:"id,omitempty"`
	// A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
	Slug *string `json:"slug,omitempty"`
	// Full name of the brokerage.
	Name *string `json:"name,omitempty"`
	// A display-friendly name of the brokerage.
	DisplayName *string `json:"display_name,omitempty"`
	// A brief description of the brokerage.
	Description *string `json:"description,omitempty"`
	// URL to the brokerage's logo.
	AwsS3LogoUrl *string `json:"aws_s3_logo_url,omitempty"`
	// URL to the brokerage's logo in square format.
	AwsS3SquareLogoUrl NullableString `json:"aws_s3_square_logo_url,omitempty"`
	// URL to the brokerage's website. Returns null if the brokerage has no website on record.
	Url NullableString `json:"url,omitempty"`
	// Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections.
	Enabled *bool `json:"enabled,omitempty"`
	// Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections.
	MaintenanceMode *bool `json:"maintenance_mode,omitempty"`
	// Whether the brokerage is currently degraded. A degraded brokerage may have reduced functionality or be experiencing technical issues.
	IsDegraded *bool `json:"is_degraded,omitempty"`
	// Whether the brokerage allows trading through SnapTrade.
	AllowsTrading NullableBool `json:"allows_trading,omitempty"`
	// This field is deprecated. Please contact us if you have a valid use case for it.
	// Deprecated
	AllowsFractionalUnits NullableBool `json:"allows_fractional_units,omitempty"`
	// This field is deprecated. Please contact us if you have a valid use case for it.
	// Deprecated
	HasReporting NullableBool `json:"has_reporting,omitempty"`
	// This field is deprecated. Please contact us if you have a valid use case for it.
	// Deprecated
	IsRealTimeConnection *bool          `json:"is_real_time_connection,omitempty"`
	BrokerageType        *BrokerageType `json:"brokerage_type,omitempty"`
	// This field is deprecated. Please contact us if you have a valid use case for it.
	// Deprecated
	Exchanges []interface{} `json:"exchanges,omitempty"`
	// This field is deprecated.
	// Deprecated
	OpenUrl              NullableString `json:"open_url,omitempty"`
	AdditionalProperties map[string]interface{}
}

Brokerage Describes a brokerage that SnapTrade supports.

func NewBrokerage 

func NewBrokerage() *Brokerage

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

func NewBrokerageWithDefaults 

func NewBrokerageWithDefaults() *Brokerage

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

func (*Brokerage) GetAllowsFractionalUnits 

func (o *Brokerage) GetAllowsFractionalUnits() bool

GetAllowsFractionalUnits returns the AllowsFractionalUnits field value if set, zero value otherwise (both if not set or set to explicit null). Deprecated

func (*Brokerage) GetAllowsFractionalUnitsOk 

func (o *Brokerage) GetAllowsFractionalUnitsOk() (*bool, bool)

GetAllowsFractionalUnitsOk returns a tuple with the AllowsFractionalUnits field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned Deprecated

func (*Brokerage) GetAllowsTrading 

func (o *Brokerage) GetAllowsTrading() bool

GetAllowsTrading returns the AllowsTrading field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Brokerage) GetAllowsTradingOk 

func (o *Brokerage) GetAllowsTradingOk() (*bool, bool)

GetAllowsTradingOk returns a tuple with the AllowsTrading field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Brokerage) GetAwsS3LogoUrl 

func (o *Brokerage) GetAwsS3LogoUrl() string

GetAwsS3LogoUrl returns the AwsS3LogoUrl field value if set, zero value otherwise.

func (*Brokerage) GetAwsS3LogoUrlOk 

func (o *Brokerage) GetAwsS3LogoUrlOk() (*string, bool)

GetAwsS3LogoUrlOk returns a tuple with the AwsS3LogoUrl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Brokerage) GetAwsS3SquareLogoUrl 

func (o *Brokerage) GetAwsS3SquareLogoUrl() string

GetAwsS3SquareLogoUrl returns the AwsS3SquareLogoUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Brokerage) GetAwsS3SquareLogoUrlOk 

func (o *Brokerage) GetAwsS3SquareLogoUrlOk() (*string, bool)

GetAwsS3SquareLogoUrlOk returns a tuple with the AwsS3SquareLogoUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Brokerage) GetBrokerageType 

func (o *Brokerage) GetBrokerageType() BrokerageType

GetBrokerageType returns the BrokerageType field value if set, zero value otherwise.

func (*Brokerage) GetBrokerageTypeOk 

func (o *Brokerage) GetBrokerageTypeOk() (*BrokerageType, bool)

GetBrokerageTypeOk returns a tuple with the BrokerageType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Brokerage) GetDescription 

func (o *Brokerage) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*Brokerage) GetDescriptionOk 

func (o *Brokerage) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Brokerage) GetDisplayName 

func (o *Brokerage) GetDisplayName() string

GetDisplayName returns the DisplayName field value if set, zero value otherwise.

func (*Brokerage) GetDisplayNameOk 

func (o *Brokerage) GetDisplayNameOk() (*string, bool)

GetDisplayNameOk returns a tuple with the DisplayName field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Brokerage) GetEnabled 

func (o *Brokerage) GetEnabled() bool

GetEnabled returns the Enabled field value if set, zero value otherwise.

func (*Brokerage) GetEnabledOk 

func (o *Brokerage) GetEnabledOk() (*bool, bool)

GetEnabledOk returns a tuple with the Enabled field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Brokerage) GetExchanges 

func (o *Brokerage) GetExchanges() []interface{}

GetExchanges returns the Exchanges field value if set, zero value otherwise. Deprecated

func (*Brokerage) GetExchangesOk 

func (o *Brokerage) GetExchangesOk() ([]interface{}, bool)

GetExchangesOk returns a tuple with the Exchanges field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated

func (*Brokerage) GetHasReporting 

func (o *Brokerage) GetHasReporting() bool

GetHasReporting returns the HasReporting field value if set, zero value otherwise (both if not set or set to explicit null). Deprecated

func (*Brokerage) GetHasReportingOk 

func (o *Brokerage) GetHasReportingOk() (*bool, bool)

GetHasReportingOk returns a tuple with the HasReporting field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned Deprecated

func (*Brokerage) GetId 

func (o *Brokerage) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*Brokerage) GetIdOk 

func (o *Brokerage) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Brokerage) GetIsDegraded added in v1.0.139 

func (o *Brokerage) GetIsDegraded() bool

GetIsDegraded returns the IsDegraded field value if set, zero value otherwise.

func (*Brokerage) GetIsDegradedOk added in v1.0.139 

func (o *Brokerage) GetIsDegradedOk() (*bool, bool)

GetIsDegradedOk returns a tuple with the IsDegraded field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Brokerage) GetIsRealTimeConnection 

func (o *Brokerage) GetIsRealTimeConnection() bool

GetIsRealTimeConnection returns the IsRealTimeConnection field value if set, zero value otherwise. Deprecated

func (*Brokerage) GetIsRealTimeConnectionOk 

func (o *Brokerage) GetIsRealTimeConnectionOk() (*bool, bool)

GetIsRealTimeConnectionOk returns a tuple with the IsRealTimeConnection field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated

func (*Brokerage) GetMaintenanceMode 

func (o *Brokerage) GetMaintenanceMode() bool

GetMaintenanceMode returns the MaintenanceMode field value if set, zero value otherwise.

func (*Brokerage) GetMaintenanceModeOk 

func (o *Brokerage) GetMaintenanceModeOk() (*bool, bool)

GetMaintenanceModeOk returns a tuple with the MaintenanceMode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Brokerage) GetName 

func (o *Brokerage) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*Brokerage) GetNameOk 

func (o *Brokerage) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Brokerage) GetOpenUrl 

func (o *Brokerage) GetOpenUrl() string

GetOpenUrl returns the OpenUrl field value if set, zero value otherwise (both if not set or set to explicit null). Deprecated

func (*Brokerage) GetOpenUrlOk 

func (o *Brokerage) GetOpenUrlOk() (*string, bool)

GetOpenUrlOk returns a tuple with the OpenUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned Deprecated

func (*Brokerage) GetSlug 

func (o *Brokerage) GetSlug() string

GetSlug returns the Slug field value if set, zero value otherwise.

func (*Brokerage) GetSlugOk 

func (o *Brokerage) GetSlugOk() (*string, bool)

GetSlugOk returns a tuple with the Slug field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Brokerage) GetUrl 

func (o *Brokerage) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Brokerage) GetUrlOk 

func (o *Brokerage) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Brokerage) HasAllowsFractionalUnits 

func (o *Brokerage) HasAllowsFractionalUnits() bool

HasAllowsFractionalUnits returns a boolean if a field has been set.

func (*Brokerage) HasAllowsTrading 

func (o *Brokerage) HasAllowsTrading() bool

HasAllowsTrading returns a boolean if a field has been set.

func (*Brokerage) HasAwsS3LogoUrl 

func (o *Brokerage) HasAwsS3LogoUrl() bool

HasAwsS3LogoUrl returns a boolean if a field has been set.

func (*Brokerage) HasAwsS3SquareLogoUrl 

func (o *Brokerage) HasAwsS3SquareLogoUrl() bool

HasAwsS3SquareLogoUrl returns a boolean if a field has been set.

func (*Brokerage) HasBrokerageType 

func (o *Brokerage) HasBrokerageType() bool

HasBrokerageType returns a boolean if a field has been set.

func (*Brokerage) HasDescription 

func (o *Brokerage) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Brokerage) HasDisplayName 

func (o *Brokerage) HasDisplayName() bool

HasDisplayName returns a boolean if a field has been set.

func (*Brokerage) HasEnabled 

func (o *Brokerage) HasEnabled() bool

HasEnabled returns a boolean if a field has been set.

func (*Brokerage) HasExchanges 

func (o *Brokerage) HasExchanges() bool

HasExchanges returns a boolean if a field has been set.

func (*Brokerage) HasHasReporting 

func (o *Brokerage) HasHasReporting() bool

HasHasReporting returns a boolean if a field has been set.

func (*Brokerage) HasId 

func (o *Brokerage) HasId() bool

HasId returns a boolean if a field has been set.

func (*Brokerage) HasIsDegraded added in v1.0.139 

func (o *Brokerage) HasIsDegraded() bool

HasIsDegraded returns a boolean if a field has been set.

func (*Brokerage) HasIsRealTimeConnection 

func (o *Brokerage) HasIsRealTimeConnection() bool

HasIsRealTimeConnection returns a boolean if a field has been set.

func (*Brokerage) HasMaintenanceMode 

func (o *Brokerage) HasMaintenanceMode() bool

HasMaintenanceMode returns a boolean if a field has been set.

func (*Brokerage) HasName 

func (o *Brokerage) HasName() bool

HasName returns a boolean if a field has been set.

func (*Brokerage) HasOpenUrl 

func (o *Brokerage) HasOpenUrl() bool

HasOpenUrl returns a boolean if a field has been set.

func (*Brokerage) HasSlug 

func (o *Brokerage) HasSlug() bool

HasSlug returns a boolean if a field has been set.

func (*Brokerage) HasUrl 

func (o *Brokerage) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (Brokerage) MarshalJSON 

func (o Brokerage) MarshalJSON() ([]byte, error)

func (*Brokerage) SetAllowsFractionalUnits 

func (o *Brokerage) SetAllowsFractionalUnits(v bool)

SetAllowsFractionalUnits gets a reference to the given NullableBool and assigns it to the AllowsFractionalUnits field. Deprecated

func (*Brokerage) SetAllowsFractionalUnitsNil 

func (o *Brokerage) SetAllowsFractionalUnitsNil()

SetAllowsFractionalUnitsNil sets the value for AllowsFractionalUnits to be an explicit nil

func (*Brokerage) SetAllowsTrading 

func (o *Brokerage) SetAllowsTrading(v bool)

SetAllowsTrading gets a reference to the given NullableBool and assigns it to the AllowsTrading field.

func (*Brokerage) SetAllowsTradingNil 

func (o *Brokerage) SetAllowsTradingNil()

SetAllowsTradingNil sets the value for AllowsTrading to be an explicit nil

func (*Brokerage) SetAwsS3LogoUrl 

func (o *Brokerage) SetAwsS3LogoUrl(v string)

SetAwsS3LogoUrl gets a reference to the given string and assigns it to the AwsS3LogoUrl field.

func (*Brokerage) SetAwsS3SquareLogoUrl 

func (o *Brokerage) SetAwsS3SquareLogoUrl(v string)

SetAwsS3SquareLogoUrl gets a reference to the given NullableString and assigns it to the AwsS3SquareLogoUrl field.

func (*Brokerage) SetAwsS3SquareLogoUrlNil 

func (o *Brokerage) SetAwsS3SquareLogoUrlNil()

SetAwsS3SquareLogoUrlNil sets the value for AwsS3SquareLogoUrl to be an explicit nil

func (*Brokerage) SetBrokerageType 

func (o *Brokerage) SetBrokerageType(v BrokerageType)

SetBrokerageType gets a reference to the given BrokerageType and assigns it to the BrokerageType field.

func (*Brokerage) SetDescription 

func (o *Brokerage) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*Brokerage) SetDisplayName 

func (o *Brokerage) SetDisplayName(v string)

SetDisplayName gets a reference to the given string and assigns it to the DisplayName field.

func (*Brokerage) SetEnabled 

func (o *Brokerage) SetEnabled(v bool)

SetEnabled gets a reference to the given bool and assigns it to the Enabled field.

func (*Brokerage) SetExchanges 

func (o *Brokerage) SetExchanges(v []interface{})

SetExchanges gets a reference to the given []interface{} and assigns it to the Exchanges field. Deprecated

func (*Brokerage) SetHasReporting 

func (o *Brokerage) SetHasReporting(v bool)

SetHasReporting gets a reference to the given NullableBool and assigns it to the HasReporting field. Deprecated

func (*Brokerage) SetHasReportingNil 

func (o *Brokerage) SetHasReportingNil()

SetHasReportingNil sets the value for HasReporting to be an explicit nil

func (*Brokerage) SetId 

func (o *Brokerage) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*Brokerage) SetIsDegraded added in v1.0.139 

func (o *Brokerage) SetIsDegraded(v bool)

SetIsDegraded gets a reference to the given bool and assigns it to the IsDegraded field.

func (*Brokerage) SetIsRealTimeConnection 

func (o *Brokerage) SetIsRealTimeConnection(v bool)

SetIsRealTimeConnection gets a reference to the given bool and assigns it to the IsRealTimeConnection field. Deprecated

func (*Brokerage) SetMaintenanceMode 

func (o *Brokerage) SetMaintenanceMode(v bool)

SetMaintenanceMode gets a reference to the given bool and assigns it to the MaintenanceMode field.

func (*Brokerage) SetName 

func (o *Brokerage) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*Brokerage) SetOpenUrl 

func (o *Brokerage) SetOpenUrl(v string)

SetOpenUrl gets a reference to the given NullableString and assigns it to the OpenUrl field. Deprecated

func (*Brokerage) SetOpenUrlNil 

func (o *Brokerage) SetOpenUrlNil()

SetOpenUrlNil sets the value for OpenUrl to be an explicit nil

func (*Brokerage) SetSlug 

func (o *Brokerage) SetSlug(v string)

SetSlug gets a reference to the given string and assigns it to the Slug field.

func (*Brokerage) SetUrl 

func (o *Brokerage) SetUrl(v string)

SetUrl gets a reference to the given NullableString and assigns it to the Url field.

func (*Brokerage) SetUrlNil added in v1.0.179 

func (o *Brokerage) SetUrlNil()

SetUrlNil sets the value for Url to be an explicit nil

func (*Brokerage) UnmarshalJSON 

func (o *Brokerage) UnmarshalJSON(bytes []byte) (err error)

func (*Brokerage) UnsetAllowsFractionalUnits 

func (o *Brokerage) UnsetAllowsFractionalUnits()

UnsetAllowsFractionalUnits ensures that no value is present for AllowsFractionalUnits, not even an explicit nil

func (*Brokerage) UnsetAllowsTrading 

func (o *Brokerage) UnsetAllowsTrading()

UnsetAllowsTrading ensures that no value is present for AllowsTrading, not even an explicit nil

func (*Brokerage) UnsetAwsS3SquareLogoUrl 

func (o *Brokerage) UnsetAwsS3SquareLogoUrl()

UnsetAwsS3SquareLogoUrl ensures that no value is present for AwsS3SquareLogoUrl, not even an explicit nil

func (*Brokerage) UnsetHasReporting 

func (o *Brokerage) UnsetHasReporting()

UnsetHasReporting ensures that no value is present for HasReporting, not even an explicit nil

func (*Brokerage) UnsetOpenUrl 

func (o *Brokerage) UnsetOpenUrl()

UnsetOpenUrl ensures that no value is present for OpenUrl, not even an explicit nil

func (*Brokerage) UnsetUrl added in v1.0.179 

func (o *Brokerage) UnsetUrl()

UnsetUrl ensures that no value is present for Url, not even an explicit nil

type BrokerageAuthorization 

type BrokerageAuthorization struct {
	// Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.
	Id *string `json:"id,omitempty"`
	// Timestamp of when the connection was established in SnapTrade.
	CreatedDate *time.Time `json:"created_date,omitempty"`
	Brokerage   *Brokerage `json:"brokerage,omitempty"`
	// A short, human-readable name for the connection.
	Name *string `json:"name,omitempty"`
	// Whether the connection is read-only or trade-enabled. A read-only connection can only be used to fetch data, while a trade-enabled connection can be used to place trades. Valid values are `read` and `trade`.
	Type *string `json:"type,omitempty"`
	// Whether the connection is disabled. A disabled connection can no longer access the latest data from the brokerage, but will continue to return the last cached state. A connection can become disabled for many reasons and differs by brokerage. Here are some common scenarios:  - The user has changed their username or password at the brokerage. - The user has explicitly removed the access grant at the brokerage. - The session has expired at the brokerage and now requires explicit user re-authentication.  Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
	Disabled *bool `json:"disabled,omitempty"`
	// Timestamp of when the connection was disabled in SnapTrade.
	DisabledDate NullableTime `json:"disabled_date,omitempty"`
	// Additional data about the connection. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.
	// Deprecated
	Meta map[string]interface{} `json:"meta,omitempty"`
	// Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field.
	// Deprecated
	UpdatedDate *time.Time `json:"updated_date,omitempty"`
	// Whether the connection is eligible for a payout. This is an experimental field that is NOT generally available for all partners. Do not use in production without speaking to the SnapTrade team.
	IsEligibleForPayout *bool `json:"is_eligible_for_payout,omitempty"`
	// Possible values include: - realtime - delayed  Indicates whether SnapTrade will provide delayed or realtime data for this connection. `delayed` means SnapTrade uses cached data for the connection because of the customer's plan, or because of brokerage limitations. `realtime` means SnapTrade retrieves current data from the brokerage during API calls. See the \"Data freshness\" column on the \"Positions & recent orders\" tab at https://support.snaptrade.com/brokerages.
	DataFreshnessMode    *string `json:"data_freshness_mode,omitempty"`
	AdditionalProperties map[string]interface{}
}

BrokerageAuthorization A single connection with a brokerage. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.

func NewBrokerageAuthorization 

func NewBrokerageAuthorization() *BrokerageAuthorization

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

func NewBrokerageAuthorizationWithDefaults 

func NewBrokerageAuthorizationWithDefaults() *BrokerageAuthorization

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

func (*BrokerageAuthorization) GetBrokerage 

func (o *BrokerageAuthorization) GetBrokerage() Brokerage

GetBrokerage returns the Brokerage field value if set, zero value otherwise.

func (*BrokerageAuthorization) GetBrokerageOk 

func (o *BrokerageAuthorization) GetBrokerageOk() (*Brokerage, bool)

GetBrokerageOk returns a tuple with the Brokerage field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorization) GetCreatedDate 

func (o *BrokerageAuthorization) GetCreatedDate() time.Time

GetCreatedDate returns the CreatedDate field value if set, zero value otherwise.

func (*BrokerageAuthorization) GetCreatedDateOk 

func (o *BrokerageAuthorization) GetCreatedDateOk() (*time.Time, bool)

GetCreatedDateOk returns a tuple with the CreatedDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorization) GetDataFreshnessMode added in v1.0.177 

func (o *BrokerageAuthorization) GetDataFreshnessMode() string

GetDataFreshnessMode returns the DataFreshnessMode field value if set, zero value otherwise.

func (*BrokerageAuthorization) GetDataFreshnessModeOk added in v1.0.177 

func (o *BrokerageAuthorization) GetDataFreshnessModeOk() (*string, bool)

GetDataFreshnessModeOk returns a tuple with the DataFreshnessMode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorization) GetDisabled 

func (o *BrokerageAuthorization) GetDisabled() bool

GetDisabled returns the Disabled field value if set, zero value otherwise.

func (*BrokerageAuthorization) GetDisabledDate 

func (o *BrokerageAuthorization) GetDisabledDate() time.Time

GetDisabledDate returns the DisabledDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BrokerageAuthorization) GetDisabledDateOk 

func (o *BrokerageAuthorization) GetDisabledDateOk() (*time.Time, bool)

GetDisabledDateOk returns a tuple with the DisabledDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BrokerageAuthorization) GetDisabledOk 

func (o *BrokerageAuthorization) GetDisabledOk() (*bool, bool)

GetDisabledOk returns a tuple with the Disabled field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorization) GetId 

func (o *BrokerageAuthorization) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*BrokerageAuthorization) GetIdOk 

func (o *BrokerageAuthorization) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorization) GetIsEligibleForPayout added in v1.0.75 

func (o *BrokerageAuthorization) GetIsEligibleForPayout() bool

GetIsEligibleForPayout returns the IsEligibleForPayout field value if set, zero value otherwise.

func (*BrokerageAuthorization) GetIsEligibleForPayoutOk added in v1.0.75 

func (o *BrokerageAuthorization) GetIsEligibleForPayoutOk() (*bool, bool)

GetIsEligibleForPayoutOk returns a tuple with the IsEligibleForPayout field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorization) GetMeta 

func (o *BrokerageAuthorization) GetMeta() map[string]interface{}

GetMeta returns the Meta field value if set, zero value otherwise. Deprecated

func (*BrokerageAuthorization) GetMetaOk 

func (o *BrokerageAuthorization) GetMetaOk() (map[string]interface{}, bool)

GetMetaOk returns a tuple with the Meta field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated

func (*BrokerageAuthorization) GetName 

func (o *BrokerageAuthorization) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*BrokerageAuthorization) GetNameOk 

func (o *BrokerageAuthorization) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorization) GetType 

func (o *BrokerageAuthorization) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*BrokerageAuthorization) GetTypeOk 

func (o *BrokerageAuthorization) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorization) GetUpdatedDate 

func (o *BrokerageAuthorization) GetUpdatedDate() time.Time

GetUpdatedDate returns the UpdatedDate field value if set, zero value otherwise. Deprecated

func (*BrokerageAuthorization) GetUpdatedDateOk 

func (o *BrokerageAuthorization) GetUpdatedDateOk() (*time.Time, bool)

GetUpdatedDateOk returns a tuple with the UpdatedDate field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated

func (*BrokerageAuthorization) HasBrokerage 

func (o *BrokerageAuthorization) HasBrokerage() bool

HasBrokerage returns a boolean if a field has been set.

func (*BrokerageAuthorization) HasCreatedDate 

func (o *BrokerageAuthorization) HasCreatedDate() bool

HasCreatedDate returns a boolean if a field has been set.

func (*BrokerageAuthorization) HasDataFreshnessMode added in v1.0.177 

func (o *BrokerageAuthorization) HasDataFreshnessMode() bool

HasDataFreshnessMode returns a boolean if a field has been set.

func (*BrokerageAuthorization) HasDisabled 

func (o *BrokerageAuthorization) HasDisabled() bool

HasDisabled returns a boolean if a field has been set.

func (*BrokerageAuthorization) HasDisabledDate 

func (o *BrokerageAuthorization) HasDisabledDate() bool

HasDisabledDate returns a boolean if a field has been set.

func (*BrokerageAuthorization) HasId 

func (o *BrokerageAuthorization) HasId() bool

HasId returns a boolean if a field has been set.

func (*BrokerageAuthorization) HasIsEligibleForPayout added in v1.0.75 

func (o *BrokerageAuthorization) HasIsEligibleForPayout() bool

HasIsEligibleForPayout returns a boolean if a field has been set.

func (*BrokerageAuthorization) HasMeta 

func (o *BrokerageAuthorization) HasMeta() bool

HasMeta returns a boolean if a field has been set.

func (*BrokerageAuthorization) HasName 

func (o *BrokerageAuthorization) HasName() bool

HasName returns a boolean if a field has been set.

func (*BrokerageAuthorization) HasType 

func (o *BrokerageAuthorization) HasType() bool

HasType returns a boolean if a field has been set.

func (*BrokerageAuthorization) HasUpdatedDate 

func (o *BrokerageAuthorization) HasUpdatedDate() bool

HasUpdatedDate returns a boolean if a field has been set.

func (BrokerageAuthorization) MarshalJSON 

func (o BrokerageAuthorization) MarshalJSON() ([]byte, error)

func (*BrokerageAuthorization) SetBrokerage 

func (o *BrokerageAuthorization) SetBrokerage(v Brokerage)

SetBrokerage gets a reference to the given Brokerage and assigns it to the Brokerage field.

func (*BrokerageAuthorization) SetCreatedDate 

func (o *BrokerageAuthorization) SetCreatedDate(v time.Time)

SetCreatedDate gets a reference to the given time.Time and assigns it to the CreatedDate field.

func (*BrokerageAuthorization) SetDataFreshnessMode added in v1.0.177 

func (o *BrokerageAuthorization) SetDataFreshnessMode(v string)

SetDataFreshnessMode gets a reference to the given string and assigns it to the DataFreshnessMode field.

func (*BrokerageAuthorization) SetDisabled 

func (o *BrokerageAuthorization) SetDisabled(v bool)

SetDisabled gets a reference to the given bool and assigns it to the Disabled field.

func (*BrokerageAuthorization) SetDisabledDate 

func (o *BrokerageAuthorization) SetDisabledDate(v time.Time)

SetDisabledDate gets a reference to the given NullableTime and assigns it to the DisabledDate field.

func (*BrokerageAuthorization) SetDisabledDateNil 

func (o *BrokerageAuthorization) SetDisabledDateNil()

SetDisabledDateNil sets the value for DisabledDate to be an explicit nil

func (*BrokerageAuthorization) SetId 

func (o *BrokerageAuthorization) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*BrokerageAuthorization) SetIsEligibleForPayout added in v1.0.75 

func (o *BrokerageAuthorization) SetIsEligibleForPayout(v bool)

SetIsEligibleForPayout gets a reference to the given bool and assigns it to the IsEligibleForPayout field.

func (*BrokerageAuthorization) SetMeta 

func (o *BrokerageAuthorization) SetMeta(v map[string]interface{})

SetMeta gets a reference to the given map[string]interface{} and assigns it to the Meta field. Deprecated

func (*BrokerageAuthorization) SetName 

func (o *BrokerageAuthorization) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*BrokerageAuthorization) SetType 

func (o *BrokerageAuthorization) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (*BrokerageAuthorization) SetUpdatedDate 

func (o *BrokerageAuthorization) SetUpdatedDate(v time.Time)

SetUpdatedDate gets a reference to the given time.Time and assigns it to the UpdatedDate field. Deprecated

func (*BrokerageAuthorization) UnmarshalJSON 

func (o *BrokerageAuthorization) UnmarshalJSON(bytes []byte) (err error)

func (*BrokerageAuthorization) UnsetDisabledDate 

func (o *BrokerageAuthorization) UnsetDisabledDate()

UnsetDisabledDate ensures that no value is present for DisabledDate, not even an explicit nil

type BrokerageAuthorizationDisabledConfirmation 

type BrokerageAuthorizationDisabledConfirmation struct {
	// Connection disabled confirmation
	Detail               *string `json:"detail,omitempty"`
	AdditionalProperties map[string]interface{}
}

BrokerageAuthorizationDisabledConfirmation Confirmation that the connection has been disabled.

func NewBrokerageAuthorizationDisabledConfirmation 

func NewBrokerageAuthorizationDisabledConfirmation() *BrokerageAuthorizationDisabledConfirmation

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

func NewBrokerageAuthorizationDisabledConfirmationWithDefaults 

func NewBrokerageAuthorizationDisabledConfirmationWithDefaults() *BrokerageAuthorizationDisabledConfirmation

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

func (*BrokerageAuthorizationDisabledConfirmation) GetDetail 

func (o *BrokerageAuthorizationDisabledConfirmation) GetDetail() string

GetDetail returns the Detail field value if set, zero value otherwise.

func (*BrokerageAuthorizationDisabledConfirmation) GetDetailOk 

func (o *BrokerageAuthorizationDisabledConfirmation) GetDetailOk() (*string, bool)

GetDetailOk returns a tuple with the Detail field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorizationDisabledConfirmation) HasDetail 

func (o *BrokerageAuthorizationDisabledConfirmation) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (BrokerageAuthorizationDisabledConfirmation) MarshalJSON 

func (o BrokerageAuthorizationDisabledConfirmation) MarshalJSON() ([]byte, error)

func (*BrokerageAuthorizationDisabledConfirmation) SetDetail 

func (o *BrokerageAuthorizationDisabledConfirmation) SetDetail(v string)

SetDetail gets a reference to the given string and assigns it to the Detail field.

func (*BrokerageAuthorizationDisabledConfirmation) UnmarshalJSON 

func (o *BrokerageAuthorizationDisabledConfirmation) UnmarshalJSON(bytes []byte) (err error)

type BrokerageAuthorizationRefreshConfirmation 

type BrokerageAuthorizationRefreshConfirmation struct {
	// Refresh confirmation details
	Detail               *string `json:"detail,omitempty"`
	AdditionalProperties map[string]interface{}
}

BrokerageAuthorizationRefreshConfirmation Confirmation that the syncs have been scheduled.

func NewBrokerageAuthorizationRefreshConfirmation 

func NewBrokerageAuthorizationRefreshConfirmation() *BrokerageAuthorizationRefreshConfirmation

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

func NewBrokerageAuthorizationRefreshConfirmationWithDefaults 

func NewBrokerageAuthorizationRefreshConfirmationWithDefaults() *BrokerageAuthorizationRefreshConfirmation

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

func (*BrokerageAuthorizationRefreshConfirmation) GetDetail 

func (o *BrokerageAuthorizationRefreshConfirmation) GetDetail() string

GetDetail returns the Detail field value if set, zero value otherwise.

func (*BrokerageAuthorizationRefreshConfirmation) GetDetailOk 

func (o *BrokerageAuthorizationRefreshConfirmation) GetDetailOk() (*string, bool)

GetDetailOk returns a tuple with the Detail field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorizationRefreshConfirmation) HasDetail 

func (o *BrokerageAuthorizationRefreshConfirmation) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (BrokerageAuthorizationRefreshConfirmation) MarshalJSON 

func (o BrokerageAuthorizationRefreshConfirmation) MarshalJSON() ([]byte, error)

func (*BrokerageAuthorizationRefreshConfirmation) SetDetail 

func (o *BrokerageAuthorizationRefreshConfirmation) SetDetail(v string)

SetDetail gets a reference to the given string and assigns it to the Detail field.

func (*BrokerageAuthorizationRefreshConfirmation) UnmarshalJSON 

func (o *BrokerageAuthorizationRefreshConfirmation) UnmarshalJSON(bytes []byte) (err error)

type BrokerageAuthorizationTransactionsSyncConfirmation added in v1.0.155 

type BrokerageAuthorizationTransactionsSyncConfirmation struct {
	// Transactions sync confirmation details
	Detail               *string `json:"detail,omitempty"`
	AdditionalProperties map[string]interface{}
}

BrokerageAuthorizationTransactionsSyncConfirmation Confirmation that the transaction syncs have been scheduled.

func NewBrokerageAuthorizationTransactionsSyncConfirmation added in v1.0.155 

func NewBrokerageAuthorizationTransactionsSyncConfirmation() *BrokerageAuthorizationTransactionsSyncConfirmation

NewBrokerageAuthorizationTransactionsSyncConfirmation instantiates a new BrokerageAuthorizationTransactionsSyncConfirmation 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

func NewBrokerageAuthorizationTransactionsSyncConfirmationWithDefaults added in v1.0.155 

func NewBrokerageAuthorizationTransactionsSyncConfirmationWithDefaults() *BrokerageAuthorizationTransactionsSyncConfirmation

NewBrokerageAuthorizationTransactionsSyncConfirmationWithDefaults instantiates a new BrokerageAuthorizationTransactionsSyncConfirmation 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

func (*BrokerageAuthorizationTransactionsSyncConfirmation) GetDetail added in v1.0.155 

func (o *BrokerageAuthorizationTransactionsSyncConfirmation) GetDetail() string

GetDetail returns the Detail field value if set, zero value otherwise.

func (*BrokerageAuthorizationTransactionsSyncConfirmation) GetDetailOk added in v1.0.155 

func (o *BrokerageAuthorizationTransactionsSyncConfirmation) GetDetailOk() (*string, bool)

GetDetailOk returns a tuple with the Detail field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorizationTransactionsSyncConfirmation) HasDetail added in v1.0.155 

func (o *BrokerageAuthorizationTransactionsSyncConfirmation) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (BrokerageAuthorizationTransactionsSyncConfirmation) MarshalJSON added in v1.0.155 

func (o BrokerageAuthorizationTransactionsSyncConfirmation) MarshalJSON() ([]byte, error)

func (*BrokerageAuthorizationTransactionsSyncConfirmation) SetDetail added in v1.0.155 

func (o *BrokerageAuthorizationTransactionsSyncConfirmation) SetDetail(v string)

SetDetail gets a reference to the given string and assigns it to the Detail field.

func (*BrokerageAuthorizationTransactionsSyncConfirmation) UnmarshalJSON added in v1.0.155 

func (o *BrokerageAuthorizationTransactionsSyncConfirmation) UnmarshalJSON(bytes []byte) (err error)

type BrokerageAuthorizationTypeReadOnly 

type BrokerageAuthorizationTypeReadOnly struct {
	Id                   *string                                      `json:"id,omitempty"`
	Type                 *string                                      `json:"type,omitempty"`
	AuthType             *string                                      `json:"auth_type,omitempty"`
	Brokerage            *BrokerageAuthorizationTypeReadOnlyBrokerage `json:"brokerage,omitempty"`
	AdditionalProperties map[string]interface{}
}

BrokerageAuthorizationTypeReadOnly struct for BrokerageAuthorizationTypeReadOnly

func NewBrokerageAuthorizationTypeReadOnly 

func NewBrokerageAuthorizationTypeReadOnly() *BrokerageAuthorizationTypeReadOnly

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

func NewBrokerageAuthorizationTypeReadOnlyWithDefaults 

func NewBrokerageAuthorizationTypeReadOnlyWithDefaults() *BrokerageAuthorizationTypeReadOnly

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

func (*BrokerageAuthorizationTypeReadOnly) GetAuthType 

func (o *BrokerageAuthorizationTypeReadOnly) GetAuthType() string

GetAuthType returns the AuthType field value if set, zero value otherwise.

func (*BrokerageAuthorizationTypeReadOnly) GetAuthTypeOk 

func (o *BrokerageAuthorizationTypeReadOnly) GetAuthTypeOk() (*string, bool)

GetAuthTypeOk returns a tuple with the AuthType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorizationTypeReadOnly) GetBrokerage 

func (o *BrokerageAuthorizationTypeReadOnly) GetBrokerage() BrokerageAuthorizationTypeReadOnlyBrokerage

GetBrokerage returns the Brokerage field value if set, zero value otherwise.

func (*BrokerageAuthorizationTypeReadOnly) GetBrokerageOk 

func (o *BrokerageAuthorizationTypeReadOnly) GetBrokerageOk() (*BrokerageAuthorizationTypeReadOnlyBrokerage, bool)

GetBrokerageOk returns a tuple with the Brokerage field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorizationTypeReadOnly) GetId 

func (o *BrokerageAuthorizationTypeReadOnly) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*BrokerageAuthorizationTypeReadOnly) GetIdOk 

func (o *BrokerageAuthorizationTypeReadOnly) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorizationTypeReadOnly) GetType 

func (o *BrokerageAuthorizationTypeReadOnly) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*BrokerageAuthorizationTypeReadOnly) GetTypeOk 

func (o *BrokerageAuthorizationTypeReadOnly) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorizationTypeReadOnly) HasAuthType 

func (o *BrokerageAuthorizationTypeReadOnly) HasAuthType() bool

HasAuthType returns a boolean if a field has been set.

func (*BrokerageAuthorizationTypeReadOnly) HasBrokerage 

func (o *BrokerageAuthorizationTypeReadOnly) HasBrokerage() bool

HasBrokerage returns a boolean if a field has been set.

func (*BrokerageAuthorizationTypeReadOnly) HasId 

func (o *BrokerageAuthorizationTypeReadOnly) HasId() bool

HasId returns a boolean if a field has been set.

func (*BrokerageAuthorizationTypeReadOnly) HasType 

func (o *BrokerageAuthorizationTypeReadOnly) HasType() bool

HasType returns a boolean if a field has been set.

func (BrokerageAuthorizationTypeReadOnly) MarshalJSON 

func (o BrokerageAuthorizationTypeReadOnly) MarshalJSON() ([]byte, error)

func (*BrokerageAuthorizationTypeReadOnly) SetAuthType 

func (o *BrokerageAuthorizationTypeReadOnly) SetAuthType(v string)

SetAuthType gets a reference to the given string and assigns it to the AuthType field.

func (*BrokerageAuthorizationTypeReadOnly) SetBrokerage 

func (o *BrokerageAuthorizationTypeReadOnly) SetBrokerage(v BrokerageAuthorizationTypeReadOnlyBrokerage)

SetBrokerage gets a reference to the given BrokerageAuthorizationTypeReadOnlyBrokerage and assigns it to the Brokerage field.

func (*BrokerageAuthorizationTypeReadOnly) SetId 

func (o *BrokerageAuthorizationTypeReadOnly) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*BrokerageAuthorizationTypeReadOnly) SetType 

func (o *BrokerageAuthorizationTypeReadOnly) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (*BrokerageAuthorizationTypeReadOnly) UnmarshalJSON 

func (o *BrokerageAuthorizationTypeReadOnly) UnmarshalJSON(bytes []byte) (err error)

type BrokerageAuthorizationTypeReadOnlyBrokerage 

type BrokerageAuthorizationTypeReadOnlyBrokerage struct {
	Id *string `json:"id,omitempty"`
	// Full name of the brokerage.
	Name *string `json:"name,omitempty"`
	// A unique identifier for that brokerage. It is usually the name of the brokerage in capital letters and will never change.
	Slug                 *string `json:"slug,omitempty"`
	AdditionalProperties map[string]interface{}
}

BrokerageAuthorizationTypeReadOnlyBrokerage struct for BrokerageAuthorizationTypeReadOnlyBrokerage

func NewBrokerageAuthorizationTypeReadOnlyBrokerage 

func NewBrokerageAuthorizationTypeReadOnlyBrokerage() *BrokerageAuthorizationTypeReadOnlyBrokerage

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

func NewBrokerageAuthorizationTypeReadOnlyBrokerageWithDefaults 

func NewBrokerageAuthorizationTypeReadOnlyBrokerageWithDefaults() *BrokerageAuthorizationTypeReadOnlyBrokerage

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

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) GetId 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) GetIdOk 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) GetName 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) GetNameOk 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) GetSlug 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) GetSlug() string

GetSlug returns the Slug field value if set, zero value otherwise.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) GetSlugOk 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) GetSlugOk() (*string, bool)

GetSlugOk returns a tuple with the Slug field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) HasId 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) HasId() bool

HasId returns a boolean if a field has been set.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) HasName 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) HasName() bool

HasName returns a boolean if a field has been set.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) HasSlug 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) HasSlug() bool

HasSlug returns a boolean if a field has been set.

func (BrokerageAuthorizationTypeReadOnlyBrokerage) MarshalJSON 

func (o BrokerageAuthorizationTypeReadOnlyBrokerage) MarshalJSON() ([]byte, error)

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) SetId 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) SetName 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) SetSlug 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) SetSlug(v string)

SetSlug gets a reference to the given string and assigns it to the Slug field.

func (*BrokerageAuthorizationTypeReadOnlyBrokerage) UnmarshalJSON 

func (o *BrokerageAuthorizationTypeReadOnlyBrokerage) UnmarshalJSON(bytes []byte) (err error)

type BrokerageInstrument added in v1.0.90 

type BrokerageInstrument struct {
	// The instrument's trading symbol / ticker.
	Symbol string `json:"symbol"`
	// The MIC code of the exchange where the instrument is traded.
	ExchangeMic NullableString `json:"exchange_mic,omitempty"`
	// Whether the instrument is tradeable through the brokerage. `null` if the tradeability is unknown.
	Tradeable NullableBool `json:"tradeable,omitempty"`
	// Whether the instrument allows fractional units. `null` if the fractionability is unknown.
	Fractionable NullableBool `json:"fractionable,omitempty"`
	// The universal symbol ID of the instrument. This is the ID used to reference the instrument in SnapTrade API calls.
	UniversalSymbolId    NullableString `json:"universal_symbol_id,omitempty"`
	AdditionalProperties map[string]interface{}
}

BrokerageInstrument struct for BrokerageInstrument

func NewBrokerageInstrument added in v1.0.90 

func NewBrokerageInstrument(symbol string) *BrokerageInstrument

NewBrokerageInstrument instantiates a new BrokerageInstrument 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

func NewBrokerageInstrumentWithDefaults added in v1.0.90 

func NewBrokerageInstrumentWithDefaults() *BrokerageInstrument

NewBrokerageInstrumentWithDefaults instantiates a new BrokerageInstrument 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

func (*BrokerageInstrument) GetExchangeMic added in v1.0.90 

func (o *BrokerageInstrument) GetExchangeMic() string

GetExchangeMic returns the ExchangeMic field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BrokerageInstrument) GetExchangeMicOk added in v1.0.90 

func (o *BrokerageInstrument) GetExchangeMicOk() (*string, bool)

GetExchangeMicOk returns a tuple with the ExchangeMic field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BrokerageInstrument) GetFractionable added in v1.0.90 

func (o *BrokerageInstrument) GetFractionable() bool

GetFractionable returns the Fractionable field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BrokerageInstrument) GetFractionableOk added in v1.0.90 

func (o *BrokerageInstrument) GetFractionableOk() (*bool, bool)

GetFractionableOk returns a tuple with the Fractionable field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BrokerageInstrument) GetSymbol added in v1.0.90 

func (o *BrokerageInstrument) GetSymbol() string

GetSymbol returns the Symbol field value

func (*BrokerageInstrument) GetSymbolOk added in v1.0.90 

func (o *BrokerageInstrument) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value and a boolean to check if the value has been set.

func (*BrokerageInstrument) GetTradeable added in v1.0.90 

func (o *BrokerageInstrument) GetTradeable() bool

GetTradeable returns the Tradeable field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BrokerageInstrument) GetTradeableOk added in v1.0.90 

func (o *BrokerageInstrument) GetTradeableOk() (*bool, bool)

GetTradeableOk returns a tuple with the Tradeable field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BrokerageInstrument) GetUniversalSymbolId added in v1.0.90 

func (o *BrokerageInstrument) GetUniversalSymbolId() string

GetUniversalSymbolId returns the UniversalSymbolId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BrokerageInstrument) GetUniversalSymbolIdOk added in v1.0.90 

func (o *BrokerageInstrument) GetUniversalSymbolIdOk() (*string, bool)

GetUniversalSymbolIdOk returns a tuple with the UniversalSymbolId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*BrokerageInstrument) HasExchangeMic added in v1.0.90 

func (o *BrokerageInstrument) HasExchangeMic() bool

HasExchangeMic returns a boolean if a field has been set.

func (*BrokerageInstrument) HasFractionable added in v1.0.90 

func (o *BrokerageInstrument) HasFractionable() bool

HasFractionable returns a boolean if a field has been set.

func (*BrokerageInstrument) HasTradeable added in v1.0.90 

func (o *BrokerageInstrument) HasTradeable() bool

HasTradeable returns a boolean if a field has been set.

func (*BrokerageInstrument) HasUniversalSymbolId added in v1.0.90 

func (o *BrokerageInstrument) HasUniversalSymbolId() bool

HasUniversalSymbolId returns a boolean if a field has been set.

func (BrokerageInstrument) MarshalJSON added in v1.0.90 

func (o BrokerageInstrument) MarshalJSON() ([]byte, error)

func (*BrokerageInstrument) SetExchangeMic added in v1.0.90 

func (o *BrokerageInstrument) SetExchangeMic(v string)

SetExchangeMic gets a reference to the given NullableString and assigns it to the ExchangeMic field.

func (*BrokerageInstrument) SetExchangeMicNil added in v1.0.90 

func (o *BrokerageInstrument) SetExchangeMicNil()

SetExchangeMicNil sets the value for ExchangeMic to be an explicit nil

func (*BrokerageInstrument) SetFractionable added in v1.0.90 

func (o *BrokerageInstrument) SetFractionable(v bool)

SetFractionable gets a reference to the given NullableBool and assigns it to the Fractionable field.

func (*BrokerageInstrument) SetFractionableNil added in v1.0.90 

func (o *BrokerageInstrument) SetFractionableNil()

SetFractionableNil sets the value for Fractionable to be an explicit nil

func (*BrokerageInstrument) SetSymbol added in v1.0.90 

func (o *BrokerageInstrument) SetSymbol(v string)

SetSymbol sets field value

func (*BrokerageInstrument) SetTradeable added in v1.0.90 

func (o *BrokerageInstrument) SetTradeable(v bool)

SetTradeable gets a reference to the given NullableBool and assigns it to the Tradeable field.

func (*BrokerageInstrument) SetTradeableNil added in v1.0.90 

func (o *BrokerageInstrument) SetTradeableNil()

SetTradeableNil sets the value for Tradeable to be an explicit nil

func (*BrokerageInstrument) SetUniversalSymbolId added in v1.0.90 

func (o *BrokerageInstrument) SetUniversalSymbolId(v string)

SetUniversalSymbolId gets a reference to the given NullableString and assigns it to the UniversalSymbolId field.

func (*BrokerageInstrument) SetUniversalSymbolIdNil added in v1.0.90 

func (o *BrokerageInstrument) SetUniversalSymbolIdNil()

SetUniversalSymbolIdNil sets the value for UniversalSymbolId to be an explicit nil

func (*BrokerageInstrument) UnmarshalJSON added in v1.0.90 

func (o *BrokerageInstrument) UnmarshalJSON(bytes []byte) (err error)

func (*BrokerageInstrument) UnsetExchangeMic added in v1.0.90 

func (o *BrokerageInstrument) UnsetExchangeMic()

UnsetExchangeMic ensures that no value is present for ExchangeMic, not even an explicit nil

func (*BrokerageInstrument) UnsetFractionable added in v1.0.90 

func (o *BrokerageInstrument) UnsetFractionable()

UnsetFractionable ensures that no value is present for Fractionable, not even an explicit nil

func (*BrokerageInstrument) UnsetTradeable added in v1.0.90 

func (o *BrokerageInstrument) UnsetTradeable()

UnsetTradeable ensures that no value is present for Tradeable, not even an explicit nil

func (*BrokerageInstrument) UnsetUniversalSymbolId added in v1.0.90 

func (o *BrokerageInstrument) UnsetUniversalSymbolId()

UnsetUniversalSymbolId ensures that no value is present for UniversalSymbolId, not even an explicit nil

type BrokerageInstrumentsResponse added in v1.0.90 

type BrokerageInstrumentsResponse struct {
	Instruments          []BrokerageInstrument `json:"instruments,omitempty"`
	AdditionalProperties map[string]interface{}
}

BrokerageInstrumentsResponse struct for BrokerageInstrumentsResponse

func NewBrokerageInstrumentsResponse added in v1.0.90 

func NewBrokerageInstrumentsResponse() *BrokerageInstrumentsResponse

NewBrokerageInstrumentsResponse instantiates a new BrokerageInstrumentsResponse 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

func NewBrokerageInstrumentsResponseWithDefaults added in v1.0.90 

func NewBrokerageInstrumentsResponseWithDefaults() *BrokerageInstrumentsResponse

NewBrokerageInstrumentsResponseWithDefaults instantiates a new BrokerageInstrumentsResponse 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

func (*BrokerageInstrumentsResponse) GetInstruments added in v1.0.90 

func (o *BrokerageInstrumentsResponse) GetInstruments() []BrokerageInstrument

GetInstruments returns the Instruments field value if set, zero value otherwise.

func (*BrokerageInstrumentsResponse) GetInstrumentsOk added in v1.0.90 

func (o *BrokerageInstrumentsResponse) GetInstrumentsOk() ([]BrokerageInstrument, bool)

GetInstrumentsOk returns a tuple with the Instruments field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageInstrumentsResponse) HasInstruments added in v1.0.90 

func (o *BrokerageInstrumentsResponse) HasInstruments() bool

HasInstruments returns a boolean if a field has been set.

func (BrokerageInstrumentsResponse) MarshalJSON added in v1.0.90 

func (o BrokerageInstrumentsResponse) MarshalJSON() ([]byte, error)

func (*BrokerageInstrumentsResponse) SetInstruments added in v1.0.90 

func (o *BrokerageInstrumentsResponse) SetInstruments(v []BrokerageInstrument)

SetInstruments gets a reference to the given []BrokerageInstrument and assigns it to the Instruments field.

func (*BrokerageInstrumentsResponse) UnmarshalJSON added in v1.0.90 

func (o *BrokerageInstrumentsResponse) UnmarshalJSON(bytes []byte) (err error)

type BrokerageType 

type BrokerageType struct {
	Id                   *string `json:"id,omitempty"`
	Name                 *string `json:"name,omitempty"`
	AdditionalProperties map[string]interface{}
}

BrokerageType Type of brokerage. Currently supports traditional brokerages and crypto exchanges.

func NewBrokerageType 

func NewBrokerageType() *BrokerageType

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

func NewBrokerageTypeWithDefaults 

func NewBrokerageTypeWithDefaults() *BrokerageType

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

func (*BrokerageType) GetId 

func (o *BrokerageType) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*BrokerageType) GetIdOk 

func (o *BrokerageType) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageType) GetName 

func (o *BrokerageType) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*BrokerageType) GetNameOk 

func (o *BrokerageType) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrokerageType) HasId 

func (o *BrokerageType) HasId() bool

HasId returns a boolean if a field has been set.

func (*BrokerageType) HasName 

func (o *BrokerageType) HasName() bool

HasName returns a boolean if a field has been set.

func (BrokerageType) MarshalJSON 

func (o BrokerageType) MarshalJSON() ([]byte, error)

func (*BrokerageType) SetId 

func (o *BrokerageType) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*BrokerageType) SetName 

func (o *BrokerageType) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*BrokerageType) UnmarshalJSON 

func (o *BrokerageType) UnmarshalJSON(bytes []byte) (err error)

type CancelOrderResponse added in v1.0.89 

type CancelOrderResponse struct {
	// Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
	BrokerageOrderId string `json:"brokerage_order_id"`
	// The raw response from the brokerage.
	RawResponse          map[string]interface{} `json:"raw_response,omitempty"`
	AdditionalProperties map[string]interface{}
}

CancelOrderResponse struct for CancelOrderResponse

func NewCancelOrderResponse added in v1.0.89 

func NewCancelOrderResponse(brokerageOrderId string) *CancelOrderResponse

NewCancelOrderResponse instantiates a new CancelOrderResponse 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

func NewCancelOrderResponseWithDefaults added in v1.0.89 

func NewCancelOrderResponseWithDefaults() *CancelOrderResponse

NewCancelOrderResponseWithDefaults instantiates a new CancelOrderResponse 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

func (*CancelOrderResponse) GetBrokerageOrderId added in v1.0.89 

func (o *CancelOrderResponse) GetBrokerageOrderId() string

GetBrokerageOrderId returns the BrokerageOrderId field value

func (*CancelOrderResponse) GetBrokerageOrderIdOk added in v1.0.89 

func (o *CancelOrderResponse) GetBrokerageOrderIdOk() (*string, bool)

GetBrokerageOrderIdOk returns a tuple with the BrokerageOrderId field value and a boolean to check if the value has been set.

func (*CancelOrderResponse) GetRawResponse added in v1.0.89 

func (o *CancelOrderResponse) GetRawResponse() map[string]interface{}

GetRawResponse returns the RawResponse field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CancelOrderResponse) GetRawResponseOk added in v1.0.89 

func (o *CancelOrderResponse) GetRawResponseOk() (map[string]interface{}, bool)

GetRawResponseOk returns a tuple with the RawResponse field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CancelOrderResponse) HasRawResponse added in v1.0.89 

func (o *CancelOrderResponse) HasRawResponse() bool

HasRawResponse returns a boolean if a field has been set.

func (CancelOrderResponse) MarshalJSON added in v1.0.89 

func (o CancelOrderResponse) MarshalJSON() ([]byte, error)

func (*CancelOrderResponse) SetBrokerageOrderId added in v1.0.89 

func (o *CancelOrderResponse) SetBrokerageOrderId(v string)

SetBrokerageOrderId sets field value

func (*CancelOrderResponse) SetRawResponse added in v1.0.89 

func (o *CancelOrderResponse) SetRawResponse(v map[string]interface{})

SetRawResponse gets a reference to the given map[string]interface{} and assigns it to the RawResponse field.

func (*CancelOrderResponse) UnmarshalJSON added in v1.0.89 

func (o *CancelOrderResponse) UnmarshalJSON(bytes []byte) (err error)

type CefInstrument added in v1.0.160 

type CefInstrument struct {
	// Type of security instrument.
	Kind string `json:"kind"`
	// Unique identifier for the instrument.
	Id string `json:"id"`
	// The formatted trading symbol for the security.
	Symbol string `json:"symbol"`
	// The raw symbol without any exchange suffix.
	RawSymbol string `json:"raw_symbol"`
	// Human-readable description of the security.
	Description NullableString `json:"description,omitempty"`
	// ISO-4217 currency code for the security listing.
	Currency NullableString `json:"currency,omitempty"`
	// Exchange MIC code or exchange code for the security.
	Exchange             NullableString                 `json:"exchange,omitempty"`
	FigiInstrument       NullableFigiInstrumentNullable `json:"figi_instrument,omitempty"`
	AdditionalProperties map[string]interface{}
}

CefInstrument Security instrument metadata for closed-end fund positions.

func NewCefInstrument added in v1.0.160 

func NewCefInstrument(kind string, id string, symbol string, rawSymbol string) *CefInstrument

NewCefInstrument instantiates a new CefInstrument 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

func NewCefInstrumentWithDefaults added in v1.0.160 

func NewCefInstrumentWithDefaults() *CefInstrument

NewCefInstrumentWithDefaults instantiates a new CefInstrument 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

func (*CefInstrument) GetCurrency added in v1.0.160 

func (o *CefInstrument) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CefInstrument) GetCurrencyOk added in v1.0.160 

func (o *CefInstrument) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CefInstrument) GetDescription added in v1.0.160 

func (o *CefInstrument) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CefInstrument) GetDescriptionOk added in v1.0.160 

func (o *CefInstrument) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CefInstrument) GetExchange added in v1.0.160 

func (o *CefInstrument) GetExchange() string

GetExchange returns the Exchange field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CefInstrument) GetExchangeOk added in v1.0.160 

func (o *CefInstrument) GetExchangeOk() (*string, bool)

GetExchangeOk returns a tuple with the Exchange field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CefInstrument) GetFigiInstrument added in v1.0.160 

func (o *CefInstrument) GetFigiInstrument() FigiInstrumentNullable

GetFigiInstrument returns the FigiInstrument field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CefInstrument) GetFigiInstrumentOk added in v1.0.160 

func (o *CefInstrument) GetFigiInstrumentOk() (*FigiInstrumentNullable, bool)

GetFigiInstrumentOk returns a tuple with the FigiInstrument field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CefInstrument) GetId added in v1.0.160 

func (o *CefInstrument) GetId() string

GetId returns the Id field value

func (*CefInstrument) GetIdOk added in v1.0.160 

func (o *CefInstrument) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*CefInstrument) GetKind added in v1.0.160 

func (o *CefInstrument) GetKind() string

GetKind returns the Kind field value

func (*CefInstrument) GetKindOk added in v1.0.160 

func (o *CefInstrument) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value and a boolean to check if the value has been set.

func (*CefInstrument) GetRawSymbol added in v1.0.160 

func (o *CefInstrument) GetRawSymbol() string

GetRawSymbol returns the RawSymbol field value

func (*CefInstrument) GetRawSymbolOk added in v1.0.160 

func (o *CefInstrument) GetRawSymbolOk() (*string, bool)

GetRawSymbolOk returns a tuple with the RawSymbol field value and a boolean to check if the value has been set.

func (*CefInstrument) GetSymbol added in v1.0.160 

func (o *CefInstrument) GetSymbol() string

GetSymbol returns the Symbol field value

func (*CefInstrument) GetSymbolOk added in v1.0.160 

func (o *CefInstrument) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value and a boolean to check if the value has been set.

func (*CefInstrument) HasCurrency added in v1.0.160 

func (o *CefInstrument) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*CefInstrument) HasDescription added in v1.0.160 

func (o *CefInstrument) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CefInstrument) HasExchange added in v1.0.160 

func (o *CefInstrument) HasExchange() bool

HasExchange returns a boolean if a field has been set.

func (*CefInstrument) HasFigiInstrument added in v1.0.160 

func (o *CefInstrument) HasFigiInstrument() bool

HasFigiInstrument returns a boolean if a field has been set.

func (CefInstrument) MarshalJSON added in v1.0.160 

func (o CefInstrument) MarshalJSON() ([]byte, error)

func (*CefInstrument) SetCurrency added in v1.0.160 

func (o *CefInstrument) SetCurrency(v string)

SetCurrency gets a reference to the given NullableString and assigns it to the Currency field.

func (*CefInstrument) SetCurrencyNil added in v1.0.160 

func (o *CefInstrument) SetCurrencyNil()

SetCurrencyNil sets the value for Currency to be an explicit nil

func (*CefInstrument) SetDescription added in v1.0.160 

func (o *CefInstrument) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CefInstrument) SetDescriptionNil added in v1.0.160 

func (o *CefInstrument) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CefInstrument) SetExchange added in v1.0.160 

func (o *CefInstrument) SetExchange(v string)

SetExchange gets a reference to the given NullableString and assigns it to the Exchange field.

func (*CefInstrument) SetExchangeNil added in v1.0.160 

func (o *CefInstrument) SetExchangeNil()

SetExchangeNil sets the value for Exchange to be an explicit nil

func (*CefInstrument) SetFigiInstrument added in v1.0.160 

func (o *CefInstrument) SetFigiInstrument(v FigiInstrumentNullable)

SetFigiInstrument gets a reference to the given NullableFigiInstrumentNullable and assigns it to the FigiInstrument field.

func (*CefInstrument) SetFigiInstrumentNil added in v1.0.160 

func (o *CefInstrument) SetFigiInstrumentNil()

SetFigiInstrumentNil sets the value for FigiInstrument to be an explicit nil

func (*CefInstrument) SetId added in v1.0.160 

func (o *CefInstrument) SetId(v string)

SetId sets field value

func (*CefInstrument) SetKind added in v1.0.160 

func (o *CefInstrument) SetKind(v string)

SetKind sets field value

func (*CefInstrument) SetRawSymbol added in v1.0.160 

func (o *CefInstrument) SetRawSymbol(v string)

SetRawSymbol sets field value

func (*CefInstrument) SetSymbol added in v1.0.160 

func (o *CefInstrument) SetSymbol(v string)

SetSymbol sets field value

func (*CefInstrument) UnmarshalJSON added in v1.0.160 

func (o *CefInstrument) UnmarshalJSON(bytes []byte) (err error)

func (*CefInstrument) UnsetCurrency added in v1.0.160 

func (o *CefInstrument) UnsetCurrency()

UnsetCurrency ensures that no value is present for Currency, not even an explicit nil

func (*CefInstrument) UnsetDescription added in v1.0.160 

func (o *CefInstrument) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*CefInstrument) UnsetExchange added in v1.0.160 

func (o *CefInstrument) UnsetExchange()

UnsetExchange ensures that no value is present for Exchange, not even an explicit nil

func (*CefInstrument) UnsetFigiInstrument added in v1.0.160 

func (o *CefInstrument) UnsetFigiInstrument()

UnsetFigiInstrument ensures that no value is present for FigiInstrument, not even an explicit nil

type CfdInstrument added in v1.0.182 

type CfdInstrument struct {
	// Type of security instrument.
	Kind string `json:"kind"`
	// Unique identifier for the canonical CFD instrument wrapper.
	Id string `json:"id"`
	// Formatted symbol of the instrument underlying the CFD wrapper.
	Symbol string `json:"symbol"`
	// Raw symbol of the instrument underlying the CFD wrapper.
	RawSymbol string `json:"raw_symbol"`
	// Human-readable description of the instrument underlying the CFD wrapper.
	Description NullableString `json:"description,omitempty"`
	// ISO-4217 currency code for the instrument underlying the CFD wrapper.
	Currency NullableString `json:"currency,omitempty"`
	// Exchange MIC code or exchange code for the instrument underlying the CFD wrapper.
	Exchange             NullableString          `json:"exchange,omitempty"`
	UnderlyingInstrument UnderlyingCfdInstrument `json:"underlying_instrument"`
	AdditionalProperties map[string]interface{}
}

CfdInstrument Canonical CFD wrapper instrument metadata for a V2 position.

func NewCfdInstrument added in v1.0.182 

func NewCfdInstrument(kind string, id string, symbol string, rawSymbol string, underlyingInstrument UnderlyingCfdInstrument) *CfdInstrument

NewCfdInstrument instantiates a new CfdInstrument 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

func NewCfdInstrumentWithDefaults added in v1.0.182 

func NewCfdInstrumentWithDefaults() *CfdInstrument

NewCfdInstrumentWithDefaults instantiates a new CfdInstrument 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

func (*CfdInstrument) GetCurrency added in v1.0.182 

func (o *CfdInstrument) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CfdInstrument) GetCurrencyOk added in v1.0.182 

func (o *CfdInstrument) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CfdInstrument) GetDescription added in v1.0.182 

func (o *CfdInstrument) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CfdInstrument) GetDescriptionOk added in v1.0.182 

func (o *CfdInstrument) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CfdInstrument) GetExchange added in v1.0.182 

func (o *CfdInstrument) GetExchange() string

GetExchange returns the Exchange field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CfdInstrument) GetExchangeOk added in v1.0.182 

func (o *CfdInstrument) GetExchangeOk() (*string, bool)

GetExchangeOk returns a tuple with the Exchange field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CfdInstrument) GetId added in v1.0.182 

func (o *CfdInstrument) GetId() string

GetId returns the Id field value

func (*CfdInstrument) GetIdOk added in v1.0.182 

func (o *CfdInstrument) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*CfdInstrument) GetKind added in v1.0.182 

func (o *CfdInstrument) GetKind() string

GetKind returns the Kind field value

func (*CfdInstrument) GetKindOk added in v1.0.182 

func (o *CfdInstrument) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value and a boolean to check if the value has been set.

func (*CfdInstrument) GetRawSymbol added in v1.0.182 

func (o *CfdInstrument) GetRawSymbol() string

GetRawSymbol returns the RawSymbol field value

func (*CfdInstrument) GetRawSymbolOk added in v1.0.182 

func (o *CfdInstrument) GetRawSymbolOk() (*string, bool)

GetRawSymbolOk returns a tuple with the RawSymbol field value and a boolean to check if the value has been set.

func (*CfdInstrument) GetSymbol added in v1.0.182 

func (o *CfdInstrument) GetSymbol() string

GetSymbol returns the Symbol field value

func (*CfdInstrument) GetSymbolOk added in v1.0.182 

func (o *CfdInstrument) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value and a boolean to check if the value has been set.

func (*CfdInstrument) GetUnderlyingInstrument added in v1.0.182 

func (o *CfdInstrument) GetUnderlyingInstrument() UnderlyingCfdInstrument

GetUnderlyingInstrument returns the UnderlyingInstrument field value

func (*CfdInstrument) GetUnderlyingInstrumentOk added in v1.0.182 

func (o *CfdInstrument) GetUnderlyingInstrumentOk() (*UnderlyingCfdInstrument, bool)

GetUnderlyingInstrumentOk returns a tuple with the UnderlyingInstrument field value and a boolean to check if the value has been set.

func (*CfdInstrument) HasCurrency added in v1.0.182 

func (o *CfdInstrument) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*CfdInstrument) HasDescription added in v1.0.182 

func (o *CfdInstrument) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CfdInstrument) HasExchange added in v1.0.182 

func (o *CfdInstrument) HasExchange() bool

HasExchange returns a boolean if a field has been set.

func (CfdInstrument) MarshalJSON added in v1.0.182 

func (o CfdInstrument) MarshalJSON() ([]byte, error)

func (*CfdInstrument) SetCurrency added in v1.0.182 

func (o *CfdInstrument) SetCurrency(v string)

SetCurrency gets a reference to the given NullableString and assigns it to the Currency field.

func (*CfdInstrument) SetCurrencyNil added in v1.0.182 

func (o *CfdInstrument) SetCurrencyNil()

SetCurrencyNil sets the value for Currency to be an explicit nil

func (*CfdInstrument) SetDescription added in v1.0.182 

func (o *CfdInstrument) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CfdInstrument) SetDescriptionNil added in v1.0.182 

func (o *CfdInstrument) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CfdInstrument) SetExchange added in v1.0.182 

func (o *CfdInstrument) SetExchange(v string)

SetExchange gets a reference to the given NullableString and assigns it to the Exchange field.

func (*CfdInstrument) SetExchangeNil added in v1.0.182 

func (o *CfdInstrument) SetExchangeNil()

SetExchangeNil sets the value for Exchange to be an explicit nil

func (*CfdInstrument) SetId added in v1.0.182 

func (o *CfdInstrument) SetId(v string)

SetId sets field value

func (*CfdInstrument) SetKind added in v1.0.182 

func (o *CfdInstrument) SetKind(v string)

SetKind sets field value

func (*CfdInstrument) SetRawSymbol added in v1.0.182 

func (o *CfdInstrument) SetRawSymbol(v string)

SetRawSymbol sets field value

func (*CfdInstrument) SetSymbol added in v1.0.182 

func (o *CfdInstrument) SetSymbol(v string)

SetSymbol sets field value

func (*CfdInstrument) SetUnderlyingInstrument added in v1.0.182 

func (o *CfdInstrument) SetUnderlyingInstrument(v UnderlyingCfdInstrument)

SetUnderlyingInstrument sets field value

func (*CfdInstrument) UnmarshalJSON added in v1.0.182 

func (o *CfdInstrument) UnmarshalJSON(bytes []byte) (err error)

func (*CfdInstrument) UnsetCurrency added in v1.0.182 

func (o *CfdInstrument) UnsetCurrency()

UnsetCurrency ensures that no value is present for Currency, not even an explicit nil

func (*CfdInstrument) UnsetDescription added in v1.0.182 

func (o *CfdInstrument) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*CfdInstrument) UnsetExchange added in v1.0.182 

func (o *CfdInstrument) UnsetExchange()

UnsetExchange ensures that no value is present for Exchange, not even an explicit nil

type ChildBrokerageOrderIDs added in v1.0.55 

type ChildBrokerageOrderIDs struct {
	// The brokerage order ID for the take profit leg of the bracket order
	TakeProfitOrderId *string `json:"take_profit_order_id,omitempty"`
	// The brokerage order ID for the stop loss leg of the bracket order
	StopLossOrderId      *string `json:"stop_loss_order_id,omitempty"`
	AdditionalProperties map[string]interface{}
}

ChildBrokerageOrderIDs struct for ChildBrokerageOrderIDs

func NewChildBrokerageOrderIDs added in v1.0.55 

func NewChildBrokerageOrderIDs() *ChildBrokerageOrderIDs

NewChildBrokerageOrderIDs instantiates a new ChildBrokerageOrderIDs 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

func NewChildBrokerageOrderIDsWithDefaults added in v1.0.55 

func NewChildBrokerageOrderIDsWithDefaults() *ChildBrokerageOrderIDs

NewChildBrokerageOrderIDsWithDefaults instantiates a new ChildBrokerageOrderIDs 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

func (*ChildBrokerageOrderIDs) GetStopLossOrderId added in v1.0.55 

func (o *ChildBrokerageOrderIDs) GetStopLossOrderId() string

GetStopLossOrderId returns the StopLossOrderId field value if set, zero value otherwise.

func (*ChildBrokerageOrderIDs) GetStopLossOrderIdOk added in v1.0.55 

func (o *ChildBrokerageOrderIDs) GetStopLossOrderIdOk() (*string, bool)

GetStopLossOrderIdOk returns a tuple with the StopLossOrderId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ChildBrokerageOrderIDs) GetTakeProfitOrderId added in v1.0.55 

func (o *ChildBrokerageOrderIDs) GetTakeProfitOrderId() string

GetTakeProfitOrderId returns the TakeProfitOrderId field value if set, zero value otherwise.

func (*ChildBrokerageOrderIDs) GetTakeProfitOrderIdOk added in v1.0.55 

func (o *ChildBrokerageOrderIDs) GetTakeProfitOrderIdOk() (*string, bool)

GetTakeProfitOrderIdOk returns a tuple with the TakeProfitOrderId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ChildBrokerageOrderIDs) HasStopLossOrderId added in v1.0.55 

func (o *ChildBrokerageOrderIDs) HasStopLossOrderId() bool

HasStopLossOrderId returns a boolean if a field has been set.

func (*ChildBrokerageOrderIDs) HasTakeProfitOrderId added in v1.0.55 

func (o *ChildBrokerageOrderIDs) HasTakeProfitOrderId() bool

HasTakeProfitOrderId returns a boolean if a field has been set.

func (ChildBrokerageOrderIDs) MarshalJSON added in v1.0.55 

func (o ChildBrokerageOrderIDs) MarshalJSON() ([]byte, error)

func (*ChildBrokerageOrderIDs) SetStopLossOrderId added in v1.0.55 

func (o *ChildBrokerageOrderIDs) SetStopLossOrderId(v string)

SetStopLossOrderId gets a reference to the given string and assigns it to the StopLossOrderId field.

func (*ChildBrokerageOrderIDs) SetTakeProfitOrderId added in v1.0.55 

func (o *ChildBrokerageOrderIDs) SetTakeProfitOrderId(v string)

SetTakeProfitOrderId gets a reference to the given string and assigns it to the TakeProfitOrderId field.

func (*ChildBrokerageOrderIDs) UnmarshalJSON added in v1.0.55 

func (o *ChildBrokerageOrderIDs) UnmarshalJSON(bytes []byte) (err error)

type ChildBrokerageOrderIDsNullable added in v1.1.0 

type ChildBrokerageOrderIDsNullable struct {
	// The brokerage order ID for the take profit leg of the bracket order
	TakeProfitOrderId *string `json:"take_profit_order_id,omitempty"`
	// The brokerage order ID for the stop loss leg of the bracket order
	StopLossOrderId      *string `json:"stop_loss_order_id,omitempty"`
	AdditionalProperties map[string]interface{}
}

ChildBrokerageOrderIDsNullable struct for ChildBrokerageOrderIDsNullable

func NewChildBrokerageOrderIDsNullable added in v1.1.0 

func NewChildBrokerageOrderIDsNullable() *ChildBrokerageOrderIDsNullable

NewChildBrokerageOrderIDsNullable instantiates a new ChildBrokerageOrderIDsNullable 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

func NewChildBrokerageOrderIDsNullableWithDefaults added in v1.1.0 

func NewChildBrokerageOrderIDsNullableWithDefaults() *ChildBrokerageOrderIDsNullable

NewChildBrokerageOrderIDsNullableWithDefaults instantiates a new ChildBrokerageOrderIDsNullable 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

func (*ChildBrokerageOrderIDsNullable) GetStopLossOrderId added in v1.1.0 

func (o *ChildBrokerageOrderIDsNullable) GetStopLossOrderId() string

GetStopLossOrderId returns the StopLossOrderId field value if set, zero value otherwise.

func (*ChildBrokerageOrderIDsNullable) GetStopLossOrderIdOk added in v1.1.0 

func (o *ChildBrokerageOrderIDsNullable) GetStopLossOrderIdOk() (*string, bool)

GetStopLossOrderIdOk returns a tuple with the StopLossOrderId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ChildBrokerageOrderIDsNullable) GetTakeProfitOrderId added in v1.1.0 

func (o *ChildBrokerageOrderIDsNullable) GetTakeProfitOrderId() string

GetTakeProfitOrderId returns the TakeProfitOrderId field value if set, zero value otherwise.

func (*ChildBrokerageOrderIDsNullable) GetTakeProfitOrderIdOk added in v1.1.0 

func (o *ChildBrokerageOrderIDsNullable) GetTakeProfitOrderIdOk() (*string, bool)

GetTakeProfitOrderIdOk returns a tuple with the TakeProfitOrderId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ChildBrokerageOrderIDsNullable) HasStopLossOrderId added in v1.1.0 

func (o *ChildBrokerageOrderIDsNullable) HasStopLossOrderId() bool

HasStopLossOrderId returns a boolean if a field has been set.

func (*ChildBrokerageOrderIDsNullable) HasTakeProfitOrderId added in v1.1.0 

func (o *ChildBrokerageOrderIDsNullable) HasTakeProfitOrderId() bool

HasTakeProfitOrderId returns a boolean if a field has been set.

func (ChildBrokerageOrderIDsNullable) MarshalJSON added in v1.1.0 

func (o ChildBrokerageOrderIDsNullable) MarshalJSON() ([]byte, error)

func (*ChildBrokerageOrderIDsNullable) SetStopLossOrderId added in v1.1.0 

func (o *ChildBrokerageOrderIDsNullable) SetStopLossOrderId(v string)

SetStopLossOrderId gets a reference to the given string and assigns it to the StopLossOrderId field.

func (*ChildBrokerageOrderIDsNullable) SetTakeProfitOrderId added in v1.1.0 

func (o *ChildBrokerageOrderIDsNullable) SetTakeProfitOrderId(v string)

SetTakeProfitOrderId gets a reference to the given string and assigns it to the TakeProfitOrderId field.

func (*ChildBrokerageOrderIDsNullable) UnmarshalJSON added in v1.1.0 

func (o *ChildBrokerageOrderIDsNullable) UnmarshalJSON(bytes []byte) (err error)

type ComplexOrderLeg added in v1.0.157 

type ComplexOrderLeg struct {
	// The role of this leg within the complex order.
	OrderRole  string            `json:"order_role"`
	Action     ActionStrict      `json:"action"`
	Instrument TradingInstrument `json:"instrument"`
	OrderType  OrderTypeStrict   `json:"order_type"`
	// Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided.
	Units       float32           `json:"units"`
	TimeInForce TimeInForceStrict `json:"time_in_force"`
	// The limit price. Required when `order_type` is `Limit` or `StopLimit`.
	Price NullableFloat32 `json:"price,omitempty"`
	// The stop trigger price. Required when `order_type` is `Stop` or `StopLimit`.
	Stop                 NullableFloat32 `json:"stop,omitempty"`
	AdditionalProperties map[string]interface{}
}

ComplexOrderLeg A single leg within a complex order.

func NewComplexOrderLeg added in v1.0.157 

func NewComplexOrderLeg(orderRole string, action ActionStrict, instrument TradingInstrument, orderType OrderTypeStrict, units float32, timeInForce TimeInForceStrict) *ComplexOrderLeg

NewComplexOrderLeg instantiates a new ComplexOrderLeg 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

func NewComplexOrderLegWithDefaults added in v1.0.157 

func NewComplexOrderLegWithDefaults() *ComplexOrderLeg

NewComplexOrderLegWithDefaults instantiates a new ComplexOrderLeg 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

func (*ComplexOrderLeg) GetAction added in v1.0.157 

func (o *ComplexOrderLeg) GetAction() ActionStrict

GetAction returns the Action field value

func (*ComplexOrderLeg) GetActionOk added in v1.0.157 

func (o *ComplexOrderLeg) GetActionOk() (*ActionStrict, bool)

GetActionOk returns a tuple with the Action field value and a boolean to check if the value has been set.

func (*ComplexOrderLeg) GetInstrument added in v1.0.157 

func (o *ComplexOrderLeg) GetInstrument() TradingInstrument

GetInstrument returns the Instrument field value

func (*ComplexOrderLeg) GetInstrumentOk added in v1.0.157 

func (o *ComplexOrderLeg) GetInstrumentOk() (*TradingInstrument, bool)

GetInstrumentOk returns a tuple with the Instrument field value and a boolean to check if the value has been set.

func (*ComplexOrderLeg) GetOrderRole added in v1.0.157 

func (o *ComplexOrderLeg) GetOrderRole() string

GetOrderRole returns the OrderRole field value

func (*ComplexOrderLeg) GetOrderRoleOk added in v1.0.157 

func (o *ComplexOrderLeg) GetOrderRoleOk() (*string, bool)

GetOrderRoleOk returns a tuple with the OrderRole field value and a boolean to check if the value has been set.

func (*ComplexOrderLeg) GetOrderType added in v1.0.157 

func (o *ComplexOrderLeg) GetOrderType() OrderTypeStrict

GetOrderType returns the OrderType field value

func (*ComplexOrderLeg) GetOrderTypeOk added in v1.0.157 

func (o *ComplexOrderLeg) GetOrderTypeOk() (*OrderTypeStrict, bool)

GetOrderTypeOk returns a tuple with the OrderType field value and a boolean to check if the value has been set.

func (*ComplexOrderLeg) GetPrice added in v1.0.157 

func (o *ComplexOrderLeg) GetPrice() float32

GetPrice returns the Price field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ComplexOrderLeg) GetPriceOk added in v1.0.157 

func (o *ComplexOrderLeg) GetPriceOk() (*float32, bool)

GetPriceOk returns a tuple with the Price field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ComplexOrderLeg) GetStop added in v1.0.157 

func (o *ComplexOrderLeg) GetStop() float32

GetStop returns the Stop field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ComplexOrderLeg) GetStopOk added in v1.0.157 

func (o *ComplexOrderLeg) GetStopOk() (*float32, bool)

GetStopOk returns a tuple with the Stop field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ComplexOrderLeg) GetTimeInForce added in v1.0.157 

func (o *ComplexOrderLeg) GetTimeInForce() TimeInForceStrict

GetTimeInForce returns the TimeInForce field value

func (*ComplexOrderLeg) GetTimeInForceOk added in v1.0.157 

func (o *ComplexOrderLeg) GetTimeInForceOk() (*TimeInForceStrict, bool)

GetTimeInForceOk returns a tuple with the TimeInForce field value and a boolean to check if the value has been set.

func (*ComplexOrderLeg) GetUnits added in v1.0.157 

func (o *ComplexOrderLeg) GetUnits() float32

GetUnits returns the Units field value

func (*ComplexOrderLeg) GetUnitsOk added in v1.0.157 

func (o *ComplexOrderLeg) GetUnitsOk() (*float32, bool)

GetUnitsOk returns a tuple with the Units field value and a boolean to check if the value has been set.

func (*ComplexOrderLeg) HasPrice added in v1.0.157 

func (o *ComplexOrderLeg) HasPrice() bool

HasPrice returns a boolean if a field has been set.

func (*ComplexOrderLeg) HasStop added in v1.0.157 

func (o *ComplexOrderLeg) HasStop() bool

HasStop returns a boolean if a field has been set.

func (ComplexOrderLeg) MarshalJSON added in v1.0.157 

func (o ComplexOrderLeg) MarshalJSON() ([]byte, error)

func (*ComplexOrderLeg) SetAction added in v1.0.157 

func (o *ComplexOrderLeg) SetAction(v ActionStrict)

SetAction sets field value

func (*ComplexOrderLeg) SetInstrument added in v1.0.157 

func (o *ComplexOrderLeg) SetInstrument(v TradingInstrument)

SetInstrument sets field value

func (*ComplexOrderLeg) SetOrderRole added in v1.0.157 

func (o *ComplexOrderLeg) SetOrderRole(v string)

SetOrderRole sets field value

func (*ComplexOrderLeg) SetOrderType added in v1.0.157 

func (o *ComplexOrderLeg) SetOrderType(v OrderTypeStrict)

SetOrderType sets field value

func (*ComplexOrderLeg) SetPrice added in v1.0.157 

func (o *ComplexOrderLeg) SetPrice(v float32)

SetPrice gets a reference to the given NullableFloat32 and assigns it to the Price field.

func (*ComplexOrderLeg) SetPriceNil added in v1.0.157 

func (o *ComplexOrderLeg) SetPriceNil()

SetPriceNil sets the value for Price to be an explicit nil

func (*ComplexOrderLeg) SetStop added in v1.0.157 

func (o *ComplexOrderLeg) SetStop(v float32)

SetStop gets a reference to the given NullableFloat32 and assigns it to the Stop field.

func (*ComplexOrderLeg) SetStopNil added in v1.0.157 

func (o *ComplexOrderLeg) SetStopNil()

SetStopNil sets the value for Stop to be an explicit nil

func (*ComplexOrderLeg) SetTimeInForce added in v1.0.157 

func (o *ComplexOrderLeg) SetTimeInForce(v TimeInForceStrict)

SetTimeInForce sets field value

func (*ComplexOrderLeg) SetUnits added in v1.0.157 

func (o *ComplexOrderLeg) SetUnits(v float32)

SetUnits sets field value

func (*ComplexOrderLeg) UnmarshalJSON added in v1.0.157 

func (o *ComplexOrderLeg) UnmarshalJSON(bytes []byte) (err error)

func (*ComplexOrderLeg) UnsetPrice added in v1.0.157 

func (o *ComplexOrderLeg) UnsetPrice()

UnsetPrice ensures that no value is present for Price, not even an explicit nil

func (*ComplexOrderLeg) UnsetStop added in v1.0.157 

func (o *ComplexOrderLeg) UnsetStop()

UnsetStop ensures that no value is present for Stop, not even an explicit nil

type ComplexOrderResponse added in v1.0.157 

type ComplexOrderResponse struct {
	// The complex order type that was placed.
	Type *string `json:"type,omitempty"`
	// The brokerage-assigned identifier that links all legs of this complex order together. Each leg will eventually appear as a separate AccountOrderRecord sharing this value. May be null if the brokerage does not return a group identifier.
	BrokerageGroupOrderId NullableString `json:"brokerage_group_order_id,omitempty"`
	AdditionalProperties  map[string]interface{}
}

ComplexOrderResponse Response returned after successfully placing a complex order. AccountOrderRecord rows for the legs are not created synchronously — they're hydrated by the next brokerage sync, and can be queried later using the returned `brokerage_group_order_id`.

func NewComplexOrderResponse added in v1.0.157 

func NewComplexOrderResponse() *ComplexOrderResponse

NewComplexOrderResponse instantiates a new ComplexOrderResponse 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

func NewComplexOrderResponseWithDefaults added in v1.0.157 

func NewComplexOrderResponseWithDefaults() *ComplexOrderResponse

NewComplexOrderResponseWithDefaults instantiates a new ComplexOrderResponse 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

func (*ComplexOrderResponse) GetBrokerageGroupOrderId added in v1.0.157 

func (o *ComplexOrderResponse) GetBrokerageGroupOrderId() string

GetBrokerageGroupOrderId returns the BrokerageGroupOrderId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ComplexOrderResponse) GetBrokerageGroupOrderIdOk added in v1.0.157 

func (o *ComplexOrderResponse) GetBrokerageGroupOrderIdOk() (*string, bool)

GetBrokerageGroupOrderIdOk returns a tuple with the BrokerageGroupOrderId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ComplexOrderResponse) GetType added in v1.0.157 

func (o *ComplexOrderResponse) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*ComplexOrderResponse) GetTypeOk added in v1.0.157 

func (o *ComplexOrderResponse) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ComplexOrderResponse) HasBrokerageGroupOrderId added in v1.0.157 

func (o *ComplexOrderResponse) HasBrokerageGroupOrderId() bool

HasBrokerageGroupOrderId returns a boolean if a field has been set.

func (*ComplexOrderResponse) HasType added in v1.0.157 

func (o *ComplexOrderResponse) HasType() bool

HasType returns a boolean if a field has been set.

func (ComplexOrderResponse) MarshalJSON added in v1.0.157 

func (o ComplexOrderResponse) MarshalJSON() ([]byte, error)

func (*ComplexOrderResponse) SetBrokerageGroupOrderId added in v1.0.157 

func (o *ComplexOrderResponse) SetBrokerageGroupOrderId(v string)

SetBrokerageGroupOrderId gets a reference to the given NullableString and assigns it to the BrokerageGroupOrderId field.

func (*ComplexOrderResponse) SetBrokerageGroupOrderIdNil added in v1.0.157 

func (o *ComplexOrderResponse) SetBrokerageGroupOrderIdNil()

SetBrokerageGroupOrderIdNil sets the value for BrokerageGroupOrderId to be an explicit nil

func (*ComplexOrderResponse) SetType added in v1.0.157 

func (o *ComplexOrderResponse) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (*ComplexOrderResponse) UnmarshalJSON added in v1.0.157 

func (o *ComplexOrderResponse) UnmarshalJSON(bytes []byte) (err error)

func (*ComplexOrderResponse) UnsetBrokerageGroupOrderId added in v1.0.157 

func (o *ComplexOrderResponse) UnsetBrokerageGroupOrderId()

UnsetBrokerageGroupOrderId ensures that no value is present for BrokerageGroupOrderId, not even an explicit nil

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	TokenUrl         string            `json:"tokenUrl,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
	Context          context.Context
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddAPIKey 

func (c *Configuration) AddAPIKey(key string, apiKey APIKey)

Configures an API key on Configuration. Ensures multiple calls does not delete other keys

1. Get the existing map of API keys from the context. 2. If there's no existing map, create a new map. 3. Update the "[API key]"" in the map. 4. Store the updated map back in the context.

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

func (*Configuration) SetConsumerKey 

func (c *Configuration) SetConsumerKey(ConsumerKey string)

func (*Configuration) SetHost 

func (c *Configuration) SetHost(host string)

func (*Configuration) SetOAuthClientCredentials 

func (c *Configuration) SetOAuthClientCredentials(clientId string, clientSecret string)

Setup OAuth Client Credentials Flow for all requests

func (*Configuration) SetPartnerClientId 

func (c *Configuration) SetPartnerClientId(partnerClientId string)

func (*Configuration) SetPartnerSignature 

func (c *Configuration) SetPartnerSignature(partnerSignature string)

func (*Configuration) SetPartnerTimestamp 

func (c *Configuration) SetPartnerTimestamp(partnerTimestamp string)

func (*Configuration) SetTokenUrl 

func (c *Configuration) SetTokenUrl(tokenUrl string)

type ConnectionAccount added in v1.1.0 

type ConnectionAccount struct {
	InvestmentAccount *InvestmentAccount
}

ConnectionAccount - A single account under a connection, from the `kind`-discriminated union used by `Connections_listConnectionAccounts`. Use `kind` to determine which schema is present. Only `investment` is implemented today; `deposit` and `line_of_credit` will be added as additional variants in a future release.

func InvestmentAccountAsConnectionAccount added in v1.1.0 

func InvestmentAccountAsConnectionAccount(v *InvestmentAccount) ConnectionAccount

InvestmentAccountAsConnectionAccount is a convenience function that returns InvestmentAccount wrapped in ConnectionAccount

func (*ConnectionAccount) GetActualInstance added in v1.1.0 

func (obj *ConnectionAccount) GetActualInstance() interface{}

Get the actual instance

func (ConnectionAccount) MarshalJSON added in v1.1.0 

func (src ConnectionAccount) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*ConnectionAccount) UnmarshalJSON added in v1.1.0 

func (dst *ConnectionAccount) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

type ConnectionAccountSyncStatus added in v1.1.0 

type ConnectionAccountSyncStatus struct {
	Transactions *TransactionsStatus `json:"transactions,omitempty"`
	// Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
	Orders NullableTime `json:"orders,omitempty"`
	// Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
	Positions NullableTime `json:"positions,omitempty"`
	// Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
	Balances             NullableTime `json:"balances,omitempty"`
	AdditionalProperties map[string]interface{}
}

ConnectionAccountSyncStatus Contains status updates for the account sync process between SnapTrade and the brokerage, used only by `Connections_listConnectionAccounts`. Each property is optional -- a brokerage may not report sync status for every data type. `orders`/`positions`/`balances` are the timestamp of the last successful sync of that data type (null if never synced).

func NewConnectionAccountSyncStatus added in v1.1.0 

func NewConnectionAccountSyncStatus() *ConnectionAccountSyncStatus

NewConnectionAccountSyncStatus instantiates a new ConnectionAccountSyncStatus 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

func NewConnectionAccountSyncStatusWithDefaults added in v1.1.0 

func NewConnectionAccountSyncStatusWithDefaults() *ConnectionAccountSyncStatus

NewConnectionAccountSyncStatusWithDefaults instantiates a new ConnectionAccountSyncStatus 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

func (*ConnectionAccountSyncStatus) GetBalances added in v1.1.0 

func (o *ConnectionAccountSyncStatus) GetBalances() time.Time

GetBalances returns the Balances field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ConnectionAccountSyncStatus) GetBalancesOk added in v1.1.0 

func (o *ConnectionAccountSyncStatus) GetBalancesOk() (*time.Time, bool)

GetBalancesOk returns a tuple with the Balances field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ConnectionAccountSyncStatus) GetOrders added in v1.1.0 

func (o *ConnectionAccountSyncStatus) GetOrders() time.Time

GetOrders returns the Orders field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ConnectionAccountSyncStatus) GetOrdersOk added in v1.1.0 

func (o *ConnectionAccountSyncStatus) GetOrdersOk() (*time.Time, bool)

GetOrdersOk returns a tuple with the Orders field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ConnectionAccountSyncStatus) GetPositions added in v1.1.0 

func (o *ConnectionAccountSyncStatus) GetPositions() time.Time

GetPositions returns the Positions field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ConnectionAccountSyncStatus) GetPositionsOk added in v1.1.0 

func (o *ConnectionAccountSyncStatus) GetPositionsOk() (*time.Time, bool)

GetPositionsOk returns a tuple with the Positions field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ConnectionAccountSyncStatus) GetTransactions added in v1.1.0 

func (o *ConnectionAccountSyncStatus) GetTransactions() TransactionsStatus

GetTransactions returns the Transactions field value if set, zero value otherwise.

func (*ConnectionAccountSyncStatus) GetTransactionsOk added in v1.1.0 

func (o *ConnectionAccountSyncStatus) GetTransactionsOk() (*TransactionsStatus, bool)

GetTransactionsOk returns a tuple with the Transactions field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ConnectionAccountSyncStatus) HasBalances added in v1.1.0 

func (o *ConnectionAccountSyncStatus) HasBalances() bool

HasBalances returns a boolean if a field has been set.

func (*ConnectionAccountSyncStatus) HasOrders added in v1.1.0 

func (o *ConnectionAccountSyncStatus) HasOrders() bool

HasOrders returns a boolean if a field has been set.

func (*ConnectionAccountSyncStatus) HasPositions added in v1.1.0 

func (o *ConnectionAccountSyncStatus) HasPositions() bool

HasPositions returns a boolean if a field has been set.

func (*ConnectionAccountSyncStatus) HasTransactions added in v1.1.0 

func (o *ConnectionAccountSyncStatus) HasTransactions() bool

HasTransactions returns a boolean if a field has been set.

func (ConnectionAccountSyncStatus) MarshalJSON added in v1.1.0 

func (o ConnectionAccountSyncStatus) MarshalJSON() ([]byte, error)

func (*ConnectionAccountSyncStatus) SetBalances added in v1.1.0 

func (o *ConnectionAccountSyncStatus) SetBalances(v time.Time)

SetBalances gets a reference to the given NullableTime and assigns it to the Balances field.

func (*ConnectionAccountSyncStatus) SetBalancesNil added in v1.1.0 

func (o *ConnectionAccountSyncStatus) SetBalancesNil()

SetBalancesNil sets the value for Balances to be an explicit nil

func (*ConnectionAccountSyncStatus) SetOrders added in v1.1.0 

func (o *ConnectionAccountSyncStatus) SetOrders(v time.Time)

SetOrders gets a reference to the given NullableTime and assigns it to the Orders field.

func (*ConnectionAccountSyncStatus) SetOrdersNil added in v1.1.0 

func (o *ConnectionAccountSyncStatus) SetOrdersNil()

SetOrdersNil sets the value for Orders to be an explicit nil

func (*ConnectionAccountSyncStatus) SetPositions added in v1.1.0 

func (o *ConnectionAccountSyncStatus) SetPositions(v time.Time)

SetPositions gets a reference to the given NullableTime and assigns it to the Positions field.

func (*ConnectionAccountSyncStatus) SetPositionsNil added in v1.1.0 

func (o *ConnectionAccountSyncStatus) SetPositionsNil()

SetPositionsNil sets the value for Positions to be an explicit nil

func (*ConnectionAccountSyncStatus) SetTransactions added in v1.1.0 

func (o *ConnectionAccountSyncStatus) SetTransactions(v TransactionsStatus)

SetTransactions gets a reference to the given TransactionsStatus and assigns it to the Transactions field.

func (*ConnectionAccountSyncStatus) UnmarshalJSON added in v1.1.0 

func (o *ConnectionAccountSyncStatus) UnmarshalJSON(bytes []byte) (err error)

func (*ConnectionAccountSyncStatus) UnsetBalances added in v1.1.0 

func (o *ConnectionAccountSyncStatus) UnsetBalances()

UnsetBalances ensures that no value is present for Balances, not even an explicit nil

func (*ConnectionAccountSyncStatus) UnsetOrders added in v1.1.0 

func (o *ConnectionAccountSyncStatus) UnsetOrders()

UnsetOrders ensures that no value is present for Orders, not even an explicit nil

func (*ConnectionAccountSyncStatus) UnsetPositions added in v1.1.0 

func (o *ConnectionAccountSyncStatus) UnsetPositions()

UnsetPositions ensures that no value is present for Positions, not even an explicit nil

type ConnectionsApiDeleteConnectionRequest added in v1.0.138 

type ConnectionsApiDeleteConnectionRequest struct {
	ApiService *ConnectionsApiService
	// contains filtered or unexported fields
}

func (ConnectionsApiDeleteConnectionRequest) Execute added in v1.0.138 

func (r ConnectionsApiDeleteConnectionRequest) Execute() (*DeleteConnectionConfirmation, *http.Response, error)

type ConnectionsApiDetailBrokerageAuthorizationRequest 

type ConnectionsApiDetailBrokerageAuthorizationRequest struct {
	ApiService *ConnectionsApiService
	// contains filtered or unexported fields
}

func (ConnectionsApiDetailBrokerageAuthorizationRequest) Execute 

func (r ConnectionsApiDetailBrokerageAuthorizationRequest) Execute() (*BrokerageAuthorization, *http.Response, error)

type ConnectionsApiDisableBrokerageAuthorizationRequest 

type ConnectionsApiDisableBrokerageAuthorizationRequest struct {
	ApiService *ConnectionsApiService
	// contains filtered or unexported fields
}

func (ConnectionsApiDisableBrokerageAuthorizationRequest) Execute 

func (r ConnectionsApiDisableBrokerageAuthorizationRequest) Execute() (*BrokerageAuthorizationDisabledConfirmation, *http.Response, error)

type ConnectionsApiListBrokerageAuthorizationAccountsRequest added in v1.0.161 

type ConnectionsApiListBrokerageAuthorizationAccountsRequest struct {
	ApiService *ConnectionsApiService
	// contains filtered or unexported fields
}

func (ConnectionsApiListBrokerageAuthorizationAccountsRequest) Execute added in v1.0.161 

func (r ConnectionsApiListBrokerageAuthorizationAccountsRequest) Execute() ([]Account, *http.Response, error)

type ConnectionsApiListBrokerageAuthorizationsRequest 

type ConnectionsApiListBrokerageAuthorizationsRequest struct {
	ApiService *ConnectionsApiService
	// contains filtered or unexported fields
}

func (ConnectionsApiListBrokerageAuthorizationsRequest) Execute 

func (r ConnectionsApiListBrokerageAuthorizationsRequest) Execute() ([]BrokerageAuthorization, *http.Response, error)

type ConnectionsApiRefreshBrokerageAuthorizationRequest 

type ConnectionsApiRefreshBrokerageAuthorizationRequest struct {
	ApiService *ConnectionsApiService
	// contains filtered or unexported fields
}

func (ConnectionsApiRefreshBrokerageAuthorizationRequest) Execute 

func (r ConnectionsApiRefreshBrokerageAuthorizationRequest) Execute() (*BrokerageAuthorizationRefreshConfirmation, *http.Response, error)

type ConnectionsApiRemoveBrokerageAuthorizationRequest 

type ConnectionsApiRemoveBrokerageAuthorizationRequest struct {
	ApiService *ConnectionsApiService
	// contains filtered or unexported fields
}

func (ConnectionsApiRemoveBrokerageAuthorizationRequest) Execute 

func (r ConnectionsApiRemoveBrokerageAuthorizationRequest) Execute() (*http.Response, error)

type ConnectionsApiReturnRatesRequest added in v1.0.27 

type ConnectionsApiReturnRatesRequest struct {
	ApiService *ConnectionsApiService
	// contains filtered or unexported fields
}

func (ConnectionsApiReturnRatesRequest) Execute added in v1.0.27 

func (r ConnectionsApiReturnRatesRequest) Execute() (*RateOfReturnResponse, *http.Response, error)

func (*ConnectionsApiReturnRatesRequest) Timeframes added in v1.0.153 

func (r *ConnectionsApiReturnRatesRequest) Timeframes(timeframes string) *ConnectionsApiReturnRatesRequest

Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.

type ConnectionsApiService 

type ConnectionsApiService service

ConnectionsApiService ConnectionsApi service

func (*ConnectionsApiService) DeleteConnection added in v1.0.138 

func (a *ConnectionsApiService) DeleteConnection(connectionId string, userId string, userSecret string) ConnectionsApiDeleteConnectionRequest

DeleteConnection Delete connection

Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param connectionId
@param userId
@param userSecret
@return ConnectionsApiDeleteConnectionRequest

func (*ConnectionsApiService) DeleteConnectionExecute added in v1.0.138 

func (a *ConnectionsApiService) DeleteConnectionExecute(r ConnectionsApiDeleteConnectionRequest) (*DeleteConnectionConfirmation, *http.Response, error)

Execute executes the request 

@return DeleteConnectionConfirmation

func (*ConnectionsApiService) DetailBrokerageAuthorization 

func (a *ConnectionsApiService) DetailBrokerageAuthorization(authorizationId string, userId string, userSecret string) ConnectionsApiDetailBrokerageAuthorizationRequest

DetailBrokerageAuthorization Get connection detail

Returns a single connection for the specified ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param authorizationId
@param userId
@param userSecret
@return ConnectionsApiDetailBrokerageAuthorizationRequest

func (*ConnectionsApiService) DetailBrokerageAuthorizationExecute 

func (a *ConnectionsApiService) DetailBrokerageAuthorizationExecute(r ConnectionsApiDetailBrokerageAuthorizationRequest) (*BrokerageAuthorization, *http.Response, error)

Execute executes the request 

@return BrokerageAuthorization

func (*ConnectionsApiService) DisableBrokerageAuthorization 

func (a *ConnectionsApiService) DisableBrokerageAuthorization(authorizationId string, userId string, userSecret string) ConnectionsApiDisableBrokerageAuthorizationRequest

DisableBrokerageAuthorization Force disable connection

Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.

This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param authorizationId
@param userId
@param userSecret
@return ConnectionsApiDisableBrokerageAuthorizationRequest

func (*ConnectionsApiService) DisableBrokerageAuthorizationExecute 

func (a *ConnectionsApiService) DisableBrokerageAuthorizationExecute(r ConnectionsApiDisableBrokerageAuthorizationRequest) (*BrokerageAuthorizationDisabledConfirmation, *http.Response, error)

Execute executes the request 

@return BrokerageAuthorizationDisabledConfirmation

func (*ConnectionsApiService) ListBrokerageAuthorizationAccounts added in v1.0.161 

func (a *ConnectionsApiService) ListBrokerageAuthorizationAccounts(authorizationId string, userId string, userSecret string) ConnectionsApiListBrokerageAuthorizationAccountsRequest

ListBrokerageAuthorizationAccounts List accounts for a connection

Returns all brokerage accounts that belong to the specified connection for the authenticated user.

On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and total value live from the brokerage on each call.

On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param authorizationId
@param userId
@param userSecret
@return ConnectionsApiListBrokerageAuthorizationAccountsRequest

func (*ConnectionsApiService) ListBrokerageAuthorizationAccountsExecute added in v1.0.161 

func (a *ConnectionsApiService) ListBrokerageAuthorizationAccountsExecute(r ConnectionsApiListBrokerageAuthorizationAccountsRequest) ([]Account, *http.Response, error)

Execute executes the request 

@return []Account

func (*ConnectionsApiService) ListBrokerageAuthorizations 

func (a *ConnectionsApiService) ListBrokerageAuthorizations(userId string, userSecret string) ConnectionsApiListBrokerageAuthorizationsRequest

ListBrokerageAuthorizations List all connections

Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.

A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.

SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@return ConnectionsApiListBrokerageAuthorizationsRequest

func (*ConnectionsApiService) ListBrokerageAuthorizationsExecute 

func (a *ConnectionsApiService) ListBrokerageAuthorizationsExecute(r ConnectionsApiListBrokerageAuthorizationsRequest) ([]BrokerageAuthorization, *http.Response, error)

Execute executes the request 

@return []BrokerageAuthorization

func (*ConnectionsApiService) RefreshBrokerageAuthorization 

func (a *ConnectionsApiService) RefreshBrokerageAuthorization(authorizationId string, userId string, userSecret string) ConnectionsApiRefreshBrokerageAuthorizationRequest

RefreshBrokerageAuthorization Refresh holdings for a connection

Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.

**Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless the connection is delayed. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to the `data_freshness_mode` field on a connection to determine this.** 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param authorizationId
@param userId
@param userSecret
@return ConnectionsApiRefreshBrokerageAuthorizationRequest

func (*ConnectionsApiService) RefreshBrokerageAuthorizationExecute 

func (a *ConnectionsApiService) RefreshBrokerageAuthorizationExecute(r ConnectionsApiRefreshBrokerageAuthorizationRequest) (*BrokerageAuthorizationRefreshConfirmation, *http.Response, error)

Execute executes the request 

@return BrokerageAuthorizationRefreshConfirmation

func (*ConnectionsApiService) RemoveBrokerageAuthorization 

func (a *ConnectionsApiService) RemoveBrokerageAuthorization(authorizationId string, userId string, userSecret string) ConnectionsApiRemoveBrokerageAuthorizationRequest

RemoveBrokerageAuthorization Delete connection

Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param authorizationId
@param userId
@param userSecret
@return ConnectionsApiRemoveBrokerageAuthorizationRequest

func (*ConnectionsApiService) RemoveBrokerageAuthorizationExecute 

func (a *ConnectionsApiService) RemoveBrokerageAuthorizationExecute(r ConnectionsApiRemoveBrokerageAuthorizationRequest) (*http.Response, error)

Execute executes the request

func (*ConnectionsApiService) ReturnRates added in v1.0.27 

func (a *ConnectionsApiService) ReturnRates(userId string, userSecret string, authorizationId string) ConnectionsApiReturnRatesRequest

ReturnRates List connection rate of returns

Returns a list of rate of return percents for a given connection. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param authorizationId
@return ConnectionsApiReturnRatesRequest

func (*ConnectionsApiService) ReturnRatesExecute added in v1.0.27 

func (a *ConnectionsApiService) ReturnRatesExecute(r ConnectionsApiReturnRatesRequest) (*RateOfReturnResponse, *http.Response, error)

Execute executes the request 

@return RateOfReturnResponse

func (*ConnectionsApiService) SessionEvents 

func (a *ConnectionsApiService) SessionEvents(partnerClientId string) ConnectionsApiSessionEventsRequest

SessionEvents Get all session events for a user

Returns a list of session events associated with a user. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param partnerClientId
@return ConnectionsApiSessionEventsRequest

func (*ConnectionsApiService) SessionEventsExecute 

func (a *ConnectionsApiService) SessionEventsExecute(r ConnectionsApiSessionEventsRequest) ([]SessionEvent, *http.Response, error)

Execute executes the request 

@return []SessionEvent

func (*ConnectionsApiService) SyncBrokerageAuthorizationTransactions added in v1.0.170 

func (a *ConnectionsApiService) SyncBrokerageAuthorizationTransactions(authorizationId string, userId string, userSecret string) ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest

SyncBrokerageAuthorizationTransactions Sync transactions for a connection

Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param authorizationId
@param userId
@param userSecret
@return ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest

func (*ConnectionsApiService) SyncBrokerageAuthorizationTransactionsExecute added in v1.0.170 

func (a *ConnectionsApiService) SyncBrokerageAuthorizationTransactionsExecute(r ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest) (*BrokerageAuthorizationTransactionsSyncConfirmation, *http.Response, error)

Execute executes the request 

@return BrokerageAuthorizationTransactionsSyncConfirmation

type ConnectionsApiSessionEventsRequest 

type ConnectionsApiSessionEventsRequest struct {
	ApiService *ConnectionsApiService
	// contains filtered or unexported fields
}

func (ConnectionsApiSessionEventsRequest) Execute 

func (r ConnectionsApiSessionEventsRequest) Execute() ([]SessionEvent, *http.Response, error)

func (*ConnectionsApiSessionEventsRequest) SessionId 

func (r *ConnectionsApiSessionEventsRequest) SessionId(sessionId string) *ConnectionsApiSessionEventsRequest

Optional comma separated list of session IDs used to filter the request on specific users

func (*ConnectionsApiSessionEventsRequest) UserId 

func (r *ConnectionsApiSessionEventsRequest) UserId(userId string) *ConnectionsApiSessionEventsRequest

Optional comma separated list of user IDs used to filter the request on specific users

type ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest added in v1.0.170 

type ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest struct {
	ApiService *ConnectionsApiService
	// contains filtered or unexported fields
}

func (ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest) Execute added in v1.0.170 

func (r ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest) Execute() (*BrokerageAuthorizationTransactionsSyncConfirmation, *http.Response, error)

type CryptoInstrument added in v1.0.158 

type CryptoInstrument struct {
	// Type of security instrument.
	Kind string `json:"kind"`
	// Unique identifier for the instrument.
	Id string `json:"id"`
	// The formatted trading symbol for the security.
	Symbol string `json:"symbol"`
	// The raw symbol without any exchange suffix.
	RawSymbol string `json:"raw_symbol"`
	// Human-readable description of the security.
	Description NullableString `json:"description,omitempty"`
	// ISO-4217 currency code for the security listing.
	Currency NullableString `json:"currency,omitempty"`
	// Exchange MIC code or exchange code for the security.
	Exchange             NullableString                 `json:"exchange,omitempty"`
	FigiInstrument       NullableFigiInstrumentNullable `json:"figi_instrument,omitempty"`
	AdditionalProperties map[string]interface{}
}

CryptoInstrument Security instrument metadata for crypto positions.

func NewCryptoInstrument added in v1.0.158 

func NewCryptoInstrument(kind string, id string, symbol string, rawSymbol string) *CryptoInstrument

NewCryptoInstrument instantiates a new CryptoInstrument 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

func NewCryptoInstrumentWithDefaults added in v1.0.158 

func NewCryptoInstrumentWithDefaults() *CryptoInstrument

NewCryptoInstrumentWithDefaults instantiates a new CryptoInstrument 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

func (*CryptoInstrument) GetCurrency added in v1.0.158 

func (o *CryptoInstrument) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CryptoInstrument) GetCurrencyOk added in v1.0.158 

func (o *CryptoInstrument) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CryptoInstrument) GetDescription added in v1.0.158 

func (o *CryptoInstrument) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CryptoInstrument) GetDescriptionOk added in v1.0.158 

func (o *CryptoInstrument) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CryptoInstrument) GetExchange added in v1.0.158 

func (o *CryptoInstrument) GetExchange() string

GetExchange returns the Exchange field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CryptoInstrument) GetExchangeOk added in v1.0.158 

func (o *CryptoInstrument) GetExchangeOk() (*string, bool)

GetExchangeOk returns a tuple with the Exchange field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CryptoInstrument) GetFigiInstrument added in v1.0.158 

func (o *CryptoInstrument) GetFigiInstrument() FigiInstrumentNullable

GetFigiInstrument returns the FigiInstrument field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CryptoInstrument) GetFigiInstrumentOk added in v1.0.158 

func (o *CryptoInstrument) GetFigiInstrumentOk() (*FigiInstrumentNullable, bool)

GetFigiInstrumentOk returns a tuple with the FigiInstrument field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CryptoInstrument) GetId added in v1.0.158 

func (o *CryptoInstrument) GetId() string

GetId returns the Id field value

func (*CryptoInstrument) GetIdOk added in v1.0.158 

func (o *CryptoInstrument) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*CryptoInstrument) GetKind added in v1.0.158 

func (o *CryptoInstrument) GetKind() string

GetKind returns the Kind field value

func (*CryptoInstrument) GetKindOk added in v1.0.158 

func (o *CryptoInstrument) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value and a boolean to check if the value has been set.

func (*CryptoInstrument) GetRawSymbol added in v1.0.158 

func (o *CryptoInstrument) GetRawSymbol() string

GetRawSymbol returns the RawSymbol field value

func (*CryptoInstrument) GetRawSymbolOk added in v1.0.158 

func (o *CryptoInstrument) GetRawSymbolOk() (*string, bool)

GetRawSymbolOk returns a tuple with the RawSymbol field value and a boolean to check if the value has been set.

func (*CryptoInstrument) GetSymbol added in v1.0.158 

func (o *CryptoInstrument) GetSymbol() string

GetSymbol returns the Symbol field value

func (*CryptoInstrument) GetSymbolOk added in v1.0.158 

func (o *CryptoInstrument) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value and a boolean to check if the value has been set.

func (*CryptoInstrument) HasCurrency added in v1.0.158 

func (o *CryptoInstrument) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*CryptoInstrument) HasDescription added in v1.0.158 

func (o *CryptoInstrument) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CryptoInstrument) HasExchange added in v1.0.158 

func (o *CryptoInstrument) HasExchange() bool

HasExchange returns a boolean if a field has been set.

func (*CryptoInstrument) HasFigiInstrument added in v1.0.158 

func (o *CryptoInstrument) HasFigiInstrument() bool

HasFigiInstrument returns a boolean if a field has been set.

func (CryptoInstrument) MarshalJSON added in v1.0.158 

func (o CryptoInstrument) MarshalJSON() ([]byte, error)

func (*CryptoInstrument) SetCurrency added in v1.0.158 

func (o *CryptoInstrument) SetCurrency(v string)

SetCurrency gets a reference to the given NullableString and assigns it to the Currency field.

func (*CryptoInstrument) SetCurrencyNil added in v1.0.158 

func (o *CryptoInstrument) SetCurrencyNil()

SetCurrencyNil sets the value for Currency to be an explicit nil

func (*CryptoInstrument) SetDescription added in v1.0.158 

func (o *CryptoInstrument) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*CryptoInstrument) SetDescriptionNil added in v1.0.158 

func (o *CryptoInstrument) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*CryptoInstrument) SetExchange added in v1.0.158 

func (o *CryptoInstrument) SetExchange(v string)

SetExchange gets a reference to the given NullableString and assigns it to the Exchange field.

func (*CryptoInstrument) SetExchangeNil added in v1.0.158 

func (o *CryptoInstrument) SetExchangeNil()

SetExchangeNil sets the value for Exchange to be an explicit nil

func (*CryptoInstrument) SetFigiInstrument added in v1.0.158 

func (o *CryptoInstrument) SetFigiInstrument(v FigiInstrumentNullable)

SetFigiInstrument gets a reference to the given NullableFigiInstrumentNullable and assigns it to the FigiInstrument field.

func (*CryptoInstrument) SetFigiInstrumentNil added in v1.0.158 

func (o *CryptoInstrument) SetFigiInstrumentNil()

SetFigiInstrumentNil sets the value for FigiInstrument to be an explicit nil

func (*CryptoInstrument) SetId added in v1.0.158 

func (o *CryptoInstrument) SetId(v string)

SetId sets field value

func (*CryptoInstrument) SetKind added in v1.0.158 

func (o *CryptoInstrument) SetKind(v string)

SetKind sets field value

func (*CryptoInstrument) SetRawSymbol added in v1.0.158 

func (o *CryptoInstrument) SetRawSymbol(v string)

SetRawSymbol sets field value

func (*CryptoInstrument) SetSymbol added in v1.0.158 

func (o *CryptoInstrument) SetSymbol(v string)

SetSymbol sets field value

func (*CryptoInstrument) UnmarshalJSON added in v1.0.158 

func (o *CryptoInstrument) UnmarshalJSON(bytes []byte) (err error)

func (*CryptoInstrument) UnsetCurrency added in v1.0.158 

func (o *CryptoInstrument) UnsetCurrency()

UnsetCurrency ensures that no value is present for Currency, not even an explicit nil

func (*CryptoInstrument) UnsetDescription added in v1.0.158 

func (o *CryptoInstrument) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*CryptoInstrument) UnsetExchange added in v1.0.158 

func (o *CryptoInstrument) UnsetExchange()

UnsetExchange ensures that no value is present for Exchange, not even an explicit nil

func (*CryptoInstrument) UnsetFigiInstrument added in v1.0.158 

func (o *CryptoInstrument) UnsetFigiInstrument()

UnsetFigiInstrument ensures that no value is present for FigiInstrument, not even an explicit nil

type CryptoOrderForm added in v1.0.92 

type CryptoOrderForm struct {
	Instrument CryptoTradingInstrument `json:"instrument"`
	Side       ActionStrict            `json:"side"`
	// The type of order to place.
	Type string `json:"type"`
	// The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date.
	TimeInForce string `json:"time_in_force"`
	// The amount of the base currency to buy or sell.
	Amount float64 `json:"amount"`
	// The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
	LimitPrice *float64 `json:"limit_price,omitempty"`
	// The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
	StopPrice *float64 `json:"stop_price,omitempty"`
	// Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
	PostOnly *bool `json:"post_only,omitempty"`
	// The expiration date of the order. Required if the time_in_force is `GTD`.
	ExpirationDate *time.Time `json:"expiration_date,omitempty"`
}

CryptoOrderForm struct for CryptoOrderForm

func NewCryptoOrderForm added in v1.0.92 

func NewCryptoOrderForm(instrument CryptoTradingInstrument, side ActionStrict, type_ string, timeInForce string, amount float64) *CryptoOrderForm

NewCryptoOrderForm instantiates a new CryptoOrderForm 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

func NewCryptoOrderFormWithDefaults added in v1.0.92 

func NewCryptoOrderFormWithDefaults() *CryptoOrderForm

NewCryptoOrderFormWithDefaults instantiates a new CryptoOrderForm 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

func (*CryptoOrderForm) GetAmount added in v1.0.92 

func (o *CryptoOrderForm) GetAmount() float64

GetAmount returns the Amount field value

func (*CryptoOrderForm) GetAmountOk added in v1.0.92 

func (o *CryptoOrderForm) GetAmountOk() (*float64, bool)

GetAmountOk returns a tuple with the Amount field value and a boolean to check if the value has been set.

func (*CryptoOrderForm) GetExpirationDate added in v1.0.92 

func (o *CryptoOrderForm) GetExpirationDate() time.Time

GetExpirationDate returns the ExpirationDate field value if set, zero value otherwise.

func (*CryptoOrderForm) GetExpirationDateOk added in v1.0.92 

func (o *CryptoOrderForm) GetExpirationDateOk() (*time.Time, bool)

GetExpirationDateOk returns a tuple with the ExpirationDate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CryptoOrderForm) GetInstrument added in v1.0.92 

func (o *CryptoOrderForm) GetInstrument() CryptoTradingInstrument

GetInstrument returns the Instrument field value

func (*CryptoOrderForm) GetInstrumentOk added in v1.0.92 

func (o *CryptoOrderForm) GetInstrumentOk() (*CryptoTradingInstrument, bool)

GetInstrumentOk returns a tuple with the Instrument field value and a boolean to check if the value has been set.

func (*CryptoOrderForm) GetLimitPrice added in v1.0.92 

func (o *CryptoOrderForm) GetLimitPrice() float64

GetLimitPrice returns the LimitPrice field value if set, zero value otherwise.

func (*CryptoOrderForm) GetLimitPriceOk added in v1.0.92 

func (o *CryptoOrderForm) GetLimitPriceOk() (*float64, bool)

GetLimitPriceOk returns a tuple with the LimitPrice field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CryptoOrderForm) GetPostOnly added in v1.0.92 

func (o *CryptoOrderForm) GetPostOnly() bool

GetPostOnly returns the PostOnly field value if set, zero value otherwise.

func (*CryptoOrderForm) GetPostOnlyOk added in v1.0.92 

func (o *CryptoOrderForm) GetPostOnlyOk() (*bool, bool)

GetPostOnlyOk returns a tuple with the PostOnly field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CryptoOrderForm) GetSide added in v1.0.92 

func (o *CryptoOrderForm) GetSide() ActionStrict

GetSide returns the Side field value

func (*CryptoOrderForm) GetSideOk added in v1.0.92 

func (o *CryptoOrderForm) GetSideOk() (*ActionStrict, bool)

GetSideOk returns a tuple with the Side field value and a boolean to check if the value has been set.

func (*CryptoOrderForm) GetStopPrice added in v1.0.92 

func (o *CryptoOrderForm) GetStopPrice() float64

GetStopPrice returns the StopPrice field value if set, zero value otherwise.

func (*CryptoOrderForm) GetStopPriceOk added in v1.0.92 

func (o *CryptoOrderForm) GetStopPriceOk() (*float64, bool)

GetStopPriceOk returns a tuple with the StopPrice field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CryptoOrderForm) GetTimeInForce added in v1.0.92 

func (o *CryptoOrderForm) GetTimeInForce() string

GetTimeInForce returns the TimeInForce field value

func (*CryptoOrderForm) GetTimeInForceOk added in v1.0.92 

func (o *CryptoOrderForm) GetTimeInForceOk() (*string, bool)

GetTimeInForceOk returns a tuple with the TimeInForce field value and a boolean to check if the value has been set.

func (*CryptoOrderForm) GetType added in v1.0.92 

func (o *CryptoOrderForm) GetType() string

GetType returns the Type field value

func (*CryptoOrderForm) GetTypeOk added in v1.0.92 

func (o *CryptoOrderForm) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*CryptoOrderForm) HasExpirationDate added in v1.0.92 

func (o *CryptoOrderForm) HasExpirationDate() bool

HasExpirationDate returns a boolean if a field has been set.

func (*CryptoOrderForm) HasLimitPrice added in v1.0.92 

func (o *CryptoOrderForm) HasLimitPrice() bool

HasLimitPrice returns a boolean if a field has been set.

func (*CryptoOrderForm) HasPostOnly added in v1.0.92 

func (o *CryptoOrderForm) HasPostOnly() bool

HasPostOnly returns a boolean if a field has been set.

func (*CryptoOrderForm) HasStopPrice added in v1.0.92 

func (o *CryptoOrderForm) HasStopPrice() bool

HasStopPrice returns a boolean if a field has been set.

func (CryptoOrderForm) MarshalJSON added in v1.0.92 

func (o CryptoOrderForm) MarshalJSON() ([]byte, error)

func (*CryptoOrderForm) SetAmount added in v1.0.92 

func (o *CryptoOrderForm) SetAmount(v float64)

SetAmount sets field value

func (*CryptoOrderForm) SetExpirationDate added in v1.0.92 

func (o *CryptoOrderForm) SetExpirationDate(v time.Time)

SetExpirationDate gets a reference to the given time.Time and assigns it to the ExpirationDate field.

func (*CryptoOrderForm) SetInstrument added in v1.0.92 

func (o *CryptoOrderForm) SetInstrument(v CryptoTradingInstrument)

SetInstrument sets field value

func (*CryptoOrderForm) SetLimitPrice added in v1.0.92 

func (o *CryptoOrderForm) SetLimitPrice(v float64)

SetLimitPrice gets a reference to the given float64 and assigns it to the LimitPrice field.

func (*CryptoOrderForm) SetPostOnly added in v1.0.92 

func (o *CryptoOrderForm) SetPostOnly(v bool)

SetPostOnly gets a reference to the given bool and assigns it to the PostOnly field.

func (*CryptoOrderForm) SetSide added in v1.0.92 

func (o *CryptoOrderForm) SetSide(v ActionStrict)

SetSide sets field value

func (*CryptoOrderForm) SetStopPrice added in v1.0.92 

func (o *CryptoOrderForm) SetStopPrice(v float64)

SetStopPrice gets a reference to the given float64 and assigns it to the StopPrice field.

func (*CryptoOrderForm) SetTimeInForce added in v1.0.92 

func (o *CryptoOrderForm) SetTimeInForce(v string)

SetTimeInForce sets field value

func (*CryptoOrderForm) SetType added in v1.0.92 

func (o *CryptoOrderForm) SetType(v string)

SetType sets field value

type CryptoOrderPreview added in v1.0.92 

type CryptoOrderPreview struct {
	EstimatedFee         *CryptoOrderPreviewEstimatedFee `json:"estimated_fee,omitempty"`
	AdditionalProperties map[string]interface{}
}

CryptoOrderPreview Preview of an order.

func NewCryptoOrderPreview added in v1.0.92 

func NewCryptoOrderPreview() *CryptoOrderPreview

NewCryptoOrderPreview instantiates a new CryptoOrderPreview 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

func NewCryptoOrderPreviewWithDefaults added in v1.0.92 

func NewCryptoOrderPreviewWithDefaults() *CryptoOrderPreview

NewCryptoOrderPreviewWithDefaults instantiates a new CryptoOrderPreview 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

func (*CryptoOrderPreview) GetEstimatedFee added in v1.0.92 

func (o *CryptoOrderPreview) GetEstimatedFee() CryptoOrderPreviewEstimatedFee

GetEstimatedFee returns the EstimatedFee field value if set, zero value otherwise.

func (*CryptoOrderPreview) GetEstimatedFeeOk added in v1.0.92 

func (o *CryptoOrderPreview) GetEstimatedFeeOk() (*CryptoOrderPreviewEstimatedFee, bool)

GetEstimatedFeeOk returns a tuple with the EstimatedFee field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CryptoOrderPreview) HasEstimatedFee added in v1.0.92 

func (o *CryptoOrderPreview) HasEstimatedFee() bool

HasEstimatedFee returns a boolean if a field has been set.

func (CryptoOrderPreview) MarshalJSON added in v1.0.92 

func (o CryptoOrderPreview) MarshalJSON() ([]byte, error)

func (*CryptoOrderPreview) SetEstimatedFee added in v1.0.92 

func (o *CryptoOrderPreview) SetEstimatedFee(v CryptoOrderPreviewEstimatedFee)

SetEstimatedFee gets a reference to the given CryptoOrderPreviewEstimatedFee and assigns it to the EstimatedFee field.

func (*CryptoOrderPreview) UnmarshalJSON added in v1.0.92 

func (o *CryptoOrderPreview) UnmarshalJSON(bytes []byte) (err error)

type CryptoOrderPreviewEstimatedFee added in v1.0.92 

type CryptoOrderPreviewEstimatedFee struct {
	// Symbol to identify a cryptocurrency or fiat currency on a crypto exchange. Fiat currencies symbols are ISO-4217 codes.
	Currency             string  `json:"currency"`
	Amount               float64 `json:"amount"`
	AdditionalProperties map[string]interface{}
}

CryptoOrderPreviewEstimatedFee The estimated order fee.

func NewCryptoOrderPreviewEstimatedFee added in v1.0.92 

func NewCryptoOrderPreviewEstimatedFee(currency string, amount float64) *CryptoOrderPreviewEstimatedFee

NewCryptoOrderPreviewEstimatedFee instantiates a new CryptoOrderPreviewEstimatedFee 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

func NewCryptoOrderPreviewEstimatedFeeWithDefaults added in v1.0.92 

func NewCryptoOrderPreviewEstimatedFeeWithDefaults() *CryptoOrderPreviewEstimatedFee

NewCryptoOrderPreviewEstimatedFeeWithDefaults instantiates a new CryptoOrderPreviewEstimatedFee 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

func (*CryptoOrderPreviewEstimatedFee) GetAmount added in v1.0.92 

func (o *CryptoOrderPreviewEstimatedFee) GetAmount() float64

GetAmount returns the Amount field value

func (*CryptoOrderPreviewEstimatedFee) GetAmountOk added in v1.0.92 

func (o *CryptoOrderPreviewEstimatedFee) GetAmountOk() (*float64, bool)

GetAmountOk returns a tuple with the Amount field value and a boolean to check if the value has been set.

func (*CryptoOrderPreviewEstimatedFee) GetCurrency added in v1.0.92 

func (o *CryptoOrderPreviewEstimatedFee) GetCurrency() string

GetCurrency returns the Currency field value

func (*CryptoOrderPreviewEstimatedFee) GetCurrencyOk added in v1.0.92 

func (o *CryptoOrderPreviewEstimatedFee) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value and a boolean to check if the value has been set.

func (CryptoOrderPreviewEstimatedFee) MarshalJSON added in v1.0.92 

func (o CryptoOrderPreviewEstimatedFee) MarshalJSON() ([]byte, error)

func (*CryptoOrderPreviewEstimatedFee) SetAmount added in v1.0.92 

func (o *CryptoOrderPreviewEstimatedFee) SetAmount(v float64)

SetAmount sets field value

func (*CryptoOrderPreviewEstimatedFee) SetCurrency added in v1.0.92 

func (o *CryptoOrderPreviewEstimatedFee) SetCurrency(v string)

SetCurrency sets field value

func (*CryptoOrderPreviewEstimatedFee) UnmarshalJSON added in v1.0.92 

func (o *CryptoOrderPreviewEstimatedFee) UnmarshalJSON(bytes []byte) (err error)

type CryptoTradingInstrument added in v1.0.92 

type CryptoTradingInstrument struct {
	// The instrument's trading ticker symbol
	Symbol string `json:"symbol"`
	// The instrument's type
	Type                 string `json:"type"`
	AdditionalProperties map[string]interface{}
}

CryptoTradingInstrument struct for CryptoTradingInstrument

func NewCryptoTradingInstrument added in v1.0.92 

func NewCryptoTradingInstrument(symbol string, type_ string) *CryptoTradingInstrument

NewCryptoTradingInstrument instantiates a new CryptoTradingInstrument 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

func NewCryptoTradingInstrumentWithDefaults added in v1.0.92 

func NewCryptoTradingInstrumentWithDefaults() *CryptoTradingInstrument

NewCryptoTradingInstrumentWithDefaults instantiates a new CryptoTradingInstrument 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

func (*CryptoTradingInstrument) GetSymbol added in v1.0.92 

func (o *CryptoTradingInstrument) GetSymbol() string

GetSymbol returns the Symbol field value

func (*CryptoTradingInstrument) GetSymbolOk added in v1.0.92 

func (o *CryptoTradingInstrument) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value and a boolean to check if the value has been set.

func (*CryptoTradingInstrument) GetType added in v1.0.92 

func (o *CryptoTradingInstrument) GetType() string

GetType returns the Type field value

func (*CryptoTradingInstrument) GetTypeOk added in v1.0.92 

func (o *CryptoTradingInstrument) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (CryptoTradingInstrument) MarshalJSON added in v1.0.92 

func (o CryptoTradingInstrument) MarshalJSON() ([]byte, error)

func (*CryptoTradingInstrument) SetSymbol added in v1.0.92 

func (o *CryptoTradingInstrument) SetSymbol(v string)

SetSymbol sets field value

func (*CryptoTradingInstrument) SetType added in v1.0.92 

func (o *CryptoTradingInstrument) SetType(v string)

SetType sets field value

func (*CryptoTradingInstrument) UnmarshalJSON added in v1.0.92 

func (o *CryptoTradingInstrument) UnmarshalJSON(bytes []byte) (err error)

type CryptocurrencyPair added in v1.0.56 

type CryptocurrencyPair struct {
	// Cryptocurrency pair instrument symbol
	Symbol *string `json:"symbol,omitempty"`
	// The base currency of a pair (e.g., \"BTC\" in BTC/USD). Either fiat or cryptocurrency symbol, for fiat use ISO-4217 codes.
	Base string `json:"base"`
	// The quote currency of a pair (e.g., \"USD\" in BTC/USD). Either fiat or cryptocurrency symbol, for fiat use ISO-4217 codes.
	Quote string `json:"quote"`
	// The precision or smallest price incremental step available for this cryptocurrency pair
	Increment            NullableString `json:"increment,omitempty"`
	AdditionalProperties map[string]interface{}
}

CryptocurrencyPair A cryptocurrency pair instrument.

func NewCryptocurrencyPair added in v1.0.56 

func NewCryptocurrencyPair(base string, quote string) *CryptocurrencyPair

NewCryptocurrencyPair instantiates a new CryptocurrencyPair 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

func NewCryptocurrencyPairWithDefaults added in v1.0.56 

func NewCryptocurrencyPairWithDefaults() *CryptocurrencyPair

NewCryptocurrencyPairWithDefaults instantiates a new CryptocurrencyPair 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

func (*CryptocurrencyPair) GetBase added in v1.0.56 

func (o *CryptocurrencyPair) GetBase() string

GetBase returns the Base field value

func (*CryptocurrencyPair) GetBaseOk added in v1.0.56 

func (o *CryptocurrencyPair) GetBaseOk() (*string, bool)

GetBaseOk returns a tuple with the Base field value and a boolean to check if the value has been set.

func (*CryptocurrencyPair) GetIncrement added in v1.0.119 

func (o *CryptocurrencyPair) GetIncrement() string

GetIncrement returns the Increment field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CryptocurrencyPair) GetIncrementOk added in v1.0.119 

func (o *CryptocurrencyPair) GetIncrementOk() (*string, bool)

GetIncrementOk returns a tuple with the Increment field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CryptocurrencyPair) GetQuote added in v1.0.56 

func (o *CryptocurrencyPair) GetQuote() string

GetQuote returns the Quote field value

func (*CryptocurrencyPair) GetQuoteOk added in v1.0.56 

func (o *CryptocurrencyPair) GetQuoteOk() (*string, bool)

GetQuoteOk returns a tuple with the Quote field value and a boolean to check if the value has been set.

func (*CryptocurrencyPair) GetSymbol added in v1.0.60 

func (o *CryptocurrencyPair) GetSymbol() string

GetSymbol returns the Symbol field value if set, zero value otherwise.

func (*CryptocurrencyPair) GetSymbolOk added in v1.0.60 

func (o *CryptocurrencyPair) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CryptocurrencyPair) HasIncrement added in v1.0.119 

func (o *CryptocurrencyPair) HasIncrement() bool

HasIncrement returns a boolean if a field has been set.

func (*CryptocurrencyPair) HasSymbol added in v1.0.60 

func (o *CryptocurrencyPair) HasSymbol() bool

HasSymbol returns a boolean if a field has been set.

func (CryptocurrencyPair) MarshalJSON added in v1.0.56 

func (o CryptocurrencyPair) MarshalJSON() ([]byte, error)

func (*CryptocurrencyPair) SetBase added in v1.0.56 

func (o *CryptocurrencyPair) SetBase(v string)

SetBase sets field value

func (*CryptocurrencyPair) SetIncrement added in v1.0.119 

func (o *CryptocurrencyPair) SetIncrement(v string)

SetIncrement gets a reference to the given NullableString and assigns it to the Increment field.

func (*CryptocurrencyPair) SetIncrementNil added in v1.0.119 

func (o *CryptocurrencyPair) SetIncrementNil()

SetIncrementNil sets the value for Increment to be an explicit nil

func (*CryptocurrencyPair) SetQuote added in v1.0.56 

func (o *CryptocurrencyPair) SetQuote(v string)

SetQuote sets field value

func (*CryptocurrencyPair) SetSymbol added in v1.0.60 

func (o *CryptocurrencyPair) SetSymbol(v string)

SetSymbol gets a reference to the given string and assigns it to the Symbol field.

func (*CryptocurrencyPair) UnmarshalJSON added in v1.0.56 

func (o *CryptocurrencyPair) UnmarshalJSON(bytes []byte) (err error)

func (*CryptocurrencyPair) UnsetIncrement added in v1.0.119 

func (o *CryptocurrencyPair) UnsetIncrement()

UnsetIncrement ensures that no value is present for Increment, not even an explicit nil

type CryptocurrencyPairQuote added in v1.0.60 

type CryptocurrencyPairQuote struct {
	// The highest price a buyer is willing to pay.
	Bid float64 `json:"bid"`
	// The lowest price a seller is willing to accept.
	Ask float64 `json:"ask"`
	// The market mid price.
	Mid *float64 `json:"mid,omitempty"`
	// The timestamp of the quote.
	Timestamp            *time.Time `json:"timestamp,omitempty"`
	AdditionalProperties map[string]interface{}
}

CryptocurrencyPairQuote struct for CryptocurrencyPairQuote

func NewCryptocurrencyPairQuote added in v1.0.60 

func NewCryptocurrencyPairQuote(bid float64, ask float64) *CryptocurrencyPairQuote

NewCryptocurrencyPairQuote instantiates a new CryptocurrencyPairQuote 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

func NewCryptocurrencyPairQuoteWithDefaults added in v1.0.60 

func NewCryptocurrencyPairQuoteWithDefaults() *CryptocurrencyPairQuote

NewCryptocurrencyPairQuoteWithDefaults instantiates a new CryptocurrencyPairQuote 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

func (*CryptocurrencyPairQuote) GetAsk added in v1.0.60 

func (o *CryptocurrencyPairQuote) GetAsk() float64

GetAsk returns the Ask field value

func (*CryptocurrencyPairQuote) GetAskOk added in v1.0.60 

func (o *CryptocurrencyPairQuote) GetAskOk() (*float64, bool)

GetAskOk returns a tuple with the Ask field value and a boolean to check if the value has been set.

func (*CryptocurrencyPairQuote) GetBid added in v1.0.60 

func (o *CryptocurrencyPairQuote) GetBid() float64

GetBid returns the Bid field value

func (*CryptocurrencyPairQuote) GetBidOk added in v1.0.60 

func (o *CryptocurrencyPairQuote) GetBidOk() (*float64, bool)

GetBidOk returns a tuple with the Bid field value and a boolean to check if the value has been set.

func (*CryptocurrencyPairQuote) GetMid added in v1.0.60 

func (o *CryptocurrencyPairQuote) GetMid() float64

GetMid returns the Mid field value if set, zero value otherwise.

func (*CryptocurrencyPairQuote) GetMidOk added in v1.0.60 

func (o *CryptocurrencyPairQuote) GetMidOk() (*float64, bool)

GetMidOk returns a tuple with the Mid field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CryptocurrencyPairQuote) GetTimestamp added in v1.0.60 

func (o *CryptocurrencyPairQuote) GetTimestamp() time.Time

GetTimestamp returns the Timestamp field value if set, zero value otherwise.

func (*CryptocurrencyPairQuote) GetTimestampOk added in v1.0.60 

func (o *CryptocurrencyPairQuote) GetTimestampOk() (*time.Time, bool)

GetTimestampOk returns a tuple with the Timestamp field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CryptocurrencyPairQuote) HasMid added in v1.0.60 

func (o *CryptocurrencyPairQuote) HasMid() bool

HasMid returns a boolean if a field has been set.

func (*CryptocurrencyPairQuote) HasTimestamp added in v1.0.60 

func (o *CryptocurrencyPairQuote) HasTimestamp() bool

HasTimestamp returns a boolean if a field has been set.

func (CryptocurrencyPairQuote) MarshalJSON added in v1.0.60 

func (o CryptocurrencyPairQuote) MarshalJSON() ([]byte, error)

func (*CryptocurrencyPairQuote) SetAsk added in v1.0.60 

func (o *CryptocurrencyPairQuote) SetAsk(v float64)

SetAsk sets field value

func (*CryptocurrencyPairQuote) SetBid added in v1.0.60 

func (o *CryptocurrencyPairQuote) SetBid(v float64)

SetBid sets field value

func (*CryptocurrencyPairQuote) SetMid added in v1.0.60 

func (o *CryptocurrencyPairQuote) SetMid(v float64)

SetMid gets a reference to the given float64 and assigns it to the Mid field.

func (*CryptocurrencyPairQuote) SetTimestamp added in v1.0.60 

func (o *CryptocurrencyPairQuote) SetTimestamp(v time.Time)

SetTimestamp gets a reference to the given time.Time and assigns it to the Timestamp field.

func (*CryptocurrencyPairQuote) UnmarshalJSON added in v1.0.60 

func (o *CryptocurrencyPairQuote) UnmarshalJSON(bytes []byte) (err error)

type Currency 

type Currency struct {
	// Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
	Id *string `json:"id,omitempty"`
	// The ISO-4217 currency code for the currency.
	Code *string `json:"code,omitempty"`
	// A human-friendly name of the currency.
	Name                 *string `json:"name,omitempty"`
	AdditionalProperties map[string]interface{}
}

Currency Describes a currency object.

func NewCurrency 

func NewCurrency() *Currency

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

func NewCurrencyWithDefaults 

func NewCurrencyWithDefaults() *Currency

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

func (*Currency) GetCode 

func (o *Currency) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*Currency) GetCodeOk 

func (o *Currency) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Currency) GetId 

func (o *Currency) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*Currency) GetIdOk 

func (o *Currency) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Currency) GetName 

func (o *Currency) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*Currency) GetNameOk 

func (o *Currency) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Currency) HasCode 

func (o *Currency) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*Currency) HasId 

func (o *Currency) HasId() bool

HasId returns a boolean if a field has been set.

func (*Currency) HasName 

func (o *Currency) HasName() bool

HasName returns a boolean if a field has been set.

func (Currency) MarshalJSON 

func (o Currency) MarshalJSON() ([]byte, error)

func (*Currency) SetCode 

func (o *Currency) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*Currency) SetId 

func (o *Currency) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*Currency) SetName 

func (o *Currency) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*Currency) UnmarshalJSON 

func (o *Currency) UnmarshalJSON(bytes []byte) (err error)

type CurrencyNullable added in v1.1.0 

type CurrencyNullable struct {
	// Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
	Id *string `json:"id,omitempty"`
	// The ISO-4217 currency code for the currency.
	Code *string `json:"code,omitempty"`
	// A human-friendly name of the currency.
	Name                 *string `json:"name,omitempty"`
	AdditionalProperties map[string]interface{}
}

CurrencyNullable Describes a currency object.

func NewCurrencyNullable added in v1.1.0 

func NewCurrencyNullable() *CurrencyNullable

NewCurrencyNullable instantiates a new CurrencyNullable 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

func NewCurrencyNullableWithDefaults added in v1.1.0 

func NewCurrencyNullableWithDefaults() *CurrencyNullable

NewCurrencyNullableWithDefaults instantiates a new CurrencyNullable 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

func (*CurrencyNullable) GetCode added in v1.1.0 

func (o *CurrencyNullable) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*CurrencyNullable) GetCodeOk added in v1.1.0 

func (o *CurrencyNullable) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CurrencyNullable) GetId added in v1.1.0 

func (o *CurrencyNullable) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*CurrencyNullable) GetIdOk added in v1.1.0 

func (o *CurrencyNullable) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CurrencyNullable) GetName added in v1.1.0 

func (o *CurrencyNullable) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*CurrencyNullable) GetNameOk added in v1.1.0 

func (o *CurrencyNullable) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CurrencyNullable) HasCode added in v1.1.0 

func (o *CurrencyNullable) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*CurrencyNullable) HasId added in v1.1.0 

func (o *CurrencyNullable) HasId() bool

HasId returns a boolean if a field has been set.

func (*CurrencyNullable) HasName added in v1.1.0 

func (o *CurrencyNullable) HasName() bool

HasName returns a boolean if a field has been set.

func (CurrencyNullable) MarshalJSON added in v1.1.0 

func (o CurrencyNullable) MarshalJSON() ([]byte, error)

func (*CurrencyNullable) SetCode added in v1.1.0 

func (o *CurrencyNullable) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*CurrencyNullable) SetId added in v1.1.0 

func (o *CurrencyNullable) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*CurrencyNullable) SetName added in v1.1.0 

func (o *CurrencyNullable) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*CurrencyNullable) UnmarshalJSON added in v1.1.0 

func (o *CurrencyNullable) UnmarshalJSON(bytes []byte) (err error)

type DeleteConnectionConfirmation added in v1.0.138 

type DeleteConnectionConfirmation struct {
	// Connection queued for deletion; please wait for webhook for confirmation.
	Detail *string `json:"detail,omitempty"`
	// The ID of the connection (brokerage authorization) that was scheduled for deletion.
	ConnectionId         *string `json:"connection_id,omitempty"`
	AdditionalProperties map[string]interface{}
}

DeleteConnectionConfirmation Confirmation that a task has been scheduled to delete the connection.

func NewDeleteConnectionConfirmation added in v1.0.138 

func NewDeleteConnectionConfirmation() *DeleteConnectionConfirmation

NewDeleteConnectionConfirmation instantiates a new DeleteConnectionConfirmation 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

func NewDeleteConnectionConfirmationWithDefaults added in v1.0.138 

func NewDeleteConnectionConfirmationWithDefaults() *DeleteConnectionConfirmation

NewDeleteConnectionConfirmationWithDefaults instantiates a new DeleteConnectionConfirmation 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

func (*DeleteConnectionConfirmation) GetConnectionId added in v1.0.138 

func (o *DeleteConnectionConfirmation) GetConnectionId() string

GetConnectionId returns the ConnectionId field value if set, zero value otherwise.

func (*DeleteConnectionConfirmation) GetConnectionIdOk added in v1.0.138 

func (o *DeleteConnectionConfirmation) GetConnectionIdOk() (*string, bool)

GetConnectionIdOk returns a tuple with the ConnectionId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeleteConnectionConfirmation) GetDetail added in v1.0.138 

func (o *DeleteConnectionConfirmation) GetDetail() string

GetDetail returns the Detail field value if set, zero value otherwise.

func (*DeleteConnectionConfirmation) GetDetailOk added in v1.0.138 

func (o *DeleteConnectionConfirmation) GetDetailOk() (*string, bool)

GetDetailOk returns a tuple with the Detail field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeleteConnectionConfirmation) HasConnectionId added in v1.0.138 

func (o *DeleteConnectionConfirmation) HasConnectionId() bool

HasConnectionId returns a boolean if a field has been set.

func (*DeleteConnectionConfirmation) HasDetail added in v1.0.138 

func (o *DeleteConnectionConfirmation) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (DeleteConnectionConfirmation) MarshalJSON added in v1.0.138 

func (o DeleteConnectionConfirmation) MarshalJSON() ([]byte, error)

func (*DeleteConnectionConfirmation) SetConnectionId added in v1.0.138 

func (o *DeleteConnectionConfirmation) SetConnectionId(v string)

SetConnectionId gets a reference to the given string and assigns it to the ConnectionId field.

func (*DeleteConnectionConfirmation) SetDetail added in v1.0.138 

func (o *DeleteConnectionConfirmation) SetDetail(v string)

SetDetail gets a reference to the given string and assigns it to the Detail field.

func (*DeleteConnectionConfirmation) UnmarshalJSON added in v1.0.138 

func (o *DeleteConnectionConfirmation) UnmarshalJSON(bytes []byte) (err error)

type DeleteUserResponse 

type DeleteUserResponse struct {
	// This is always `deleted` when a user is queued for deletion.
	Status *string `json:"status,omitempty"`
	// Human friendly message about the deletion status.
	Detail *string `json:"detail,omitempty"`
	// SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
	UserId               *string `json:"userId,omitempty"`
	AdditionalProperties map[string]interface{}
}

DeleteUserResponse struct for DeleteUserResponse

func NewDeleteUserResponse 

func NewDeleteUserResponse() *DeleteUserResponse

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

func NewDeleteUserResponseWithDefaults 

func NewDeleteUserResponseWithDefaults() *DeleteUserResponse

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

func (*DeleteUserResponse) GetDetail added in v1.0.6 

func (o *DeleteUserResponse) GetDetail() string

GetDetail returns the Detail field value if set, zero value otherwise.

func (*DeleteUserResponse) GetDetailOk added in v1.0.6 

func (o *DeleteUserResponse) GetDetailOk() (*string, bool)

GetDetailOk returns a tuple with the Detail field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeleteUserResponse) GetStatus 

func (o *DeleteUserResponse) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*DeleteUserResponse) GetStatusOk 

func (o *DeleteUserResponse) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeleteUserResponse) GetUserId 

func (o *DeleteUserResponse) GetUserId() string

GetUserId returns the UserId field value if set, zero value otherwise.

func (*DeleteUserResponse) GetUserIdOk 

func (o *DeleteUserResponse) GetUserIdOk() (*string, bool)

GetUserIdOk returns a tuple with the UserId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeleteUserResponse) HasDetail added in v1.0.6 

func (o *DeleteUserResponse) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (*DeleteUserResponse) HasStatus 

func (o *DeleteUserResponse) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*DeleteUserResponse) HasUserId 

func (o *DeleteUserResponse) HasUserId() bool

HasUserId returns a boolean if a field has been set.

func (DeleteUserResponse) MarshalJSON 

func (o DeleteUserResponse) MarshalJSON() ([]byte, error)

func (*DeleteUserResponse) SetDetail added in v1.0.6 

func (o *DeleteUserResponse) SetDetail(v string)

SetDetail gets a reference to the given string and assigns it to the Detail field.

func (*DeleteUserResponse) SetStatus 

func (o *DeleteUserResponse) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*DeleteUserResponse) SetUserId 

func (o *DeleteUserResponse) SetUserId(v string)

SetUserId gets a reference to the given string and assigns it to the UserId field.

func (*DeleteUserResponse) UnmarshalJSON 

func (o *DeleteUserResponse) UnmarshalJSON(bytes []byte) (err error)

type DividendAtDate 

type DividendAtDate struct {
	// The ticker of the symbol that the dividend came from
	Symbol NullableString `json:"symbol,omitempty"`
	// The amount received from the dividend
	Amount NullableFloat32 `json:"amount,omitempty"`
	// The currency of the amount
	Currency             *string `json:"currency,omitempty"`
	AdditionalProperties map[string]interface{}
}

DividendAtDate struct for DividendAtDate

func NewDividendAtDate 

func NewDividendAtDate() *DividendAtDate

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

func NewDividendAtDateWithDefaults 

func NewDividendAtDateWithDefaults() *DividendAtDate

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

func (*DividendAtDate) GetAmount 

func (o *DividendAtDate) GetAmount() float32

GetAmount returns the Amount field value if set, zero value otherwise (both if not set or set to explicit null).

func (*DividendAtDate) GetAmountOk 

func (o *DividendAtDate) GetAmountOk() (*float32, bool)

GetAmountOk returns a tuple with the Amount field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*DividendAtDate) GetCurrency 

func (o *DividendAtDate) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise.

func (*DividendAtDate) GetCurrencyOk 

func (o *DividendAtDate) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DividendAtDate) GetSymbol 

func (o *DividendAtDate) GetSymbol() string

GetSymbol returns the Symbol field value if set, zero value otherwise (both if not set or set to explicit null).

func (*DividendAtDate) GetSymbolOk 

func (o *DividendAtDate) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*DividendAtDate) HasAmount 

func (o *DividendAtDate) HasAmount() bool

HasAmount returns a boolean if a field has been set.

func (*DividendAtDate) HasCurrency 

func (o *DividendAtDate) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*DividendAtDate) HasSymbol 

func (o *DividendAtDate) HasSymbol() bool

HasSymbol returns a boolean if a field has been set.

func (DividendAtDate) MarshalJSON 

func (o DividendAtDate) MarshalJSON() ([]byte, error)

func (*DividendAtDate) SetAmount 

func (o *DividendAtDate) SetAmount(v float32)

SetAmount gets a reference to the given NullableFloat32 and assigns it to the Amount field.

func (*DividendAtDate) SetAmountNil 

func (o *DividendAtDate) SetAmountNil()

SetAmountNil sets the value for Amount to be an explicit nil

func (*DividendAtDate) SetCurrency 

func (o *DividendAtDate) SetCurrency(v string)

SetCurrency gets a reference to the given string and assigns it to the Currency field.

func (*DividendAtDate) SetSymbol 

func (o *DividendAtDate) SetSymbol(v string)

SetSymbol gets a reference to the given NullableString and assigns it to the Symbol field.

func (*DividendAtDate) SetSymbolNil 

func (o *DividendAtDate) SetSymbolNil()

SetSymbolNil sets the value for Symbol to be an explicit nil

func (*DividendAtDate) UnmarshalJSON 

func (o *DividendAtDate) UnmarshalJSON(bytes []byte) (err error)

func (*DividendAtDate) UnsetAmount 

func (o *DividendAtDate) UnsetAmount()

UnsetAmount ensures that no value is present for Amount, not even an explicit nil

func (*DividendAtDate) UnsetSymbol 

func (o *DividendAtDate) UnsetSymbol()

UnsetSymbol ensures that no value is present for Symbol, not even an explicit nil

type EncryptedResponse 

type EncryptedResponse struct {
	EncryptedSharedKey   *string                                `json:"encryptedSharedKey,omitempty"`
	EncryptedMessageData *EncryptedResponseEncryptedMessageData `json:"encryptedMessageData,omitempty"`
}

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. To decrypt the shared key, the user should have access to their SSH private key stored locally in their device An example Python code on how to decrypt the shared key is shown below ``` def decrypt_rsa_message(self, encrypted_message): from Crypto.Cipher import PKCS1_OAEP from Crypto.PublicKey import RSA from base64 import b64decode f = open('private.pem', 'r') private_key = RSA.import_key(f.read()) cipher = PKCS1_OAEP.new(private_key) return cipher.decrypt(b64decode(encrypted_message.encode())).decode() ``` * Decrypting the encryptedMessageData The data meant to be returned by an endpoint can be obtained by decrypting the encrypted message An encrypted message is a message that is encrypted using AES - MODE OCB with the shared key obtained in step one An example code to decrypt the encrypted message is shown below ``` def decrypt_aes_message(self, shared_key, encrypted_message): from Crypto.Cipher import AES from base64 import b64decode encrypted_msg = b64decode(encrypted_message[\"encryptedMessage\"].encode()) tag = b64decode(encrypted_message[\"tag\"].encode()) nonce = b64decode(encrypted_message[\"nonce\"].encode()) cipher = AES.new(shared_key.encode(), AES.MODE_OCB, nonce=nonce) return cipher.decrypt_and_verify(encrypted_msg, tag).decode() ```

func NewEncryptedResponse 

func NewEncryptedResponse() *EncryptedResponse

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

func NewEncryptedResponseWithDefaults 

func NewEncryptedResponseWithDefaults() *EncryptedResponse

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

func (*EncryptedResponse) GetEncryptedMessageData 

func (o *EncryptedResponse) GetEncryptedMessageData() EncryptedResponseEncryptedMessageData

GetEncryptedMessageData returns the EncryptedMessageData field value if set, zero value otherwise.

func (*EncryptedResponse) GetEncryptedMessageDataOk 

func (o *EncryptedResponse) GetEncryptedMessageDataOk() (*EncryptedResponseEncryptedMessageData, bool)

GetEncryptedMessageDataOk returns a tuple with the EncryptedMessageData field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EncryptedResponse) GetEncryptedSharedKey 

func (o *EncryptedResponse) GetEncryptedSharedKey() string

GetEncryptedSharedKey returns the EncryptedSharedKey field value if set, zero value otherwise.

func (*EncryptedResponse) GetEncryptedSharedKeyOk 

func (o *EncryptedResponse) GetEncryptedSharedKeyOk() (*string, bool)

GetEncryptedSharedKeyOk returns a tuple with the EncryptedSharedKey field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EncryptedResponse) HasEncryptedMessageData 

func (o *EncryptedResponse) HasEncryptedMessageData() bool

HasEncryptedMessageData returns a boolean if a field has been set.

func (*EncryptedResponse) HasEncryptedSharedKey 

func (o *EncryptedResponse) HasEncryptedSharedKey() bool

HasEncryptedSharedKey returns a boolean if a field has been set.

func (EncryptedResponse) MarshalJSON 

func (o EncryptedResponse) MarshalJSON() ([]byte, error)

func (*EncryptedResponse) SetEncryptedMessageData 

func (o *EncryptedResponse) SetEncryptedMessageData(v EncryptedResponseEncryptedMessageData)

SetEncryptedMessageData gets a reference to the given EncryptedResponseEncryptedMessageData and assigns it to the EncryptedMessageData field.

func (*EncryptedResponse) SetEncryptedSharedKey 

func (o *EncryptedResponse) SetEncryptedSharedKey(v string)

SetEncryptedSharedKey gets a reference to the given string and assigns it to the EncryptedSharedKey field.

type EncryptedResponseEncryptedMessageData 

type EncryptedResponseEncryptedMessageData struct {
	EncryptedMessage     *string `json:"encryptedMessage,omitempty"`
	Tag                  *string `json:"tag,omitempty"`
	Nonce                *string `json:"nonce,omitempty"`
	AdditionalProperties map[string]interface{}
}

EncryptedResponseEncryptedMessageData struct for EncryptedResponseEncryptedMessageData

func NewEncryptedResponseEncryptedMessageData 

func NewEncryptedResponseEncryptedMessageData() *EncryptedResponseEncryptedMessageData

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

func NewEncryptedResponseEncryptedMessageDataWithDefaults 

func NewEncryptedResponseEncryptedMessageDataWithDefaults() *EncryptedResponseEncryptedMessageData

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

func (*EncryptedResponseEncryptedMessageData) GetEncryptedMessage 

func (o *EncryptedResponseEncryptedMessageData) GetEncryptedMessage() string

GetEncryptedMessage returns the EncryptedMessage field value if set, zero value otherwise.

func (*EncryptedResponseEncryptedMessageData) GetEncryptedMessageOk 

func (o *EncryptedResponseEncryptedMessageData) GetEncryptedMessageOk() (*string, bool)

GetEncryptedMessageOk returns a tuple with the EncryptedMessage field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EncryptedResponseEncryptedMessageData) GetNonce 

func (o *EncryptedResponseEncryptedMessageData) GetNonce() string

GetNonce returns the Nonce field value if set, zero value otherwise.

func (*EncryptedResponseEncryptedMessageData) GetNonceOk 

func (o *EncryptedResponseEncryptedMessageData) GetNonceOk() (*string, bool)

GetNonceOk returns a tuple with the Nonce field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EncryptedResponseEncryptedMessageData) GetTag 

func (o *EncryptedResponseEncryptedMessageData) GetTag() string

GetTag returns the Tag field value if set, zero value otherwise.

func (*EncryptedResponseEncryptedMessageData) GetTagOk 

func (o *EncryptedResponseEncryptedMessageData) GetTagOk() (*string, bool)

GetTagOk returns a tuple with the Tag field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EncryptedResponseEncryptedMessageData) HasEncryptedMessage 

func (o *EncryptedResponseEncryptedMessageData) HasEncryptedMessage() bool

HasEncryptedMessage returns a boolean if a field has been set.

func (*EncryptedResponseEncryptedMessageData) HasNonce 

func (o *EncryptedResponseEncryptedMessageData) HasNonce() bool

HasNonce returns a boolean if a field has been set.

func (*EncryptedResponseEncryptedMessageData) HasTag 

func (o *EncryptedResponseEncryptedMessageData) HasTag() bool

HasTag returns a boolean if a field has been set.

func (EncryptedResponseEncryptedMessageData) MarshalJSON 

func (o EncryptedResponseEncryptedMessageData) MarshalJSON() ([]byte, error)

func (*EncryptedResponseEncryptedMessageData) SetEncryptedMessage 

func (o *EncryptedResponseEncryptedMessageData) SetEncryptedMessage(v string)

SetEncryptedMessage gets a reference to the given string and assigns it to the EncryptedMessage field.

func (*EncryptedResponseEncryptedMessageData) SetNonce 

func (o *EncryptedResponseEncryptedMessageData) SetNonce(v string)

SetNonce gets a reference to the given string and assigns it to the Nonce field.

func (*EncryptedResponseEncryptedMessageData) SetTag 

func (o *EncryptedResponseEncryptedMessageData) SetTag(v string)

SetTag gets a reference to the given string and assigns it to the Tag field.

func (*EncryptedResponseEncryptedMessageData) UnmarshalJSON 

func (o *EncryptedResponseEncryptedMessageData) UnmarshalJSON(bytes []byte) (err error)

type EtfInstrument added in v1.0.158 

type EtfInstrument struct {
	// Type of security instrument.
	Kind string `json:"kind"`
	// Unique identifier for the instrument.
	Id string `json:"id"`
	// The formatted trading symbol for the security.
	Symbol string `json:"symbol"`
	// The raw symbol without any exchange suffix.
	RawSymbol string `json:"raw_symbol"`
	// Human-readable description of the security.
	Description NullableString `json:"description,omitempty"`
	// ISO-4217 currency code for the security listing.
	Currency NullableString `json:"currency,omitempty"`
	// Exchange MIC code or exchange code for the security.
	Exchange             NullableString                 `json:"exchange,omitempty"`
	FigiInstrument       NullableFigiInstrumentNullable `json:"figi_instrument,omitempty"`
	AdditionalProperties map[string]interface{}
}

EtfInstrument Security instrument metadata for ETF positions.

func NewEtfInstrument added in v1.0.158 

func NewEtfInstrument(kind string, id string, symbol string, rawSymbol string) *EtfInstrument

NewEtfInstrument instantiates a new EtfInstrument 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

func NewEtfInstrumentWithDefaults added in v1.0.158 

func NewEtfInstrumentWithDefaults() *EtfInstrument

NewEtfInstrumentWithDefaults instantiates a new EtfInstrument 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

func (*EtfInstrument) GetCurrency added in v1.0.158 

func (o *EtfInstrument) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*EtfInstrument) GetCurrencyOk added in v1.0.158 

func (o *EtfInstrument) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*EtfInstrument) GetDescription added in v1.0.158 

func (o *EtfInstrument) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise (both if not set or set to explicit null).

func (*EtfInstrument) GetDescriptionOk added in v1.0.158 

func (o *EtfInstrument) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*EtfInstrument) GetExchange added in v1.0.158 

func (o *EtfInstrument) GetExchange() string

GetExchange returns the Exchange field value if set, zero value otherwise (both if not set or set to explicit null).

func (*EtfInstrument) GetExchangeOk added in v1.0.158 

func (o *EtfInstrument) GetExchangeOk() (*string, bool)

GetExchangeOk returns a tuple with the Exchange field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*EtfInstrument) GetFigiInstrument added in v1.0.158 

func (o *EtfInstrument) GetFigiInstrument() FigiInstrumentNullable

GetFigiInstrument returns the FigiInstrument field value if set, zero value otherwise (both if not set or set to explicit null).

func (*EtfInstrument) GetFigiInstrumentOk added in v1.0.158 

func (o *EtfInstrument) GetFigiInstrumentOk() (*FigiInstrumentNullable, bool)

GetFigiInstrumentOk returns a tuple with the FigiInstrument field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*EtfInstrument) GetId added in v1.0.158 

func (o *EtfInstrument) GetId() string

GetId returns the Id field value

func (*EtfInstrument) GetIdOk added in v1.0.158 

func (o *EtfInstrument) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*EtfInstrument) GetKind added in v1.0.158 

func (o *EtfInstrument) GetKind() string

GetKind returns the Kind field value

func (*EtfInstrument) GetKindOk added in v1.0.158 

func (o *EtfInstrument) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value and a boolean to check if the value has been set.

func (*EtfInstrument) GetRawSymbol added in v1.0.158 

func (o *EtfInstrument) GetRawSymbol() string

GetRawSymbol returns the RawSymbol field value

func (*EtfInstrument) GetRawSymbolOk added in v1.0.158 

func (o *EtfInstrument) GetRawSymbolOk() (*string, bool)

GetRawSymbolOk returns a tuple with the RawSymbol field value and a boolean to check if the value has been set.

func (*EtfInstrument) GetSymbol added in v1.0.158 

func (o *EtfInstrument) GetSymbol() string

GetSymbol returns the Symbol field value

func (*EtfInstrument) GetSymbolOk added in v1.0.158 

func (o *EtfInstrument) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value and a boolean to check if the value has been set.

func (*EtfInstrument) HasCurrency added in v1.0.158 

func (o *EtfInstrument) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*EtfInstrument) HasDescription added in v1.0.158 

func (o *EtfInstrument) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*EtfInstrument) HasExchange added in v1.0.158 

func (o *EtfInstrument) HasExchange() bool

HasExchange returns a boolean if a field has been set.

func (*EtfInstrument) HasFigiInstrument added in v1.0.158 

func (o *EtfInstrument) HasFigiInstrument() bool

HasFigiInstrument returns a boolean if a field has been set.

func (EtfInstrument) MarshalJSON added in v1.0.158 

func (o EtfInstrument) MarshalJSON() ([]byte, error)

func (*EtfInstrument) SetCurrency added in v1.0.158 

func (o *EtfInstrument) SetCurrency(v string)

SetCurrency gets a reference to the given NullableString and assigns it to the Currency field.

func (*EtfInstrument) SetCurrencyNil added in v1.0.158 

func (o *EtfInstrument) SetCurrencyNil()

SetCurrencyNil sets the value for Currency to be an explicit nil

func (*EtfInstrument) SetDescription added in v1.0.158 

func (o *EtfInstrument) SetDescription(v string)

SetDescription gets a reference to the given NullableString and assigns it to the Description field.

func (*EtfInstrument) SetDescriptionNil added in v1.0.158 

func (o *EtfInstrument) SetDescriptionNil()

SetDescriptionNil sets the value for Description to be an explicit nil

func (*EtfInstrument) SetExchange added in v1.0.158 

func (o *EtfInstrument) SetExchange(v string)

SetExchange gets a reference to the given NullableString and assigns it to the Exchange field.

func (*EtfInstrument) SetExchangeNil added in v1.0.158 

func (o *EtfInstrument) SetExchangeNil()

SetExchangeNil sets the value for Exchange to be an explicit nil

func (*EtfInstrument) SetFigiInstrument added in v1.0.158 

func (o *EtfInstrument) SetFigiInstrument(v FigiInstrumentNullable)

SetFigiInstrument gets a reference to the given NullableFigiInstrumentNullable and assigns it to the FigiInstrument field.

func (*EtfInstrument) SetFigiInstrumentNil added in v1.0.158 

func (o *EtfInstrument) SetFigiInstrumentNil()

SetFigiInstrumentNil sets the value for FigiInstrument to be an explicit nil

func (*EtfInstrument) SetId added in v1.0.158 

func (o *EtfInstrument) SetId(v string)

SetId sets field value

func (*EtfInstrument) SetKind added in v1.0.158 

func (o *EtfInstrument) SetKind(v string)

SetKind sets field value

func (*EtfInstrument) SetRawSymbol added in v1.0.158 

func (o *EtfInstrument) SetRawSymbol(v string)

SetRawSymbol sets field value

func (*EtfInstrument) SetSymbol added in v1.0.158 

func (o *EtfInstrument) SetSymbol(v string)

SetSymbol sets field value

func (*EtfInstrument) UnmarshalJSON added in v1.0.158 

func (o *EtfInstrument) UnmarshalJSON(bytes []byte) (err error)

func (*EtfInstrument) UnsetCurrency added in v1.0.158 

func (o *EtfInstrument) UnsetCurrency()

UnsetCurrency ensures that no value is present for Currency, not even an explicit nil

func (*EtfInstrument) UnsetDescription added in v1.0.158 

func (o *EtfInstrument) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

func (*EtfInstrument) UnsetExchange added in v1.0.158 

func (o *EtfInstrument) UnsetExchange()

UnsetExchange ensures that no value is present for Exchange, not even an explicit nil

func (*EtfInstrument) UnsetFigiInstrument added in v1.0.158 

func (o *EtfInstrument) UnsetFigiInstrument()

UnsetFigiInstrument ensures that no value is present for FigiInstrument, not even an explicit nil

type Exchange 

type Exchange struct {
	// Unique ID for the exchange in SnapTrade.
	Id *string `json:"id,omitempty"`
	// A short name for the exchange. For standardized exchange code, please use the `mic_code` field.
	Code *string `json:"code,omitempty"`
	// The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
	MicCode NullableString `json:"mic_code,omitempty"`
	// The full name of the exchange.
	Name *string `json:"name,omitempty"`
	// The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
	Timezone *string `json:"timezone,omitempty"`
	// The time when the exchange opens for trading.
	StartTime *string `json:"start_time,omitempty"`
	// The time when the exchange closes for trading.
	CloseTime *string `json:"close_time,omitempty"`
	// The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail.
	Suffix               NullableString `json:"suffix,omitempty"`
	AdditionalProperties map[string]interface{}
}

Exchange Describes a single stock or crypto exchange.

func NewExchange 

func NewExchange() *Exchange

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

func NewExchangeWithDefaults 

func NewExchangeWithDefaults() *Exchange

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

func (*Exchange) GetCloseTime 

func (o *Exchange) GetCloseTime() string

GetCloseTime returns the CloseTime field value if set, zero value otherwise.

func (*Exchange) GetCloseTimeOk 

func (o *Exchange) GetCloseTimeOk() (*string, bool)

GetCloseTimeOk returns a tuple with the CloseTime field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exchange) GetCode 

func (o *Exchange) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*Exchange) GetCodeOk 

func (o *Exchange) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exchange) GetId 

func (o *Exchange) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*Exchange) GetIdOk 

func (o *Exchange) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exchange) GetMicCode 

func (o *Exchange) GetMicCode() string

GetMicCode returns the MicCode field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Exchange) GetMicCodeOk 

func (o *Exchange) GetMicCodeOk() (*string, bool)

GetMicCodeOk returns a tuple with the MicCode field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Exchange) GetName 

func (o *Exchange) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*Exchange) GetNameOk 

func (o *Exchange) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exchange) GetStartTime 

func (o *Exchange) GetStartTime() string

GetStartTime returns the StartTime field value if set, zero value otherwise.

func (*Exchange) GetStartTimeOk 

func (o *Exchange) GetStartTimeOk() (*string, bool)

GetStartTimeOk returns a tuple with the StartTime field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exchange) GetSuffix 

func (o *Exchange) GetSuffix() string

GetSuffix returns the Suffix field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Exchange) GetSuffixOk 

func (o *Exchange) GetSuffixOk() (*string, bool)

GetSuffixOk returns a tuple with the Suffix field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Exchange) GetTimezone 

func (o *Exchange) GetTimezone() string

GetTimezone returns the Timezone field value if set, zero value otherwise.

func (*Exchange) GetTimezoneOk 

func (o *Exchange) GetTimezoneOk() (*string, bool)

GetTimezoneOk returns a tuple with the Timezone field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exchange) HasCloseTime 

func (o *Exchange) HasCloseTime() bool

HasCloseTime returns a boolean if a field has been set.

func (*Exchange) HasCode 

func (o *Exchange) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*Exchange) HasId 

func (o *Exchange) HasId() bool

HasId returns a boolean if a field has been set.

func (*Exchange) HasMicCode 

func (o *Exchange) HasMicCode() bool

HasMicCode returns a boolean if a field has been set.

func (*Exchange) HasName 

func (o *Exchange) HasName() bool

HasName returns a boolean if a field has been set.

func (*Exchange) HasStartTime 

func (o *Exchange) HasStartTime() bool

HasStartTime returns a boolean if a field has been set.

func (*Exchange) HasSuffix 

func (o *Exchange) HasSuffix() bool

HasSuffix returns a boolean if a field has been set.

func (*Exchange) HasTimezone 

func (o *Exchange) HasTimezone() bool

HasTimezone returns a boolean if a field has been set.

func (Exchange) MarshalJSON 

func (o Exchange) MarshalJSON() ([]byte, error)

func (*Exchange) SetCloseTime 

func (o *Exchange) SetCloseTime(v string)

SetCloseTime gets a reference to the given string and assigns it to the CloseTime field.

func (*Exchange) SetCode 

func (o *Exchange) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*Exchange) SetId 

func (o *Exchange) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*Exchange) SetMicCode 

func (o *Exchange) SetMicCode(v string)

SetMicCode gets a reference to the given NullableString and assigns it to the MicCode field.

func (*Exchange) SetMicCodeNil added in v1.0.180 

func (o *Exchange) SetMicCodeNil()

SetMicCodeNil sets the value for MicCode to be an explicit nil

func (*Exchange) SetName 

func (o *Exchange) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*Exchange) SetStartTime 

func (o *Exchange) SetStartTime(v string)

SetStartTime gets a reference to the given string and assigns it to the StartTime field.

func (*Exchange) SetSuffix 

func (o *Exchange) SetSuffix(v string)

SetSuffix gets a reference to the given NullableString and assigns it to the Suffix field.

func (*Exchange) SetSuffixNil 

func (o *Exchange) SetSuffixNil()

SetSuffixNil sets the value for Suffix to be an explicit nil

func (*Exchange) SetTimezone 

func (o *Exchange) SetTimezone(v string)

SetTimezone gets a reference to the given string and assigns it to the Timezone field.

func (*Exchange) UnmarshalJSON 

func (o *Exchange) UnmarshalJSON(bytes []byte) (err error)

func (*Exchange) UnsetMicCode added in v1.0.180 

func (o *Exchange) UnsetMicCode()

UnsetMicCode ensures that no value is present for MicCode, not even an explicit nil

func (*Exchange) UnsetSuffix 

func (o *Exchange) UnsetSuffix()

UnsetSuffix ensures that no value is present for Suffix, not even an explicit nil

type ExchangeRatePairs 

type ExchangeRatePairs struct {
	Src                  *Currency `json:"src,omitempty"`
	Dst                  *Currency `json:"dst,omitempty"`
	ExchangeRate         *float32  `json:"exchange_rate,omitempty"`
	AdditionalProperties map[string]interface{}
}

ExchangeRatePairs The exchange rate of a pair of currencies

func NewExchangeRatePairs 

func NewExchangeRatePairs() *ExchangeRatePairs

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

func NewExchangeRatePairsWithDefaults 

func NewExchangeRatePairsWithDefaults() *ExchangeRatePairs

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

func (*ExchangeRatePairs) GetDst 

func (o *ExchangeRatePairs) GetDst() Currency

GetDst returns the Dst field value if set, zero value otherwise.

func (*ExchangeRatePairs) GetDstOk 

func (o *ExchangeRatePairs) GetDstOk() (*Currency, bool)

GetDstOk returns a tuple with the Dst field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ExchangeRatePairs) GetExchangeRate 

func (o *ExchangeRatePairs) GetExchangeRate() float32

GetExchangeRate returns the ExchangeRate field value if set, zero value otherwise.

func (*ExchangeRatePairs) GetExchangeRateOk 

func (o *ExchangeRatePairs) GetExchangeRateOk() (*float32, bool)

GetExchangeRateOk returns a tuple with the ExchangeRate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ExchangeRatePairs) GetSrc 

func (o *ExchangeRatePairs) GetSrc() Currency

GetSrc returns the Src field value if set, zero value otherwise.

func (*ExchangeRatePairs) GetSrcOk 

func (o *ExchangeRatePairs) GetSrcOk() (*Currency, bool)

GetSrcOk returns a tuple with the Src field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ExchangeRatePairs) HasDst 

func (o *ExchangeRatePairs) HasDst() bool

HasDst returns a boolean if a field has been set.

func (*ExchangeRatePairs) HasExchangeRate 

func (o *ExchangeRatePairs) HasExchangeRate() bool

HasExchangeRate returns a boolean if a field has been set.

func (*ExchangeRatePairs) HasSrc 

func (o *ExchangeRatePairs) HasSrc() bool

HasSrc returns a boolean if a field has been set.

func (ExchangeRatePairs) MarshalJSON 

func (o ExchangeRatePairs) MarshalJSON() ([]byte, error)

func (*ExchangeRatePairs) SetDst 

func (o *ExchangeRatePairs) SetDst(v Currency)

SetDst gets a reference to the given Currency and assigns it to the Dst field.

func (*ExchangeRatePairs) SetExchangeRate 

func (o *ExchangeRatePairs) SetExchangeRate(v float32)

SetExchangeRate gets a reference to the given float32 and assigns it to the ExchangeRate field.

func (*ExchangeRatePairs) SetSrc 

func (o *ExchangeRatePairs) SetSrc(v Currency)

SetSrc gets a reference to the given Currency and assigns it to the Src field.

func (*ExchangeRatePairs) UnmarshalJSON 

func (o *ExchangeRatePairs) UnmarshalJSON(bytes []byte) (err error)

type ExperimentalEndpointsApiAddSubscriptionRequest added in v1.0.171 

type ExperimentalEndpointsApiAddSubscriptionRequest struct {
	ApiService *ExperimentalEndpointsApiService
	// contains filtered or unexported fields
}

func (ExperimentalEndpointsApiAddSubscriptionRequest) Execute added in v1.0.171 

func (r ExperimentalEndpointsApiAddSubscriptionRequest) Execute() (*TradeDetectionSubscription, *http.Response, error)

type ExperimentalEndpointsApiCancelSubscriptionRequest added in v1.0.171 

type ExperimentalEndpointsApiCancelSubscriptionRequest struct {
	ApiService *ExperimentalEndpointsApiService
	// contains filtered or unexported fields
}

func (ExperimentalEndpointsApiCancelSubscriptionRequest) Execute added in v1.0.171 

func (r ExperimentalEndpointsApiCancelSubscriptionRequest) Execute() (*TradeDetectionCancelSubscriptionResponse, *http.Response, error)

type ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request added in v1.0.131 

type ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request struct {
	ApiService *ExperimentalEndpointsApiService
	// contains filtered or unexported fields
}

func (ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request) Execute added in v1.0.131 

func (r ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request) Execute() (*AccountOrderRecordV2, *http.Response, error)

type ExperimentalEndpointsApiGetUserAccountOrdersV2Request added in v1.0.117 

type ExperimentalEndpointsApiGetUserAccountOrdersV2Request struct {
	ApiService *ExperimentalEndpointsApiService
	// contains filtered or unexported fields
}

func (*ExperimentalEndpointsApiGetUserAccountOrdersV2Request) Days added in v1.0.117 

func (r *ExperimentalEndpointsApiGetUserAccountOrdersV2Request) Days(days int32) *ExperimentalEndpointsApiGetUserAccountOrdersV2Request

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

func (ExperimentalEndpointsApiGetUserAccountOrdersV2Request) Execute added in v1.0.117 

func (r ExperimentalEndpointsApiGetUserAccountOrdersV2Request) Execute() (*AccountOrdersV2Response, *http.Response, error)

func (*ExperimentalEndpointsApiGetUserAccountOrdersV2Request) State added in v1.0.117 

func (r *ExperimentalEndpointsApiGetUserAccountOrdersV2Request) State(state string) *ExperimentalEndpointsApiGetUserAccountOrdersV2Request

defaults to \"all\"

type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request added in v1.0.117 

type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request struct {
	ApiService *ExperimentalEndpointsApiService
	// contains filtered or unexported fields
}

func (ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request) Execute added in v1.0.117 

func (r ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request) Execute() (*AccountOrdersV2Response, *http.Response, error)

func (*ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request) OnlyExecuted added in v1.0.117 

func (r *ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request) OnlyExecuted(onlyExecuted bool) *ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request

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

type ExperimentalEndpointsApiListConnectionAccountsRequest added in v1.1.0 

type ExperimentalEndpointsApiListConnectionAccountsRequest struct {
	ApiService *ExperimentalEndpointsApiService
	// contains filtered or unexported fields
}

func (ExperimentalEndpointsApiListConnectionAccountsRequest) Execute added in v1.1.0 

func (r ExperimentalEndpointsApiListConnectionAccountsRequest) Execute() ([]ConnectionAccount, *http.Response, error)

type ExperimentalEndpointsApiListSubscriptionsRequest added in v1.0.171 

type ExperimentalEndpointsApiListSubscriptionsRequest struct {
	ApiService *ExperimentalEndpointsApiService
	// contains filtered or unexported fields
}

func (ExperimentalEndpointsApiListSubscriptionsRequest) Execute added in v1.0.171 

func (r ExperimentalEndpointsApiListSubscriptionsRequest) Execute() ([]TradeDetectionSubscription, *http.Response, error)

type ExperimentalEndpointsApiService added in v1.0.117 

type ExperimentalEndpointsApiService service

ExperimentalEndpointsApiService ExperimentalEndpointsApi service

func (*ExperimentalEndpointsApiService) AddSubscription added in v1.0.171 

func (a *ExperimentalEndpointsApiService) AddSubscription(userId string, userSecret string, tradeDetectionAddSubscriptionRequest TradeDetectionAddSubscriptionRequest) ExperimentalEndpointsApiAddSubscriptionRequest

AddSubscription Add a Trade Detection subscription

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

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param tradeDetectionAddSubscriptionRequest
@return ExperimentalEndpointsApiAddSubscriptionRequest

func (*ExperimentalEndpointsApiService) AddSubscriptionExecute added in v1.0.171 

func (a *ExperimentalEndpointsApiService) AddSubscriptionExecute(r ExperimentalEndpointsApiAddSubscriptionRequest) (*TradeDetectionSubscription, *http.Response, error)

Execute executes the request 

@return TradeDetectionSubscription

func (*ExperimentalEndpointsApiService) CancelSubscription added in v1.0.171 

func (a *ExperimentalEndpointsApiService) CancelSubscription(tradeDetectionCancelSubscriptionRequest TradeDetectionCancelSubscriptionRequest) ExperimentalEndpointsApiCancelSubscriptionRequest

CancelSubscription Cancel a Trade Detection subscription

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

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tradeDetectionCancelSubscriptionRequest
@return ExperimentalEndpointsApiCancelSubscriptionRequest

func (*ExperimentalEndpointsApiService) CancelSubscriptionExecute added in v1.0.171 

func (a *ExperimentalEndpointsApiService) CancelSubscriptionExecute(r ExperimentalEndpointsApiCancelSubscriptionRequest) (*TradeDetectionCancelSubscriptionResponse, *http.Response, error)

Execute executes the request 

@return TradeDetectionCancelSubscriptionResponse

func (*ExperimentalEndpointsApiService) GetUserAccountOrderDetailV2 added in v1.0.131 

func (a *ExperimentalEndpointsApiService) GetUserAccountOrderDetailV2(accountId string, brokerageOrderId string, userId string, userSecret string) ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request

GetUserAccountOrderDetailV2 Get account order detail (V2)

Returns the detail of a single order using the brokerage order ID provided as a path parameter.

The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.

This endpoint is always realtime and does not rely on cached data.

This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param accountId
@param brokerageOrderId
@param userId
@param userSecret
@return ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request

func (*ExperimentalEndpointsApiService) GetUserAccountOrderDetailV2Execute added in v1.0.131 

func (a *ExperimentalEndpointsApiService) GetUserAccountOrderDetailV2Execute(r ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request) (*AccountOrderRecordV2, *http.Response, error)

Execute executes the request 

@return AccountOrderRecordV2

func (*ExperimentalEndpointsApiService) GetUserAccountOrdersV2 added in v1.0.117 

func (a *ExperimentalEndpointsApiService) GetUserAccountOrdersV2(userId string, userSecret string, accountId string) ExperimentalEndpointsApiGetUserAccountOrdersV2Request

GetUserAccountOrdersV2 List account orders v2

Returns a list of recent orders in the specified account.

The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId
@return ExperimentalEndpointsApiGetUserAccountOrdersV2Request

func (*ExperimentalEndpointsApiService) GetUserAccountOrdersV2Execute added in v1.0.117 

func (a *ExperimentalEndpointsApiService) GetUserAccountOrdersV2Execute(r ExperimentalEndpointsApiGetUserAccountOrdersV2Request) (*AccountOrdersV2Response, *http.Response, error)

Execute executes the request 

@return AccountOrdersV2Response

func (*ExperimentalEndpointsApiService) GetUserAccountRecentOrdersV2 added in v1.0.117 

func (a *ExperimentalEndpointsApiService) GetUserAccountRecentOrdersV2(userId string, userSecret string, accountId string) ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request

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

A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId
@param userSecret
@param accountId
@return ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request

func (*ExperimentalEndpointsApiService) GetUserAccountRecentOrdersV2Execute added in v1.0.117 

func (a *ExperimentalEndpointsApiService) GetUserAccountRecentOrdersV2Execute(r ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request) (*AccountOrdersV2Response, *http.Response, error)

Execute executes the request 

@return AccountOrdersV2Response

func (*ExperimentalEndpointsApiService) ListConnectionAccounts added in v1.1.0 

func (a *ExperimentalEndpointsApiService) ListConnectionAccounts(authorizationId string, userId string, userSecret string) ExperimentalEndpointsApiListConnectionAccountsRequest

ListConnectionAccounts List accounts for a connection (discriminated union)

Experimental and subject to change without notice.

Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.

Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.

On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and market value live from the brokerage on each call.

On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param authorizationId
@param userId
@param userSecret
@return ExperimentalEndpointsApiListConnectionAccountsRequest

func (*ExperimentalEndpointsApiService) ListConnectionAccountsExecute added in v1.1.0 

func (a *ExperimentalEndpointsApiService) ListConnectionAccountsExecute(r ExperimentalEndpointsApiListConnectionAccountsRequest) ([]ConnectionAccount, *http.Response, error)

Execute executes the request 

@return []ConnectionAccount

func (*ExperimentalEndpointsApiService) ListSubscriptions added in v1.0.171 

func (a *ExperimentalEndpointsApiService) ListSubscriptions() ExperimentalEndpointsApiListSubscriptionsRequest

ListSubscriptions List active Trade Detection subscriptions

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

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ExperimentalEndpointsApiListSubscriptionsRequest

func (*ExperimentalEndpointsApiService) ListSubscriptionsExecute added in v1.0.171 

func (a *ExperimentalEndpointsApiService) ListSubscriptionsExecute(r ExperimentalEndpointsApiListSubscriptionsRequest) ([]TradeDetectionSubscription, *http.Response, error)

Execute executes the request 

@return []TradeDetectionSubscription

type FigiInstrument 

type FigiInstrument struct {
	// This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
	FigiCode NullableString `json:"figi_code,omitempty"`
	// This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
	FigiShareClass       NullableString `json:"figi_share_class,omitempty"`
	AdditionalProperties map[string]interface{}
}

FigiInstrument Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information.

func NewFigiInstrument 

func NewFigiInstrument() *FigiInstrument

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

func NewFigiInstrumentWithDefaults 

func NewFigiInstrumentWithDefaults() *FigiInstrument

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

func (*FigiInstrument) GetFigiCode 

func (o *FigiInstrument) GetFigiCode() string

GetFigiCode returns the FigiCode field value if set, zero value otherwise (both if not set or set to explicit null).

func (*FigiInstrument) GetFigiCodeOk 

func (o *FigiInstrument) GetFigiCodeOk() (*string, bool)

GetFigiCodeOk returns a tuple with the FigiCode field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*FigiInstrument) GetFigiShareClass 

func (o *FigiInstrument) GetFigiShareClass() string

GetFigiShareClass returns the FigiShareClass field value if set, zero value otherwise (both if not set or set to explicit null).

func (*FigiInstrument) GetFigiShareClassOk 

func (o *FigiInstrument) GetFigiShareClassOk() (*string, bool)

GetFigiShareClassOk returns a tuple with the FigiShareClass field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*FigiInstrument) HasFigiCode 

func (o *FigiInstrument) HasFigiCode() bool

HasFigiCode returns a boolean if a field has been set.

func (*FigiInstrument) HasFigiShareClass 

func (o *FigiInstrument) HasFigiShareClass() bool

HasFigiShareClass returns a boolean if a field has been set.

func (FigiInstrument) MarshalJSON 

func (o FigiInstrument) MarshalJSON() ([]byte, error)

func (*FigiInstrument) SetFigiCode 

func (o *FigiInstrument) SetFigiCode(v string)

SetFigiCode gets a reference to the given NullableString and assigns it to the FigiCode field.

func (*FigiInstrument) SetFigiCodeNil 

func (o *FigiInstrument) SetFigiCodeNil()

SetFigiCodeNil sets the value for FigiCode to be an explicit nil

func (*FigiInstrument) SetFigiShareClass 

func (o *FigiInstrument) SetFigiShareClass(v string)

SetFigiShareClass gets a reference to the given NullableString and assigns it to the FigiShareClass field.

func (*FigiInstrument) SetFigiShareClassNil 

func (o *FigiInstrument) SetFigiShareClassNil()

SetFigiShareClassNil sets the value for FigiShareClass to be an explicit nil

func (*FigiInstrument) UnmarshalJSON 

func (o *FigiInstrument) UnmarshalJSON(bytes []byte) (err error)

func (*FigiInstrument) UnsetFigiCode 

func (o *FigiInstrument) UnsetFigiCode()

UnsetFigiCode ensures that no value is present for FigiCode, not even an explicit nil

func (*FigiInstrument) UnsetFigiShareClass 

func (o *FigiInstrument) UnsetFigiShareClass()

UnsetFigiShareClass ensures that no value is present for FigiShareClass, not even an explicit nil

type FigiInstrumentNullable added in v1.1.0 

type FigiInstrumentNullable struct {
	// This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
	FigiCode NullableString `json:"figi_code,omitempty"`
	// This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
	FigiShareClass       NullableString `json:"figi_share_class,omitempty"`
	AdditionalProperties map[string]interface{}
}

FigiInstrumentNullable Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information.

func NewFigiInstrumentNullable added in v1.1.0 

func NewFigiInstrumentNullable() *FigiInstrumentNullable

NewFigiInstrumentNullable instantiates a new FigiInstrumentNullable 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

func NewFigiInstrumentNullableWithDefaults added in v1.1.0 

func NewFigiInstrumentNullableWithDefaults() *FigiInstrumentNullable

NewFigiInstrumentNullableWithDefaults instantiates a new FigiInstrumentNullable 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

func (*FigiInstrumentNullable) GetFigiCode added in v1.1.0 

func (o *FigiInstrumentNullable) GetFigiCode() string

GetFigiCode returns the FigiCode field value if set, zero value otherwise (both if not set or set to explicit null).

func (*FigiInstrumentNullable) GetFigiCodeOk added in v1.1.0 

func (o *FigiInstrumentNullable) GetFigiCodeOk() (*string, bool)

GetFigiCodeOk returns a tuple with the FigiCode field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*FigiInstrumentNullable) GetFigiShareClass added in v1.1.0 

func (o *FigiInstrumentNullable) GetFigiShareClass() string

GetFigiShareClass returns the FigiShareClass field value if set, zero value otherwise (both if not set or set to explicit null).

func (*FigiInstrumentNullable) GetFigiShareClassOk added in v1.1.0 

func (o *FigiInstrumentNullable) GetFigiShareClassOk() (*string, bool)

GetFigiShareClassOk returns a tuple with the FigiShareClass field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*FigiInstrumentNullable) HasFigiCode added in v1.1.0 

func (o *FigiInstrumentNullable) HasFigiCode() bool

HasFigiCode returns a boolean if a field has been set.

func (*FigiInstrumentNullable) HasFigiShareClass added in v1.1.0 

func (o *FigiInstrumentNullable) HasFigiShareClass() bool

HasFigiShareClass returns a boolean if a field has been set.

func (FigiInstrumentNullable) MarshalJSON added in v1.1.0 

func (o FigiInstrumentNullable) MarshalJSON() ([]byte, error)

func (*FigiInstrumentNullable) SetFigiCode added in v1.1.0 

func (o *FigiInstrumentNullable) SetFigiCode(v string)

SetFigiCode gets a reference to the given NullableString and assigns it to the FigiCode field.

func (*FigiInstrumentNullable) SetFigiCodeNil added in v1.1.0 

func (o *FigiInstrumentNullable) SetFigiCodeNil()

SetFigiCodeNil sets the value for FigiCode to be an explicit nil

func (*FigiInstrumentNullable) SetFigiShareClass added in v1.1.0 

func (o *FigiInstrumentNullable) SetFigiShareClass(v string)

SetFigiShareClass gets a reference to the given NullableString and assigns it to the FigiShareClass field.

func (*FigiInstrumentNullable) SetFigiShareClassNil added in v1.1.0 

func (o *FigiInstrumentNullable) SetFigiShareClassNil()

SetFigiShareClassNil sets the value for FigiShareClass to be an explicit nil

func (*FigiInstrumentNullable) UnmarshalJSON added in v1.1.0 

func (o *FigiInstrumentNullable) UnmarshalJSON(bytes []byte) (err error)

func (*FigiInstrumentNullable) UnsetFigiCode added in v1.1.0 

func (o *FigiInstrumentNullable) UnsetFigiCode()

UnsetFigiCode ensures that no value is present for FigiCode, not even an explicit nil

func (*FigiInstrumentNullable) UnsetFigiShareClass added in v1.1.0 

func (o *FigiInstrumentNullable) UnsetFigiShareClass()

UnsetFigiShareClass ensures that no value is present for FigiShareClass, not even an explicit nil

type FutureInstrument added in v1.0.158 

type FutureInstrument struct {
	// Type of security instrument.
	Kind string `json:"kind"`
	// Unique identifier for the future instrument.
	Id string `json:"id"`
	// Display symbol for the future contract.
	Symbol string `json:"symbol"`
	// Root symbol for the future contract.
	RootSymbol string `json:"root_symbol"`
	// Exchange expiration code for the contract.
	ExpirationCode string `json:"expiration_code"`
	// Expiration date of the contract.
	ExpirationDate NullableString `json:"expiration_date,omitempty"`
	// Multiplier for the future contract.
	Multiplier NullableFloat64 `json:"multiplier,omitempty"`
	// ISO-4217 currency code for the contract.
	Currency NullableString `json:"currency,omitempty"`
	// Exchange MIC code or exchange code for the contract.
	Exchange             NullableString `json:"exchange,omitempty"`
	AdditionalProperties map[string]interface{}
}

FutureInstrument Future instrument metadata for a V2 position.

func NewFutureInstrument added in v1.0.158 

func NewFutureInstrument(kind string, id string, symbol string, rootSymbol string, expirationCode string) *FutureInstrument

NewFutureInstrument instantiates a new FutureInstrument 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

func NewFutureInstrumentWithDefaults added in v1.0.158 

func NewFutureInstrumentWithDefaults() *FutureInstrument

NewFutureInstrumentWithDefaults instantiates a new FutureInstrument 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

func (*FutureInstrument) GetCurrency added in v1.0.158 

func (o *FutureInstrument) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*FutureInstrument) GetCurrencyOk added in v1.0.158 

func (o *FutureInstrument) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*FutureInstrument) GetExchange added in v1.0.158 

func (o *FutureInstrument) GetExchange() string

GetExchange returns the Exchange field value if set, zero value otherwise (both if not set or set to explicit null).

func (*FutureInstrument) GetExchangeOk added in v1.0.158 

func (o *FutureInstrument) GetExchangeOk() (*string, bool)

GetExchangeOk returns a tuple with the Exchange field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*FutureInstrument) GetExpirationCode added in v1.0.158 

func (o *FutureInstrument) GetExpirationCode() string

GetExpirationCode returns the ExpirationCode field value

func (*FutureInstrument) GetExpirationCodeOk added in v1.0.158 

func (o *FutureInstrument) GetExpirationCodeOk() (*string, bool)

GetExpirationCodeOk returns a tuple with the ExpirationCode field value and a boolean to check if the value has been set.

func (*FutureInstrument) GetExpirationDate added in v1.0.158 

func (o *FutureInstrument) GetExpirationDate() string

GetExpirationDate returns the ExpirationDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*FutureInstrument) GetExpirationDateOk added in v1.0.158 

func (o *FutureInstrument) GetExpirationDateOk() (*string, bool)

GetExpirationDateOk returns a tuple with the ExpirationDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*FutureInstrument) GetId added in v1.0.158 

func (o *FutureInstrument) GetId() string

GetId returns the Id field value

func (*FutureInstrument) GetIdOk added in v1.0.158 

func (o *FutureInstrument) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*FutureInstrument) GetKind added in v1.0.158 

func (o *FutureInstrument) GetKind() string

GetKind returns the Kind field value

func (*FutureInstrument) GetKindOk added in v1.0.158 

func (o *FutureInstrument) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value and a boolean to check if the value has been set.

func (*FutureInstrument) GetMultiplier added in v1.0.158 

func (o *FutureInstrument) GetMultiplier() float64

GetMultiplier returns the Multiplier field value if set, zero value otherwise (both if not set or set to explicit null).

func (*FutureInstrument) GetMultiplierOk added in v1.0.158 

func (o *FutureInstrument) GetMultiplierOk() (*float64, bool)

GetMultiplierOk returns a tuple with the Multiplier field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*FutureInstrument) GetRootSymbol added in v1.0.158 

func (o *FutureInstrument) GetRootSymbol() string

GetRootSymbol returns the RootSymbol field value

func (*FutureInstrument) GetRootSymbolOk added in v1.0.158 

func (o *FutureInstrument) GetRootSymbolOk() (*string, bool)

GetRootSymbolOk returns a tuple with the RootSymbol field value and a boolean to check if the value has been set.

func (*FutureInstrument) GetSymbol added in v1.0.158 

func (o *FutureInstrument) GetSymbol() string

GetSymbol returns the Symbol field value

func (*FutureInstrument) GetSymbolOk added in v1.0.158 

func (o *FutureInstrument) GetSymbolOk() (*string, bool)

GetSymbolOk returns a tuple with the Symbol field value and a boolean to check if the value has been set.

func (*FutureInstrument) HasCurrency added in v1.0.158 

func (o *FutureInstrument) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*FutureInstrument) HasExchange added in v1.0.158 

func (o *FutureInstrument) HasExchange() bool

HasExchange returns a boolean if a field has been set.

func (*FutureInstrument) HasExpirationDate added in v1.0.158 

func (o *FutureInstrument) HasExpirationDate() bool

HasExpirationDate returns a boolean if a field has been set.

func (*FutureInstrument) HasMultiplier added in v1.0.158 

func (o *FutureInstrument) HasMultiplier() bool

HasMultiplier returns a boolean if a field has been set.

func (FutureInstrument) MarshalJSON added in v1.0.158 

func (o FutureInstrument) MarshalJSON() ([]byte, error)

func (*FutureInstrument) SetCurrency added in v1.0.158 

func (o *FutureInstrument) SetCurrency(v string)

SetCurrency gets a reference to the given NullableString and assigns it to the Currency field.

func (*FutureInstrument) SetCurrencyNil added in v1.0.158 

func (o *FutureInstrument) SetCurrencyNil()

SetCurrencyNil sets the value for Currency to be an explicit nil

func (*FutureInstrument) SetExchange added in v1.0.158 

func (o *FutureInstrument) SetExchange(v string)

SetExchange gets a reference to the given NullableString and assigns it to the Exchange field.

func (*FutureInstrument) SetExchangeNil added in v1.0.158 

func (o *FutureInstrument) SetExchangeNil()

SetExchangeNil sets the value for Exchange to be an explicit nil

func (*FutureInstrument) SetExpirationCode added in v1.0.158 

func (o *FutureInstrument) SetExpirationCode(v string)

SetExpirationCode sets field value

func (*FutureInstrument) SetExpirationDate added in v1.0.158 

func (o *FutureInstrument) SetExpirationDate(v string)

SetExpirationDate gets a reference to the given NullableString and assigns it to the ExpirationDate field.

func (*FutureInstrument) SetExpirationDateNil added in v1.0.158 

func (o *FutureInstrument) SetExpirationDateNil()

SetExpirationDateNil sets the value for ExpirationDate to be an explicit nil

func (*FutureInstrument) SetId added in v1.0.158 

func (o *FutureInstrument) SetId(v string)

SetId sets field value

func (*FutureInstrument) SetKind added in v1.0.158 

func (o *FutureInstrument) SetKind(v string)

SetKind sets field value

func (*FutureInstrument) SetMultiplier added in v1.0.158 

func (o *FutureInstrument) SetMultiplier(v float64)

SetMultiplier gets a reference to the given NullableFloat64 and assigns it to the Multiplier field.

func (*FutureInstrument) SetMultiplierNil added in v1.0.158 

func (o *FutureInstrument) SetMultiplierNil()

SetMultiplierNil sets the value for Multiplier to be an explicit nil

func (*FutureInstrument) SetRootSymbol added in v1.0.158 

func (o *FutureInstrument) SetRootSymbol(v string)

SetRootSymbol sets field value

func (*FutureInstrument) SetSymbol added in v1.0.158 

func (o *FutureInstrument) SetSymbol(v string)

SetSymbol sets field value

func (*FutureInstrument) UnmarshalJSON added in v1.0.158 

func (o *FutureInstrument) UnmarshalJSON(bytes []byte) (err error)

func (*FutureInstrument) UnsetCurrency added in v1.0.158 

func (o *FutureInstrument) UnsetCurrency()

UnsetCurrency ensures that no value is present for Currency, not even an explicit nil

func (*FutureInstrument) UnsetExchange added in v1.0.158 

func (o *FutureInstrument) UnsetExchange()

UnsetExchange ensures that no value is present for Exchange, not even an explicit nil

func (*FutureInstrument) UnsetExpirationDate added in v1.0.158 

func (o *FutureInstrument) UnsetExpirationDate()

UnsetExpirationDate ensures that no value is present for ExpirationDate, not even an explicit nil

func (*FutureInstrument) UnsetMultiplier added in v1.0.158 

func (o *FutureInstrument) UnsetMultiplier()

UnsetMultiplier ensures that no value is present for Multiplier, not even an explicit nil

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type HoldingsStatus 

type HoldingsStatus struct {
	// Indicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete.
	InitialSyncCompleted *bool `json:"initial_sync_completed,omitempty"`
	// The last time holdings were successfully synced by SnapTrade.
	LastSuccessfulSync NullableTime `json:"last_successful_sync,omitempty"`
}

HoldingsStatus Status of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established. 2. Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage. 3. Manual sync - You can trigger a refresh of holdings with the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.

func NewHoldingsStatus 

func NewHoldingsStatus() *HoldingsStatus

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

func NewHoldingsStatusWithDefaults 

func NewHoldingsStatusWithDefaults() *HoldingsStatus

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

func (*HoldingsStatus) GetInitialSyncCompleted 

func (o *HoldingsStatus) GetInitialSyncCompleted() bool

GetInitialSyncCompleted returns the InitialSyncCompleted field value if set, zero value otherwise.

func (*HoldingsStatus) GetInitialSyncCompletedOk 

func (o *HoldingsStatus) GetInitialSyncCompletedOk() (*bool, bool)

GetInitialSyncCompletedOk returns a tuple with the InitialSyncCompleted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HoldingsStatus) GetLastSuccessfulSync 

func (o *HoldingsStatus) GetLastSuccessfulSync() time.Time

GetLastSuccessfulSync returns the LastSuccessfulSync field value if set, zero value otherwise (both if not set or set to explicit null).

func (*HoldingsStatus) GetLastSuccessfulSyncOk 

func (o *HoldingsStatus) GetLastSuccessfulSyncOk() (*time.Time, bool)

GetLastSuccessfulSyncOk returns a tuple with the LastSuccessfulSync field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*HoldingsStatus) HasInitialSyncCompleted 

func (o *HoldingsStatus) HasInitialSyncCompleted() bool

HasInitialSyncCompleted returns a boolean if a field has been set.

func (*HoldingsStatus) HasLastSuccessfulSync 

func (o *HoldingsStatus) HasLastSuccessfulSync() bool

HasLastSuccessfulSync returns a boolean if a field has been set.

func (HoldingsStatus) MarshalJSON 

func (o HoldingsStatus) MarshalJSON() ([]byte, error)

func (*HoldingsStatus) SetInitialSyncCompleted 

func (o *HoldingsStatus) SetInitialSyncCompleted(v bool)

SetInitialSyncCompleted gets a reference to the given bool and assigns it to the InitialSyncCompleted field.

func (*HoldingsStatus) SetLastSuccessfulSync 

func (o *HoldingsStatus) SetLastSuccessfulSync(v time.Time)

SetLastSuccessfulSync gets a reference to the given NullableTime.Time and assigns it to the LastSuccessfulSync field.

func (*HoldingsStatus) SetLastSuccessfulSyncNil 

func (o *HoldingsStatus) SetLastSuccessfulSyncNil()

SetLastSuccessfulSyncNil sets the value for LastSuccessfulSync to be an explicit nil

func (*HoldingsStatus) UnsetLastSuccessfulSync 

func (o *HoldingsStatus) UnsetLastSuccessfulSync()

UnsetLastSuccessfulSync ensures that no value is present for LastSuccessfulSync, not even an explicit nil

type Instrument added in v1.0.158 

type Instrument struct {
	AdrInstrument        *AdrInstrument
	CefInstrument        *CefInstrument
	CfdInstrument        *CfdInstrument
	CryptoInstrument     *CryptoInstrument
	EtfInstrument        *EtfInstrument
	FutureInstrument     *FutureInstrument
	MutualFundInstrument *MutualFundInstrument
	OptionInstrument     *OptionInstrument
	OtherInstrument      *OtherInstrument
	StockInstrument      *StockInstrument
}

Instrument - Instrument metadata for a V2 position. Use `kind` to determine which schema is present.

func AdrInstrumentAsInstrument added in v1.0.160 

func AdrInstrumentAsInstrument(v *AdrInstrument) Instrument

AdrInstrumentAsInstrument is a convenience function that returns AdrInstrument wrapped in Instrument

func CefInstrumentAsInstrument added in v1.0.160 

func CefInstrumentAsInstrument(v *CefInstrument) Instrument

CefInstrumentAsInstrument is a convenience function that returns CefInstrument wrapped in Instrument

func CfdInstrumentAsInstrument added in v1.0.182 

func CfdInstrumentAsInstrument(v *CfdInstrument) Instrument

CfdInstrumentAsInstrument is a convenience function that returns CfdInstrument wrapped in Instrument

func CryptoInstrumentAsInstrument added in v1.0.158 

func CryptoInstrumentAsInstrument(v *CryptoInstrument) Instrument

CryptoInstrumentAsInstrument is a convenience function that returns CryptoInstrument wrapped in Instrument

func EtfInstrumentAsInstrument added in v1.0.158 

func EtfInstrumentAsInstrument(v *EtfInstrument) Instrument

EtfInstrumentAsInstrument is a convenience function that returns EtfInstrument wrapped in Instrument

func FutureInstrumentAsInstrument added in v1.0.158 

func FutureInstrumentAsInstrument(v *FutureInstrument) Instrument

FutureInstrumentAsInstrument is a convenience function that returns FutureInstrument wrapped in Instrument

func MutualFundInstrumentAsInstrument added in v1.0.160 

func MutualFundInstrumentAsInstrument(v *MutualFundInstrument) Instrument

MutualFundInstrumentAsInstrument is a convenience function that returns MutualFundInstrument wrapped in Instrument

func OptionInstrumentAsInstrument added in v1.0.158 

func OptionInstrumentAsInstrument(v *OptionInstrument) Instrument

OptionInstrumentAsInstrument is a convenience function that returns OptionInstrument wrapped in Instrument

func OtherInstrumentAsInstrument added in v1.0.158 

func OtherInstrumentAsInstrument(v *OtherInstrument) Instrument

OtherInstrumentAsInstrument is a convenience function that returns OtherInstrument wrapped in Instrument

func StockInstrumentAsInstrument added in v1.0.158 

func StockInstrumentAsInstrument(v *StockInstrument) Instrument

StockInstrumentAsInstrument is a convenience function that returns StockInstrument wrapped in Instrument

func (*Instrument) GetActualInstance added in v1.0.158 

func (obj *Instrument) GetActualInstance() interface{}

Get the actual instance

func (Instrument) MarshalJSON added in v1.0.158 

func (src Instrument) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*Instrument) UnmarshalJSON added in v1.0.158 

func (dst *Instrument) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

type InvestmentAccount added in v1.1.0 

type InvestmentAccount struct {
	// Discriminator for the account kind.
	Kind string `json:"kind"`
	// Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
	Id string `json:"id"`
	// Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.
	ConnectionId string `json:"connection_id"`
	// A display name for the account. Either assigned by the user or by the brokerage itself.
	DisplayName NullableString `json:"display_name,omitempty"`
	// The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
	Number string `json:"number"`
	// A stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.
	InstitutionAccountId NullableString `json:"institution_account_id,omitempty"`
	// Unique identifier for the institution (brokerage) that holds the account.
	InstitutionId *string `json:"institution_id,omitempty"`
	// Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was opened at the brokerage.
	OpeningDate NullableTime                `json:"opening_date,omitempty"`
	SyncStatus  ConnectionAccountSyncStatus `json:"sync_status"`
	// The account type as provided by the brokerage.
	RawType NullableString `json:"raw_type,omitempty"`
	// Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was funded.
	FundingDate NullableTime `json:"funding_date,omitempty"`
	// Indicates whether the account is a paper (simulated) trading account.
	IsPaper              bool                                 `json:"is_paper"`
	MarketValue          NullableInvestmentAccountMarketValue `json:"market_value,omitempty"`
	AdditionalProperties map[string]interface{}
}

InvestmentAccount An investment/brokerage account under a connection. `opening_date`, `funding_date`, and `market_value` are real-time or cached depending on the caller's plan -- see `Connections_listConnectionAccounts`.

func NewInvestmentAccount added in v1.1.0 

func NewInvestmentAccount(kind string, id string, connectionId string, number string, syncStatus ConnectionAccountSyncStatus, isPaper bool) *InvestmentAccount

NewInvestmentAccount instantiates a new InvestmentAccount 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

func NewInvestmentAccountWithDefaults added in v1.1.0 

func NewInvestmentAccountWithDefaults() *InvestmentAccount

NewInvestmentAccountWithDefaults instantiates a new InvestmentAccount 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

func (*InvestmentAccount) GetConnectionId added in v1.1.0 

func (o *InvestmentAccount) GetConnectionId() string

GetConnectionId returns the ConnectionId field value

func (*InvestmentAccount) GetConnectionIdOk added in v1.1.0 

func (o *InvestmentAccount) GetConnectionIdOk() (*string, bool)

GetConnectionIdOk returns a tuple with the ConnectionId field value and a boolean to check if the value has been set.

func (*InvestmentAccount) GetDisplayName added in v1.1.0 

func (o *InvestmentAccount) GetDisplayName() string

GetDisplayName returns the DisplayName field value if set, zero value otherwise (both if not set or set to explicit null).

func (*InvestmentAccount) GetDisplayNameOk added in v1.1.0 

func (o *InvestmentAccount) GetDisplayNameOk() (*string, bool)

GetDisplayNameOk returns a tuple with the DisplayName field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*InvestmentAccount) GetFundingDate added in v1.1.0 

func (o *InvestmentAccount) GetFundingDate() time.Time

GetFundingDate returns the FundingDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*InvestmentAccount) GetFundingDateOk added in v1.1.0 

func (o *InvestmentAccount) GetFundingDateOk() (*time.Time, bool)

GetFundingDateOk returns a tuple with the FundingDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*InvestmentAccount) GetId added in v1.1.0 

func (o *InvestmentAccount) GetId() string

GetId returns the Id field value

func (*InvestmentAccount) GetIdOk added in v1.1.0 

func (o *InvestmentAccount) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*InvestmentAccount) GetInstitutionAccountId added in v1.1.0 

func (o *InvestmentAccount) GetInstitutionAccountId() string

GetInstitutionAccountId returns the InstitutionAccountId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*InvestmentAccount) GetInstitutionAccountIdOk added in v1.1.0 

func (o *InvestmentAccount) GetInstitutionAccountIdOk() (*string, bool)

GetInstitutionAccountIdOk returns a tuple with the InstitutionAccountId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*InvestmentAccount) GetInstitutionId added in v1.1.0 

func (o *InvestmentAccount) GetInstitutionId() string

GetInstitutionId returns the InstitutionId field value if set, zero value otherwise.

func (*InvestmentAccount) GetInstitutionIdOk added in v1.1.0 

func (o *InvestmentAccount) GetInstitutionIdOk() (*string, bool)

GetInstitutionIdOk returns a tuple with the InstitutionId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*InvestmentAccount) GetIsPaper added in v1.1.0 

func (o *InvestmentAccount) GetIsPaper() bool

GetIsPaper returns the IsPaper field value

func (*InvestmentAccount) GetIsPaperOk added in v1.1.0 

func (o *InvestmentAccount) GetIsPaperOk() (*bool, bool)

GetIsPaperOk returns a tuple with the IsPaper field value and a boolean to check if the value has been set.

func (*InvestmentAccount) GetKind added in v1.1.0 

func (o *InvestmentAccount) GetKind() string

GetKind returns the Kind field value

func (*InvestmentAccount) GetKindOk added in v1.1.0 

func (o *InvestmentAccount) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value and a boolean to check if the value has been set.

func (*InvestmentAccount) GetMarketValue added in v1.1.0 

func (o *InvestmentAccount) GetMarketValue() InvestmentAccountMarketValue

GetMarketValue returns the MarketValue field value if set, zero value otherwise (both if not set or set to explicit null).

func (*InvestmentAccount) GetMarketValueOk added in v1.1.0 

func (o *InvestmentAccount) GetMarketValueOk() (*InvestmentAccountMarketValue, bool)

GetMarketValueOk returns a tuple with the MarketValue field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*InvestmentAccount) GetNumber added in v1.1.0 

func (o *InvestmentAccount) GetNumber() string

GetNumber returns the Number field value

func (*InvestmentAccount) GetNumberOk added in v1.1.0 

func (o *InvestmentAccount) GetNumberOk() (*string, bool)

GetNumberOk returns a tuple with the Number field value and a boolean to check if the value has been set.

func (*InvestmentAccount) GetOpeningDate added in v1.1.0 

func (o *InvestmentAccount) GetOpeningDate() time.Time

GetOpeningDate returns the OpeningDate field value if set, zero value otherwise (both if not set or set to explicit null).

func (*InvestmentAccount) GetOpeningDateOk added in v1.1.0 

func (o *InvestmentAccount) GetOpeningDateOk() (*time.Time, bool)

GetOpeningDateOk returns a tuple with the OpeningDate field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*InvestmentAccount) GetRawType added in v1.1.0 

func (o *InvestmentAccount) GetRawType() string

GetRawType returns the RawType field value if set, zero value otherwise (both if not set or set to explicit null).

func (*InvestmentAccount) GetRawTypeOk added in v1.1.0 

func (o *InvestmentAccount) GetRawTypeOk() (*string, bool)

GetRawTypeOk returns a tuple with the RawType field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*InvestmentAccount) GetSyncStatus added in v1.1.0 

func (o *InvestmentAccount) GetSyncStatus() ConnectionAccountSyncStatus

GetSyncStatus returns the SyncStatus field value

func (*InvestmentAccount) GetSyncStatusOk added in v1.1.0 

func (o *InvestmentAccount) GetSyncStatusOk() (*ConnectionAccountSyncStatus, bool)

GetSyncStatusOk returns a tuple with the SyncStatus field value and a boolean to check if the value has been set.

func (*InvestmentAccount) HasDisplayName added in v1.1.0 

func (o *InvestmentAccount) HasDisplayName() bool

HasDisplayName returns a boolean if a field has been set.

func (*InvestmentAccount) HasFundingDate added in v1.1.0 

func (o *InvestmentAccount) HasFundingDate() bool

HasFundingDate returns a boolean if a field has been set.

func (*InvestmentAccount) HasInstitutionAccountId added in v1.1.0 

func (o *InvestmentAccount) HasInstitutionAccountId() bool

HasInstitutionAccountId returns a boolean if a field has been set.

func (*InvestmentAccount) HasInstitutionId added in v1.1.0 

func (o *InvestmentAccount) HasInstitutionId() bool

HasInstitutionId returns a boolean if a field has been set.

func (*InvestmentAccount) HasMarketValue added in v1.1.0 

func (o *InvestmentAccount) HasMarketValue() bool

HasMarketValue returns a boolean if a field has been set.

func (*InvestmentAccount) HasOpeningDate added in v1.1.0 

func (o *InvestmentAccount) HasOpeningDate() bool

HasOpeningDate returns a boolean if a field has been set.

func (*InvestmentAccount) HasRawType added in v1.1.0 

func (o *InvestmentAccount) HasRawType() bool

HasRawType returns a boolean if a field has been set.

func (InvestmentAccount) MarshalJSON added in v1.1.0 

func (o InvestmentAccount) MarshalJSON() ([]byte, error)

func (*InvestmentAccount) SetConnectionId added in v1.1.0 

func (o *InvestmentAccount) SetConnectionId(v string)

SetConnectionId sets field value

func (*InvestmentAccount) SetDisplayName added in v1.1.0 

func (o *InvestmentAccount) SetDisplayName(v string)

SetDisplayName gets a reference to the given NullableString and assigns it to the DisplayName field.

func (*InvestmentAccount) SetDisplayNameNil added in v1.1.0 

func (o *InvestmentAccount) SetDisplayNameNil()

SetDisplayNameNil sets the value for DisplayName to be an explicit nil

func (*InvestmentAccount) SetFundingDate added in v1.1.0 

func (o *InvestmentAccount) SetFundingDate(v time.Time)

SetFundingDate gets a reference to the given NullableTime and assigns it to the FundingDate field.

func (*InvestmentAccount) SetFundingDateNil added in v1.1.0 

func (o *InvestmentAccount) SetFundingDateNil()

SetFundingDateNil sets the value for FundingDate to be an explicit nil

func (*InvestmentAccount) SetId added in v1.1.0 

func (o *InvestmentAccount) SetId(v string)

SetId sets field value

func (*InvestmentAccount) SetInstitutionAccountId added in v1.1.0 

func (o *InvestmentAccount) SetInstitutionAccountId(v string)

SetInstitutionAccountId gets a reference to the given NullableString and assigns it to the InstitutionAccountId field.

func (*InvestmentAccount) SetInstitutionAccountIdNil added in v1.1.0 

func (o *InvestmentAccount) SetInstitutionAccountIdNil()

SetInstitutionAccountIdNil sets the value for InstitutionAccountId to be an explicit nil

func (*InvestmentAccount) SetInstitutionId added in v1.1.0 

func (o *InvestmentAccount) SetInstitutionId(v string)

SetInstitutionId gets a reference to the given string and assigns it to the InstitutionId field.

func (*InvestmentAccount) SetIsPaper added in v1.1.0 

func (o *InvestmentAccount) SetIsPaper(v bool)

SetIsPaper sets field value

func (*InvestmentAccount) SetKind added in v1.1.0 

func (o *InvestmentAccount) SetKind(v string)

SetKind sets field value

func (*InvestmentAccount) SetMarketValue added in v1.1.0 

func (o *InvestmentAccount) SetMarketValue(v InvestmentAccountMarketValue)

SetMarketValue gets a reference to the given NullableInvestmentAccountMarketValue and assigns it to the MarketValue field.

func (*InvestmentAccount) SetMarketValueNil added in v1.1.0 

func (o *InvestmentAccount) SetMarketValueNil()

SetMarketValueNil sets the value for MarketValue to be an explicit nil

func (*InvestmentAccount) SetNumber added in v1.1.0 

func (o *InvestmentAccount) SetNumber(v string)

SetNumber sets field value

func (*InvestmentAccount) SetOpeningDate added in v1.1.0 

func (o *InvestmentAccount) SetOpeningDate(v time.Time)

SetOpeningDate gets a reference to the given NullableTime and assigns it to the OpeningDate field.

func (*InvestmentAccount) SetOpeningDateNil added in v1.1.0 

func (o *InvestmentAccount) SetOpeningDateNil()

SetOpeningDateNil sets the value for OpeningDate to be an explicit nil

func (*InvestmentAccount) SetRawType added in v1.1.0 

func (o *InvestmentAccount) SetRawType(v string)

SetRawType gets a reference to the given NullableString and assigns it to the RawType field.

func (*InvestmentAccount) SetRawTypeNil added in v1.1.0 

func (o *InvestmentAccount) SetRawTypeNil()

SetRawTypeNil sets the value for RawType to be an explicit nil

func (*InvestmentAccount) SetSyncStatus added in v1.1.0 

func (o *InvestmentAccount) SetSyncStatus(v ConnectionAccountSyncStatus)

SetSyncStatus sets field value

func (*InvestmentAccount) UnmarshalJSON added in v1.1.0 

func (o *InvestmentAccount) UnmarshalJSON(bytes []byte) (err error)

func (*InvestmentAccount) UnsetDisplayName added in v1.1.0 

func (o *InvestmentAccount) UnsetDisplayName()

UnsetDisplayName ensures that no value is present for DisplayName, not even an explicit nil

func (*InvestmentAccount) UnsetFundingDate added in v1.1.0 

func (o *InvestmentAccount) UnsetFundingDate()

UnsetFundingDate ensures that no value is present for FundingDate, not even an explicit nil

func (*InvestmentAccount) UnsetInstitutionAccountId added in v1.1.0 

func (o *InvestmentAccount) UnsetInstitutionAccountId()

UnsetInstitutionAccountId ensures that no value is present for InstitutionAccountId, not even an explicit nil

func (*InvestmentAccount) UnsetMarketValue added in v1.1.0 

func (o *InvestmentAccount) UnsetMarketValue()

UnsetMarketValue ensures that no value is present for MarketValue, not even an explicit nil

func (*InvestmentAccount) UnsetOpeningDate added in v1.1.0 

func (o *InvestmentAccount) UnsetOpeningDate()

UnsetOpeningDate ensures that no value is present for OpeningDate, not even an explicit nil

func (*InvestmentAccount) UnsetRawType added in v1.1.0 

func (o *InvestmentAccount) UnsetRawType()

UnsetRawType ensures that no value is present for RawType, not even an explicit nil

type InvestmentAccountMarketValue added in v1.1.0 

type InvestmentAccountMarketValue struct {
	Amount               NullableFloat32 `json:"amount,omitempty"`
	Currency             NullableString  `json:"currency,omitempty"`
	AdditionalProperties map[string]interface{}
}

InvestmentAccountMarketValue Total market value of the account. Null when unknown (e.g. a real-time fetch failed and no cached value exists).

func NewInvestmentAccountMarketValue added in v1.1.0 

func NewInvestmentAccountMarketValue() *InvestmentAccountMarketValue

NewInvestmentAccountMarketValue instantiates a new InvestmentAccountMarketValue 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

func NewInvestmentAccountMarketValueWithDefaults added in v1.1.0 

func NewInvestmentAccountMarketValueWithDefaults() *InvestmentAccountMarketValue

NewInvestmentAccountMarketValueWithDefaults instantiates a new InvestmentAccountMarketValue 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

func (*InvestmentAccountMarketValue) GetAmount added in v1.1.0 

func (o *InvestmentAccountMarketValue) GetAmount() float32

GetAmount returns the Amount field value if set, zero value otherwise (both if not set or set to explicit null).

func (*InvestmentAccountMarketValue) GetAmountOk added in v1.1.0 

func (o *InvestmentAccountMarketValue) GetAmountOk() (*float32, bool)

GetAmountOk returns a tuple with the Amount field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*InvestmentAccountMarketValue) GetCurrency added in v1.1.0 

func (o *InvestmentAccountMarketValue) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise (both if not set or set to explicit null).

func (*InvestmentAccountMarketValue) GetCurrencyOk added in v1.1.0 

func (o *InvestmentAccountMarketValue) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*InvestmentAccountMarketValue) HasAmount added in v1.1.0 

func (o *InvestmentAccountMarketValue) HasAmount() bool

HasAmount returns a boolean if a field has been set.

func (*InvestmentAccountMarketValue) HasCurrency added in v1.1.0 

func (o *InvestmentAccountMarketValue) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (InvestmentAccountMarketValue) MarshalJSON added in v1.1.0 

func (o InvestmentAccountMarketValue) MarshalJSON() ([]byte, error)

func (*InvestmentAccountMarketValue) SetAmount added in v1.1.0 

func (o *InvestmentAccountMarketValue) SetAmount(v float32)

SetAmount ge