# README
Go API client for openapi
TD Ameritrade API
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 3.0.1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import sw "./openapi"
To use a proxy, set the environment variable HTTP_PROXY:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Configuration of Server URL
Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.
Select Server Configuration
For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.
ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.
ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers map in the Configuration.
An operation is uniquely identifield by "{classname}Service.{nickname}" string.
Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
Documentation for API Endpoints
All URIs are relative to https://api.tdameritrade.com/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountsAndTradingApi | CancelOrder | Delete /accounts/{accountId}/orders/{orderId} | Cancel Order |
| AccountsAndTradingApi | DeleteSavedOrder | Delete /accounts/{accountId}/savedorders/{savedOrderId} | Delete Saved Order |
| AccountsAndTradingApi | GetAccount | Get /accounts/{accountId} | Get Account |
| AccountsAndTradingApi | GetAccounts | Get /accounts | Get Accounts |
| AccountsAndTradingApi | GetOrder | Get /accounts/{accountId}/orders/{orderId} | Get Order |
| AccountsAndTradingApi | GetOrdersByPath | Get /accounts/{accountId}/orders | Get Orders By Path |
| AccountsAndTradingApi | GetOrdersByQuery | Get /orders | Get Orders By Query |
| AccountsAndTradingApi | GetSavedOrder | Get /accounts/{accountId}/savedorders/{savedOrderId} | Get Saved Order |
| AccountsAndTradingApi | GetSavedOrdersByPath | Get /accounts/{accountId}/savedorders | Get Saved Orders by Path |
| AccountsAndTradingApi | PlaceOrder | Post /accounts/{accountId}/orders | Place Order |
| AccountsAndTradingApi | ReplaceOrder | Put /accounts/{accountId}/orders/{orderId} | Replace Order |
| AccountsAndTradingApi | ReplaceSavedOrder | Put /accounts/{accountId}/savedorders/{savedOrderId} | Replace Saved Order |
| AccountsAndTradingApi | SaveOrder | Post /accounts/{accountId}/savedorders | Create Saved Order |
| AuthenticationApi | PostAccessToken | Post /oath2/token | Post Access Token |
| InstrumentsApi | GetInstrument | Get /instruments/{accountId} | Search for instrument and fundamental data |
| InstrumentsApi | SearchInstruments | Get /instruments | Search for instrument and fundamental data |
| MarketHoursApi | GetHours | Get /marketdata/hours | Operating hours of markets |
| MarketHoursApi | GetMarketHours | Get /marketdata/{market}/hours | Operating hours of markets |
| MoversApi | GetMovers | Get /marketdata/{index}/movers | Retrieve mover information by index symbol, direction type and change |
| OptionChainsApi | GetOptionChains | Get /marketdata/chains | Get Option Chains for optionable symbols |
| PriceHistoryApi | GetPriceHistory | Get /marketdata/{symbol}/pricehistory | Historical price data for charts |
| QuotesApi | GetQuote | Get /marketdata/{symbol}/quotes | Search for instrument and fundamental data |
| QuotesApi | GetQuotes | Get /marketdata/quotes | Search for instrument and fundamental data |
| TransactionHistoryApi | GetTransaction | Get /accounts/{accountId}/transactions/{transactionId} | APIs to access transaction history on the account |
| TransactionHistoryApi | GetTransactions | Get /accounts/{accountId}/transactions | APIs to access transaction history on the account |
| UserInfoPreferencesApi | GetPreferences | Get /accounts/{accountId}/preferences | APIs to access user-authorized accounts and their preferences |
| UserInfoPreferencesApi | GetStreamerSubscriptionKeys | Get /userprincipals/streamersubscriptionkeys | APIs to access user-authorized accounts and their preferences |
| UserInfoPreferencesApi | GetUserPrincipals | Get /userprincipals | APIs to access user-authorized accounts and their preferences |
| UserInfoPreferencesApi | UpdatePreferences | Put /accounts/{accountId}/preferences | APIs to access user-authorized accounts and their preferences |
| WatchlistApi | CreateWatchlist | Post /accounts/{accountId}/watchlists | APIs to perform CRUD operations on Account Watchlist |
| WatchlistApi | DeleteWatchlist | Delete /accounts/{accountId}/watchlists/{watchlistId} | APIs to perform CRUD operations on Account Watchlist |
| WatchlistApi | GetWatchlist | Get /accounts/{accountId}/watchlists/{watchlistId} | APIs to perform CRUD operations on Account Watchlist |
| WatchlistApi | GetWatchlistMultipleAccounts | Get /accounts/watchlists | APIs to perform CRUD operations on Account Watchlist |
| WatchlistApi | GetWatchlistSingleAccount | Get /accounts/{accountId}/watchlists | APIs to perform CRUD operations on Account Watchlist |
| WatchlistApi | ReplaceWatchlist | Put /accounts/{accountId}/watchlists/{watchlistId} | APIs to perform CRUD operations on Account Watchlist |
| WatchlistApi | UpdateWatchlist | Patch /accounts/{accountId}/watchlists/{watchlistId} | APIs to perform CRUD operations on Account Watchlist |
Documentation For Models
- Account
- AccountType
- AssetType
- Bond
- CandleList
- CandleListCandles
- CashAccount
- CashAccountCancelTime
- CashAccountCurrentBalances
- CashAccountInitialBalances
- CashAccountOrderLegCollection
- CashAccountOrderStrategies
- CashAccountPositions
- CashEquivalent
- ComplexOrderStrategyType
- CreateWatchlist
- CreateWatchlistInstrument
- CreateWatchlistWatchlistItems
- CurrencyType
- DestinationExchange
- Duration
- EASObject
- ETF
- Equity
- EquityPriceLinkType
- Execution
- ExecutionExecutionLegs
- ExpirationDate
- FixedIncome
- Forex
- Fundamental
- FundamentalData
- FundamentalFundamental
- Future
- FutureOptions
- Hours
- Index
- Instruction
- Instrument
- InstrumentType
- MarginAccount
- MarginAccountCurrentBalances
- MarginAccountInitialBalances
- MarginAccountOrderStrategies
- Mover
- MutualFund
- Option
- OptionChain
- OptionChainUnderlying
- OptionDeliverables
- OptionOptionDeliverables
- OptionType
- Order
- OrderChildOrderStrategies
- OrderOrderLegCollection
- OrderStatus
- OrderStrategyType
- OrderType
- PositionEffect
- Preferences
- PriceLinkBasis
- PriceLinkType
- PutOrCall
- QuantityType
- SavedOrder
- SavedOrderChildOrderStrategies
- Session
- SpecialInstruction
- StopType
- Strategy
- SubscriptionKey
- SubscriptionKeyKeys
- TaxLotMethod
- Transaction
- TransactionTransactionItem
- TransactionTransactionItemInstrument
- TransactionType
- Underlying
- UpdatePreferences
- UpdateWatchlist
- UpdateWatchlistWatchlistItems
- UserPrincipal
- UserPrincipalAccounts
- UserPrincipalAuthorizations
- UserPrincipalPreferences
- UserPrincipalQuotes
- UserPrincipalStreamerInfo
- UserPrincipalStreamerSubscriptionKeys
- Watchlist
- WatchlistInstrument
- WatchlistWatchlistItems
Documentation For Authorization
Bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBoolPtrIntPtrInt32PtrInt64PtrFloatPtrFloat32PtrFloat64PtrStringPtrTime
Author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
CashAccountAsAccountType is a convenience function that returns CashAccount wrapped in AccountType.
CashEquivalentAsInstrumentType is a convenience function that returns CashEquivalent wrapped in InstrumentType.
EquityAsInstrumentType is a convenience function that returns Equity wrapped in InstrumentType.
FixedIncomeAsInstrumentType is a convenience function that returns FixedIncome wrapped in InstrumentType.
MarginAccountAsAccountType is a convenience function that returns MarginAccount wrapped in AccountType.
MutualFundAsInstrumentType is a convenience function that returns MutualFund wrapped in InstrumentType.
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.
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.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewBond instantiates a new Bond 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.
NewBondWithDefaults instantiates a new Bond 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.
NewCandleList instantiates a new CandleList 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.
NewCandleListCandles instantiates a new CandleListCandles 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.
NewCandleListCandlesWithDefaults instantiates a new CandleListCandles 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.
NewCandleListWithDefaults instantiates a new CandleList 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.
NewCashAccount instantiates a new CashAccount 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.
NewCashAccountCancelTime instantiates a new CashAccountCancelTime 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.
NewCashAccountCancelTimeWithDefaults instantiates a new CashAccountCancelTime 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.
NewCashAccountCurrentBalances instantiates a new CashAccountCurrentBalances 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.
NewCashAccountCurrentBalancesWithDefaults instantiates a new CashAccountCurrentBalances 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.
NewCashAccountInitialBalances instantiates a new CashAccountInitialBalances 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.
NewCashAccountInitialBalancesWithDefaults instantiates a new CashAccountInitialBalances 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.
NewCashAccountOrderLegCollection instantiates a new CashAccountOrderLegCollection 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.
NewCashAccountOrderLegCollectionWithDefaults instantiates a new CashAccountOrderLegCollection 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.
NewCashAccountOrderStrategies instantiates a new CashAccountOrderStrategies 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.
NewCashAccountOrderStrategiesWithDefaults instantiates a new CashAccountOrderStrategies 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.
NewCashAccountPositions instantiates a new CashAccountPositions 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.
NewCashAccountPositionsWithDefaults instantiates a new CashAccountPositions 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.
NewCashAccountWithDefaults instantiates a new CashAccount 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.
NewCashEquivalent instantiates a new CashEquivalent 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.
NewCashEquivalentWithDefaults instantiates a new CashEquivalent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewCreateWatchlist instantiates a new CreateWatchlist 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.
NewCreateWatchlistInstrument instantiates a new CreateWatchlistInstrument 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.
NewCreateWatchlistInstrumentWithDefaults instantiates a new CreateWatchlistInstrument 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.
NewCreateWatchlistWatchlistItems instantiates a new CreateWatchlistWatchlistItems 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.
NewCreateWatchlistWatchlistItemsWithDefaults instantiates a new CreateWatchlistWatchlistItems 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.
NewCreateWatchlistWithDefaults instantiates a new CreateWatchlist 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.
NewEASObject instantiates a new EASObject 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.
NewEASObjectWithDefaults instantiates a new EASObject 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.
NewEquity instantiates a new Equity 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.
NewEquityWithDefaults instantiates a new Equity 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.
NewETF instantiates a new ETF 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.
NewETFWithDefaults instantiates a new ETF 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.
NewExecution instantiates a new Execution 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.
NewExecutionExecutionLegs instantiates a new ExecutionExecutionLegs 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.
NewExecutionExecutionLegsWithDefaults instantiates a new ExecutionExecutionLegs 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.
NewExecutionWithDefaults instantiates a new Execution 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.
NewExpirationDate instantiates a new ExpirationDate 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.
NewExpirationDateWithDefaults instantiates a new ExpirationDate 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.
NewFixedIncome instantiates a new FixedIncome 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.
NewFixedIncomeWithDefaults instantiates a new FixedIncome 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.
NewForex instantiates a new Forex 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.
NewForexWithDefaults instantiates a new Forex 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.
NewFundamental instantiates a new Fundamental 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.
NewFundamentalData instantiates a new FundamentalData 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.
NewFundamentalDataWithDefaults instantiates a new FundamentalData 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.
NewFundamentalFundamental instantiates a new FundamentalFundamental 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.
NewFundamentalFundamentalWithDefaults instantiates a new FundamentalFundamental 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.
NewFundamentalWithDefaults instantiates a new Fundamental 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.
NewFuture instantiates a new Future 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.
NewFutureOptions instantiates a new FutureOptions 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.
NewFutureOptionsWithDefaults instantiates a new FutureOptions 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.
NewFutureWithDefaults instantiates a new Future 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.
NewHours instantiates a new Hours 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.
NewHoursWithDefaults instantiates a new Hours 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.
NewIndex instantiates a new Index 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.
NewIndexWithDefaults instantiates a new Index 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.
NewInstrument instantiates a new Instrument 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.
NewInstrumentWithDefaults instantiates a new Instrument 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.
NewMarginAccount instantiates a new MarginAccount 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.
NewMarginAccountCurrentBalances instantiates a new MarginAccountCurrentBalances 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.
NewMarginAccountCurrentBalancesWithDefaults instantiates a new MarginAccountCurrentBalances 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.
NewMarginAccountInitialBalances instantiates a new MarginAccountInitialBalances 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.
NewMarginAccountInitialBalancesWithDefaults instantiates a new MarginAccountInitialBalances 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.
NewMarginAccountOrderStrategies instantiates a new MarginAccountOrderStrategies 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.
NewMarginAccountOrderStrategiesWithDefaults instantiates a new MarginAccountOrderStrategies 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.
NewMarginAccountWithDefaults instantiates a new MarginAccount 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.
NewMover instantiates a new Mover 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.
NewMoverWithDefaults instantiates a new Mover 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.
NewMutualFund instantiates a new MutualFund 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.
NewMutualFundWithDefaults instantiates a new MutualFund object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewOption instantiates a new Option 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.
NewOptionChain instantiates a new OptionChain 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.
NewOptionChainUnderlying instantiates a new OptionChainUnderlying 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.
NewOptionChainUnderlyingWithDefaults instantiates a new OptionChainUnderlying 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.
NewOptionChainWithDefaults instantiates a new OptionChain 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.
NewOptionDeliverables instantiates a new OptionDeliverables 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.
NewOptionDeliverablesWithDefaults instantiates a new OptionDeliverables 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.
NewOptionOptionDeliverables instantiates a new OptionOptionDeliverables 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.
NewOptionOptionDeliverablesWithDefaults instantiates a new OptionOptionDeliverables 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.
NewOptionWithDefaults instantiates a new Option 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.
NewOrder instantiates a new Order 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.
NewOrderChildOrderStrategies instantiates a new OrderChildOrderStrategies 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.
NewOrderChildOrderStrategiesWithDefaults instantiates a new OrderChildOrderStrategies 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.
NewOrderOrderLegCollection instantiates a new OrderOrderLegCollection 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.
NewOrderOrderLegCollectionWithDefaults instantiates a new OrderOrderLegCollection 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.
NewOrderWithDefaults instantiates a new Order 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.
NewPreferences instantiates a new Preferences 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.
NewPreferencesWithDefaults instantiates a new Preferences 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.
NewSavedOrder instantiates a new SavedOrder 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.
NewSavedOrderChildOrderStrategies instantiates a new SavedOrderChildOrderStrategies 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.
NewSavedOrderChildOrderStrategiesWithDefaults instantiates a new SavedOrderChildOrderStrategies 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.
NewSavedOrderWithDefaults instantiates a new SavedOrder 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.
NewSubscriptionKey instantiates a new SubscriptionKey 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.
NewSubscriptionKeyKeys instantiates a new SubscriptionKeyKeys 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.
NewSubscriptionKeyKeysWithDefaults instantiates a new SubscriptionKeyKeys 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.
NewSubscriptionKeyWithDefaults instantiates a new SubscriptionKey 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.
NewTransaction instantiates a new Transaction 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.
NewTransactionTransactionItem instantiates a new TransactionTransactionItem 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.
NewTransactionTransactionItemInstrument instantiates a new TransactionTransactionItemInstrument 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.
NewTransactionTransactionItemInstrumentWithDefaults instantiates a new TransactionTransactionItemInstrument 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.
NewTransactionTransactionItemWithDefaults instantiates a new TransactionTransactionItem 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.
NewTransactionWithDefaults instantiates a new Transaction 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.
NewUnderlying instantiates a new Underlying 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.
NewUnderlyingWithDefaults instantiates a new Underlying 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.
NewUpdatePreferences instantiates a new UpdatePreferences 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.
NewUpdatePreferencesWithDefaults instantiates a new UpdatePreferences 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.
NewUpdateWatchlist instantiates a new UpdateWatchlist 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.
NewUpdateWatchlistWatchlistItems instantiates a new UpdateWatchlistWatchlistItems 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.
NewUpdateWatchlistWatchlistItemsWithDefaults instantiates a new UpdateWatchlistWatchlistItems 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.
NewUpdateWatchlistWithDefaults instantiates a new UpdateWatchlist 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.
NewUserPrincipal instantiates a new UserPrincipal 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.
NewUserPrincipalAccounts instantiates a new UserPrincipalAccounts 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.
NewUserPrincipalAccountsWithDefaults instantiates a new UserPrincipalAccounts 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.
NewUserPrincipalAuthorizations instantiates a new UserPrincipalAuthorizations 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.
NewUserPrincipalAuthorizationsWithDefaults instantiates a new UserPrincipalAuthorizations 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.
NewUserPrincipalPreferences instantiates a new UserPrincipalPreferences 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.
NewUserPrincipalPreferencesWithDefaults instantiates a new UserPrincipalPreferences 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.
NewUserPrincipalQuotes instantiates a new UserPrincipalQuotes 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.
NewUserPrincipalQuotesWithDefaults instantiates a new UserPrincipalQuotes 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.
NewUserPrincipalStreamerInfo instantiates a new UserPrincipalStreamerInfo 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.
NewUserPrincipalStreamerInfoWithDefaults instantiates a new UserPrincipalStreamerInfo 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.
NewUserPrincipalStreamerSubscriptionKeys instantiates a new UserPrincipalStreamerSubscriptionKeys 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.
NewUserPrincipalStreamerSubscriptionKeysWithDefaults instantiates a new UserPrincipalStreamerSubscriptionKeys 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.
NewUserPrincipalWithDefaults instantiates a new UserPrincipal 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.
NewWatchlist instantiates a new Watchlist 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.
NewWatchlistInstrument instantiates a new WatchlistInstrument 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.
NewWatchlistInstrumentWithDefaults instantiates a new WatchlistInstrument 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.
NewWatchlistWatchlistItems instantiates a new WatchlistWatchlistItems 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.
NewWatchlistWatchlistItemsWithDefaults instantiates a new WatchlistWatchlistItems 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.
NewWatchlistWithDefaults instantiates a new Watchlist 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.
OptionAsInstrumentType is a convenience function that returns Option wrapped in InstrumentType.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
# Constants
List of AssetType.
List of AssetType.
List of AssetType.
List of AssetType.
List of AssetType.
List of AssetType.
List of AssetType.
List of AssetType.
List of AssetType.
List of AssetType.
List of AssetType.
List of AssetType.
List of AssetType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of ComplexOrderStrategyType.
List of CurrencyType.
List of CurrencyType.
List of CurrencyType.
List of CurrencyType.
List of DestinationExchange.
List of DestinationExchange.
List of DestinationExchange.
List of DestinationExchange.
List of DestinationExchange.
List of DestinationExchange.
List of DestinationExchange.
List of DestinationExchange.
List of DestinationExchange.
List of DestinationExchange.
List of DestinationExchange.
List of DestinationExchange.
List of Duration.
List of Duration.
List of Duration.
List of EquityPriceLinkType.
List of EquityPriceLinkType.
List of Instruction.
List of Instruction.
List of Instruction.
List of Instruction.
List of Instruction.
List of Instruction.
List of Instruction.
List of Instruction.
List of OptionType.
List of OptionType.
List of OptionType.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStatus.
List of OrderStrategyType.
List of OrderStrategyType.
List of OrderStrategyType.
List of OrderType.
List of OrderType.
List of OrderType.
List of OrderType.
List of OrderType.
List of OrderType.
List of OrderType.
List of OrderType.
List of OrderType.
List of OrderType.
List of OrderType.
List of PositionEffect.
List of PositionEffect.
List of PositionEffect.
List of PriceLinkBasis.
List of PriceLinkBasis.
List of PriceLinkBasis.
List of PriceLinkBasis.
List of PriceLinkBasis.
List of PriceLinkBasis.
List of PriceLinkBasis.
List of PriceLinkBasis.
List of PriceLinkBasis.
List of PriceLinkType.
List of PriceLinkType.
List of PriceLinkType.
List of PutOrCall.
List of PutOrCall.
List of PutOrCall.
List of QuantityType.
List of QuantityType.
List of QuantityType.
List of Session.
List of Session.
List of Session.
List of Session.
List of SpecialInstruction.
List of SpecialInstruction.
List of SpecialInstruction.
List of StopType.
List of StopType.
List of StopType.
List of StopType.
List of StopType.
List of Strategy.
List of Strategy.
List of Strategy.
List of Strategy.
List of Strategy.
List of Strategy.
List of Strategy.
List of Strategy.
List of Strategy.
List of Strategy.
List of Strategy.
List of Strategy.
List of TaxLotMethod.
List of TaxLotMethod.
List of TaxLotMethod.
List of TaxLotMethod.
List of TaxLotMethod.
List of TaxLotMethod.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
# Structs
Account struct for Account.
AccountType - struct for AccountType.
No description provided by the author
APIClient manages communication with the TD Ameritrade API API v3.0.1 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Bond struct for Bond.
CandleList struct for CandleList.
CandleListCandles struct for CandleListCandles.
CashAccount struct for CashAccount.
CashAccountCancelTime struct for CashAccountCancelTime.
CashAccountCurrentBalances struct for CashAccountCurrentBalances.
CashAccountInitialBalances struct for CashAccountInitialBalances.
CashAccountOrderLegCollection struct for CashAccountOrderLegCollection.
CashAccountOrderStrategies struct for CashAccountOrderStrategies.
CashAccountPositions struct for CashAccountPositions.
CashEquivalent struct for CashEquivalent.
Configuration stores the configuration of the API client.
CreateWatchlist struct for CreateWatchlist.
CreateWatchlistInstrument struct for CreateWatchlistInstrument.
CreateWatchlistWatchlistItems struct for CreateWatchlistWatchlistItems.
EASObject struct for EASObject.
Equity struct for Equity.
ETF struct for ETF.
Execution struct for Execution.
ExecutionExecutionLegs struct for ExecutionExecutionLegs.
ExpirationDate struct for ExpirationDate.
FixedIncome struct for FixedIncome.
Forex struct for Forex.
Fundamental struct for Fundamental.
FundamentalData struct for FundamentalData.
FundamentalFundamental struct for FundamentalFundamental.
Future struct for Future.
FutureOptions struct for FutureOptions.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
Hours struct for Hours.
Index struct for Index.
Instrument struct for Instrument.
InstrumentType - struct for InstrumentType.
MarginAccount struct for MarginAccount.
MarginAccountCurrentBalances struct for MarginAccountCurrentBalances.
MarginAccountInitialBalances struct for MarginAccountInitialBalances.
MarginAccountOrderStrategies struct for MarginAccountOrderStrategies.
Mover struct for Mover.
MutualFund struct for MutualFund.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Option struct for Option.
OptionChain struct for OptionChain.
OptionChainUnderlying struct for OptionChainUnderlying.
OptionDeliverables struct for OptionDeliverables.
OptionOptionDeliverables struct for OptionOptionDeliverables.
Order struct for Order.
OrderCancelTime struct for OrderCancelTime.
OrderChildOrderStrategies struct for OrderChildOrderStrategies.
OrderOrderLegCollection struct for OrderOrderLegCollection.
Preferences struct for Preferences.
SavedOrder struct for SavedOrder.
SavedOrderChildOrderStrategies struct for SavedOrderChildOrderStrategies.
SavedOrderOrderLegCollection struct for SavedOrderOrderLegCollection.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
SubscriptionKey struct for SubscriptionKey.
SubscriptionKeyKeys struct for SubscriptionKeyKeys.
Transaction struct for Transaction.
TransactionTransactionItem struct for TransactionTransactionItem.
TransactionTransactionItemInstrument struct for TransactionTransactionItemInstrument.
Underlying struct for Underlying.
UpdatePreferences struct for UpdatePreferences.
UpdateWatchlist struct for UpdateWatchlist.
UpdateWatchlistWatchlistItems struct for UpdateWatchlistWatchlistItems.
UserPrincipal struct for UserPrincipal.
UserPrincipalAccounts struct for UserPrincipalAccounts.
UserPrincipalAuthorizations struct for UserPrincipalAuthorizations.
UserPrincipalPreferences struct for UserPrincipalPreferences.
UserPrincipalQuotes struct for UserPrincipalQuotes.
UserPrincipalStreamerInfo struct for UserPrincipalStreamerInfo.
UserPrincipalStreamerSubscriptionKeys struct for UserPrincipalStreamerSubscriptionKeys.
Watchlist struct for Watchlist.
WatchlistInstrument struct for WatchlistInstrument.
WatchlistWatchlistItems struct for WatchlistWatchlistItems.
# Type aliases
AccountsAndTradingApiService AccountsAndTradingApi service.
AssetType the model 'AssetType'.
AuthenticationApiService AuthenticationApi service.
ComplexOrderStrategyType the model 'ComplexOrderStrategyType'.
CurrencyType the model 'CurrencyType'.
DestinationExchange the model 'DestinationExchange'.
Duration the model 'Duration'.
EquityPriceLinkType the model 'EquityPriceLinkType'.
Instruction the model 'Instruction'.
InstrumentsApiService InstrumentsApi service.
MarketHoursApiService MarketHoursApi service.
MoversApiService MoversApi service.
OptionChainsApiService OptionChainsApi service.
OptionType the model 'OptionType'.
OrderStatus the model 'OrderStatus'.
OrderStrategyType the model 'OrderStrategyType'.
OrderType the model 'OrderType'.
PositionEffect the model 'PositionEffect'.
PriceHistoryApiService PriceHistoryApi service.
PriceLinkBasis the model 'PriceLinkBasis'.
PriceLinkType the model 'PriceLinkType'.
PutOrCall the model 'PutOrCall'.
QuantityType the model 'QuantityType'.
QuotesApiService QuotesApi service.
ServerConfigurations stores multiple ServerConfiguration items.
Session the model 'Session'.
SpecialInstruction the model 'SpecialInstruction'.
StopType the model 'StopType'.
Strategy the model 'Strategy'.
TaxLotMethod the model 'TaxLotMethod'.
TransactionHistoryApiService TransactionHistoryApi service.
TransactionType the model 'TransactionType'.
UserInfoPreferencesApiService UserInfoPreferencesApi service.
WatchlistApiService WatchlistApi service.