# 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

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:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Author

[email protected]