@gitchrisqueen/tdameritrade-api-js-client/nodejs-clientES5/README.md

TD Ameritrade API integration for node.js

# @gitchrisqueen/tdameritrade-api-js-client

GitChrisQueen_TDA_JS - JavaScript client for @gitchrisqueen/tdameritrade-api-js-client
This is replication of the TD Ameritrade API.
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 0.1.4
- Package version: 0.1.4
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @gitchrisqueen/tdameritrade-api-js-client --save
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing 
into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

Finally, switch to the directory you want to use your @gitchrisqueen/tdameritrade-api-js-client from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

You should now be able to `require('@gitchrisqueen/tdameritrade-api-js-client')` in javascript files from the directory you ran the last 
command above from.

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/gitchrisqueen/https://github.com/gitchrisqueen/tdameritrade-api
then install it via:

```shell
    npm install gitchrisqueen/https://github.com/gitchrisqueen/tdameritrade-api --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually 
use this library):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var GitChrisQueen_TDA_JS = require('@gitchrisqueen/tdameritrade-api-js-client');

var defaultClient = GitChrisQueen_TDA_JS.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new GitChrisQueen_TDA_JS.AccountsApi()

var accountId = 56; // {Number} 

var opts = { 
  'fields': "fields_example" // {String} Balances displayed by default, additional fields can be added here by adding positions or orders. Example: fields=positions,orders
};
api.accountsAccountIdGET(accountId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*GitChrisQueen_TDA_JS.AccountsApi* | [**accountsAccountIdGET**](docs/AccountsApi.md#accountsAccountIdGET) | **GET** /accounts/{accountId} | Get Account
*GitChrisQueen_TDA_JS.AccountsApi* | [**accountsGET**](docs/AccountsApi.md#accountsGET) | **GET** /accounts | Get Accounts
*GitChrisQueen_TDA_JS.AuthenticationApi* | [**oauth2TokenPOST**](docs/AuthenticationApi.md#oauth2TokenPOST) | **POST** /oauth2/token | Post Access Token
*GitChrisQueen_TDA_JS.InstrumentsApi* | [**instrumentsCusipGET**](docs/InstrumentsApi.md#instrumentsCusipGET) | **GET** /instruments/{cusip} | Get Instrument
*GitChrisQueen_TDA_JS.InstrumentsApi* | [**instrumentsGET**](docs/InstrumentsApi.md#instrumentsGET) | **GET** /instruments | Search Instruments
*GitChrisQueen_TDA_JS.MarketHoursApi* | [**marketdataHoursGET**](docs/MarketHoursApi.md#marketdataHoursGET) | **GET** /marketdata/hours | Get Hours for Multiple Markets
*GitChrisQueen_TDA_JS.MarketHoursApi* | [**marketdataMarketHoursGET**](docs/MarketHoursApi.md#marketdataMarketHoursGET) | **GET** /marketdata/{market}/hours | Get Hours for Multiple Markets
*GitChrisQueen_TDA_JS.MoversApi* | [**marketdataIndexMoversGET**](docs/MoversApi.md#marketdataIndexMoversGET) | **GET** /marketdata/{index}/movers | Get price history for a symbol
*GitChrisQueen_TDA_JS.OptionChainsApi* | [**marketdataChainsGET**](docs/OptionChainsApi.md#marketdataChainsGET) | **GET** /marketdata/chains | Get Option Chain
*GitChrisQueen_TDA_JS.OrdersApi* | [**accountsAccountIdOrdersGET**](docs/OrdersApi.md#accountsAccountIdOrdersGET) | **GET** /accounts/{accountId}/orders | Get Orders by Path
*GitChrisQueen_TDA_JS.OrdersApi* | [**accountsAccountIdOrdersOrderIdDELETE**](docs/OrdersApi.md#accountsAccountIdOrdersOrderIdDELETE) | **DELETE** /accounts/{accountId}/orders/{orderId} | Cancel Order
*GitChrisQueen_TDA_JS.OrdersApi* | [**accountsAccountIdOrdersOrderIdGET**](docs/OrdersApi.md#accountsAccountIdOrdersOrderIdGET) | **GET** /accounts/{accountId}/orders/{orderId} | Get Order
*GitChrisQueen_TDA_JS.OrdersApi* | [**accountsAccountIdOrdersOrderIdPUT**](docs/OrdersApi.md#accountsAccountIdOrdersOrderIdPUT) | **PUT** /accounts/{accountId}/orders/{orderId} | Replace Order
*GitChrisQueen_TDA_JS.OrdersApi* | [**ordersGET**](docs/OrdersApi.md#ordersGET) | **GET** /orders | Get Orders By Query
*GitChrisQueen_TDA_JS.OrdersApi* | [**ordersPOST**](docs/OrdersApi.md#ordersPOST) | **POST** /orders | Place Order
*GitChrisQueen_TDA_JS.PriceHistoryApi* | [**marketdataSymbolPricehistoryGET**](docs/PriceHistoryApi.md#marketdataSymbolPricehistoryGET) | **GET** /marketdata/{symbol}/pricehistory | Get price history for a symbol
*GitChrisQueen_TDA_JS.QuotesApi* | [**marketdataQuotesGET**](docs/QuotesApi.md#marketdataQuotesGET) | **GET** /marketdata/quotes | Get Quotes
*GitChrisQueen_TDA_JS.QuotesApi* | [**marketdataSymbolQuotesGET**](docs/QuotesApi.md#marketdataSymbolQuotesGET) | **GET** /marketdata/{symbol}/quotes | Get Quote
*GitChrisQueen_TDA_JS.SavedOrdersApi* | [**accountsAccountIdSavedordersGET**](docs/SavedOrdersApi.md#accountsAccountIdSavedordersGET) | **GET** /accounts/{accountId}/savedorders | Get Saved Orders by Path
*GitChrisQueen_TDA_JS.SavedOrdersApi* | [**accountsAccountIdSavedordersPOST**](docs/SavedOrdersApi.md#accountsAccountIdSavedordersPOST) | **POST** /accounts/{accountId}/savedorders | Create Saved Orders
*GitChrisQueen_TDA_JS.SavedOrdersApi* | [**accountsAccountIdSavedordersSavedOrderIdDELETE**](docs/SavedOrdersApi.md#accountsAccountIdSavedordersSavedOrderIdDELETE) | **DELETE** /accounts/{accountId}/savedorders/{savedOrderId} | Delete Saved Orders
*GitChrisQueen_TDA_JS.SavedOrdersApi* | [**accountsAccountIdSavedordersSavedOrderIdGET**](docs/SavedOrdersApi.md#accountsAccountIdSavedordersSavedOrderIdGET) | **GET** /accounts/{accountId}/savedorders/{savedOrderId} | Get Saved Orders
*GitChrisQueen_TDA_JS.SavedOrdersApi* | [**accountsAccountIdSavedordersSavedOrderIdPUT**](docs/SavedOrdersApi.md#accountsAccountIdSavedordersSavedOrderIdPUT) | **PUT** /accounts/{accountId}/savedorders/{savedOrderId} | Replace Saved Orders
*GitChrisQueen_TDA_JS.TransactionsApi* | [**accountsAccountIdTransactionsGET**](docs/TransactionsApi.md#accountsAccountIdTransactionsGET) | **GET** /accounts/{accountId}/transactions | Get Transactions
*GitChrisQueen_TDA_JS.TransactionsApi* | [**accountsAccountIdTransactionsTransactionIdGET**](docs/TransactionsApi.md#accountsAccountIdTransactionsTransactionIdGET) | **GET** /accounts/{accountId}/transactions/{transactionId} | Get Transaction
*GitChrisQueen_TDA_JS.UserInfoPreferencesApi* | [**accountsAccountIdPreferencesGET**](docs/UserInfoPreferencesApi.md#accountsAccountIdPreferencesGET) | **GET** /accounts/{accountId}/preferences | Get Preferences
*GitChrisQueen_TDA_JS.UserInfoPreferencesApi* | [**accountsAccountIdPreferencesPUT**](docs/UserInfoPreferencesApi.md#accountsAccountIdPreferencesPUT) | **PUT** /accounts/{accountId}/preferences | Update Preferences
*GitChrisQueen_TDA_JS.UserInfoPreferencesApi* | [**userprincipalsGET**](docs/UserInfoPreferencesApi.md#userprincipalsGET) | **GET** /userprincipals | Get User Principals
*GitChrisQueen_TDA_JS.UserInfoPreferencesApi* | [**userprincipalsStreamersubscriptionkeysGET**](docs/UserInfoPreferencesApi.md#userprincipalsStreamersubscriptionkeysGET) | **GET** /userprincipals/streamersubscriptionkeys | Get Streamer Subscription Keys
*GitChrisQueen_TDA_JS.WatchlistApi* | [**accountsAccountIdWatchlistsGET**](docs/WatchlistApi.md#accountsAccountIdWatchlistsGET) | **GET** /accounts/{accountId}/watchlists | Get Watchlists for Single Account
*GitChrisQueen_TDA_JS.WatchlistApi* | [**accountsAccountIdWatchlistsPOST**](docs/WatchlistApi.md#accountsAccountIdWatchlistsPOST) | **POST** /accounts/{accountId}/watchlists | Create Watchlist
*GitChrisQueen_TDA_JS.WatchlistApi* | [**accountsAccountIdWatchlistsWatchlistIdGET**](docs/WatchlistApi.md#accountsAccountIdWatchlistsWatchlistIdGET) | **GET** /accounts/{accountId}/watchlists/{watchlistId} | Get Watchlists
*GitChrisQueen_TDA_JS.WatchlistApi* | [**accountsAccountIdWatchlistsWatchlistIdPATCH**](docs/WatchlistApi.md#accountsAccountIdWatchlistsWatchlistIdPATCH) | **PATCH** /accounts/{accountId}/watchlists/{watchlistId} | Update Watchlist
*GitChrisQueen_TDA_JS.WatchlistApi* | [**accountsAccountIdWatchlistsWatchlistIdPUT**](docs/WatchlistApi.md#accountsAccountIdWatchlistsWatchlistIdPUT) | **PUT** /accounts/{accountId}/watchlists/{watchlistId} | Replace Watchlist
*GitChrisQueen_TDA_JS.WatchlistApi* | [**accountsWatchlistsGET**](docs/WatchlistApi.md#accountsWatchlistsGET) | **GET** /accounts/watchlists | Get Watchlists for Multiple Accounts


## Documentation for Models

 - [GitChrisQueen_TDA_JS.Account](docs/Account.md)
 - [GitChrisQueen_TDA_JS.AccountSecuritiesAccount](docs/AccountSecuritiesAccount.md)
 - [GitChrisQueen_TDA_JS.AssetType](docs/AssetType.md)
 - [GitChrisQueen_TDA_JS.Bond](docs/Bond.md)
 - [GitChrisQueen_TDA_JS.CandleList](docs/CandleList.md)
 - [GitChrisQueen_TDA_JS.CandleListCandles](docs/CandleListCandles.md)
 - [GitChrisQueen_TDA_JS.CashAccount](docs/CashAccount.md)
 - [GitChrisQueen_TDA_JS.CashAccountBalances](docs/CashAccountBalances.md)
 - [GitChrisQueen_TDA_JS.CashAccountCurrentBalances](docs/CashAccountCurrentBalances.md)
 - [GitChrisQueen_TDA_JS.CashAccountInitialBalances](docs/CashAccountInitialBalances.md)
 - [GitChrisQueen_TDA_JS.CashEquivalent](docs/CashEquivalent.md)
 - [GitChrisQueen_TDA_JS.Duration](docs/Duration.md)
 - [GitChrisQueen_TDA_JS.EASObject](docs/EASObject.md)
 - [GitChrisQueen_TDA_JS.ETFQuote](docs/ETFQuote.md)
 - [GitChrisQueen_TDA_JS.Equity](docs/Equity.md)
 - [GitChrisQueen_TDA_JS.EquityAssetType](docs/EquityAssetType.md)
 - [GitChrisQueen_TDA_JS.EquityQuote](docs/EquityQuote.md)
 - [GitChrisQueen_TDA_JS.ErrorObject](docs/ErrorObject.md)
 - [GitChrisQueen_TDA_JS.Execution](docs/Execution.md)
 - [GitChrisQueen_TDA_JS.ExecutionExecutionLegs](docs/ExecutionExecutionLegs.md)
 - [GitChrisQueen_TDA_JS.ExpirationDate](docs/ExpirationDate.md)
 - [GitChrisQueen_TDA_JS.FixedIncome](docs/FixedIncome.md)
 - [GitChrisQueen_TDA_JS.ForexQuote](docs/ForexQuote.md)
 - [GitChrisQueen_TDA_JS.FrequencyType](docs/FrequencyType.md)
 - [GitChrisQueen_TDA_JS.Fundamental](docs/Fundamental.md)
 - [GitChrisQueen_TDA_JS.FundamentalData](docs/FundamentalData.md)
 - [GitChrisQueen_TDA_JS.FundamentalFundamental](docs/FundamentalFundamental.md)
 - [GitChrisQueen_TDA_JS.FutureOptionsQuote](docs/FutureOptionsQuote.md)
 - [GitChrisQueen_TDA_JS.FutureQuote](docs/FutureQuote.md)
 - [GitChrisQueen_TDA_JS.GetOptionChainResponse](docs/GetOptionChainResponse.md)
 - [GitChrisQueen_TDA_JS.GetQuoteResponse](docs/GetQuoteResponse.md)
 - [GitChrisQueen_TDA_JS.Hours](docs/Hours.md)
 - [GitChrisQueen_TDA_JS.HoursSessionHours](docs/HoursSessionHours.md)
 - [GitChrisQueen_TDA_JS.IndexQuote](docs/IndexQuote.md)
 - [GitChrisQueen_TDA_JS.Instrument](docs/Instrument.md)
 - [GitChrisQueen_TDA_JS.LotMethod](docs/LotMethod.md)
 - [GitChrisQueen_TDA_JS.MarginAccount](docs/MarginAccount.md)
 - [GitChrisQueen_TDA_JS.MarginAccountBalances](docs/MarginAccountBalances.md)
 - [GitChrisQueen_TDA_JS.MarginAccountCurrentBalances](docs/MarginAccountCurrentBalances.md)
 - [GitChrisQueen_TDA_JS.MarginAccountInitialBalances](docs/MarginAccountInitialBalances.md)
 - [GitChrisQueen_TDA_JS.MarginAccountOrderStrategies](docs/MarginAccountOrderStrategies.md)
 - [GitChrisQueen_TDA_JS.MarginAccountPositions](docs/MarginAccountPositions.md)
 - [GitChrisQueen_TDA_JS.Mover](docs/Mover.md)
 - [GitChrisQueen_TDA_JS.MutualFund](docs/MutualFund.md)
 - [GitChrisQueen_TDA_JS.MutualFundQuote](docs/MutualFundQuote.md)
 - [GitChrisQueen_TDA_JS.Option](docs/Option.md)
 - [GitChrisQueen_TDA_JS.OptionChain](docs/OptionChain.md)
 - [GitChrisQueen_TDA_JS.OptionChainOption](docs/OptionChainOption.md)
 - [GitChrisQueen_TDA_JS.OptionChainOptionOptionDeliverablesList](docs/OptionChainOptionOptionDeliverablesList.md)
 - [GitChrisQueen_TDA_JS.OptionChainOptionPutCall](docs/OptionChainOptionPutCall.md)
 - [GitChrisQueen_TDA_JS.OptionChainStrategy](docs/OptionChainStrategy.md)
 - [GitChrisQueen_TDA_JS.OptionChainUnderlying](docs/OptionChainUnderlying.md)
 - [GitChrisQueen_TDA_JS.OptionDeliverable](docs/OptionDeliverable.md)
 - [GitChrisQueen_TDA_JS.OptionDeliverableInner](docs/OptionDeliverableInner.md)
 - [GitChrisQueen_TDA_JS.OptionDeliverableInnerAssetType](docs/OptionDeliverableInnerAssetType.md)
 - [GitChrisQueen_TDA_JS.OptionQuote](docs/OptionQuote.md)
 - [GitChrisQueen_TDA_JS.OrderActivity](docs/OrderActivity.md)
 - [GitChrisQueen_TDA_JS.OrderGet](docs/OrderGet.md)
 - [GitChrisQueen_TDA_JS.OrderGetCancelTime](docs/OrderGetCancelTime.md)
 - [GitChrisQueen_TDA_JS.OrderGetDuration](docs/OrderGetDuration.md)
 - [GitChrisQueen_TDA_JS.OrderGetInstrument](docs/OrderGetInstrument.md)
 - [GitChrisQueen_TDA_JS.OrderGetOrderActivityCollection](docs/OrderGetOrderActivityCollection.md)
 - [GitChrisQueen_TDA_JS.OrderGetOrderLegCollection](docs/OrderGetOrderLegCollection.md)
 - [GitChrisQueen_TDA_JS.OrderGetOrderType](docs/OrderGetOrderType.md)
 - [GitChrisQueen_TDA_JS.OrderGetSession](docs/OrderGetSession.md)
 - [GitChrisQueen_TDA_JS.OrderType](docs/OrderType.md)
 - [GitChrisQueen_TDA_JS.PeriodType](docs/PeriodType.md)
 - [GitChrisQueen_TDA_JS.Positions](docs/Positions.md)
 - [GitChrisQueen_TDA_JS.PositionsInner](docs/PositionsInner.md)
 - [GitChrisQueen_TDA_JS.PositionsInnerInstrument](docs/PositionsInnerInstrument.md)
 - [GitChrisQueen_TDA_JS.PostAccessBody](docs/PostAccessBody.md)
 - [GitChrisQueen_TDA_JS.Preferences](docs/Preferences.md)
 - [GitChrisQueen_TDA_JS.PutCall](docs/PutCall.md)
 - [GitChrisQueen_TDA_JS.SearchInstrument](docs/SearchInstrument.md)
 - [GitChrisQueen_TDA_JS.SearchInstrumentResponse](docs/SearchInstrumentResponse.md)
 - [GitChrisQueen_TDA_JS.SecuritiesAccount](docs/SecuritiesAccount.md)
 - [GitChrisQueen_TDA_JS.Session](docs/Session.md)
 - [GitChrisQueen_TDA_JS.Strategy](docs/Strategy.md)
 - [GitChrisQueen_TDA_JS.StrikePriceMap](docs/StrikePriceMap.md)
 - [GitChrisQueen_TDA_JS.SubscriptionKey](docs/SubscriptionKey.md)
 - [GitChrisQueen_TDA_JS.SubscriptionKeyKeys](docs/SubscriptionKeyKeys.md)
 - [GitChrisQueen_TDA_JS.Transaction](docs/Transaction.md)
 - [GitChrisQueen_TDA_JS.TransactionTransactionItem](docs/TransactionTransactionItem.md)
 - [GitChrisQueen_TDA_JS.TransactionTransactionItemInstrument](docs/TransactionTransactionItemInstrument.md)
 - [GitChrisQueen_TDA_JS.Underlying](docs/Underlying.md)
 - [GitChrisQueen_TDA_JS.UserPrincipal](docs/UserPrincipal.md)
 - [GitChrisQueen_TDA_JS.UserPrincipalAccounts](docs/UserPrincipalAccounts.md)
 - [GitChrisQueen_TDA_JS.UserPrincipalAuthorizations](docs/UserPrincipalAuthorizations.md)
 - [GitChrisQueen_TDA_JS.UserPrincipalPreferences](docs/UserPrincipalPreferences.md)
 - [GitChrisQueen_TDA_JS.UserPrincipalPreferencesMutualFundTaxLotMethod](docs/UserPrincipalPreferencesMutualFundTaxLotMethod.md)
 - [GitChrisQueen_TDA_JS.UserPrincipalQuotes](docs/UserPrincipalQuotes.md)
 - [GitChrisQueen_TDA_JS.UserPrincipalStreamerInfo](docs/UserPrincipalStreamerInfo.md)
 - [GitChrisQueen_TDA_JS.UserPrincipalStreamerSubscriptionKeys](docs/UserPrincipalStreamerSubscriptionKeys.md)
 - [GitChrisQueen_TDA_JS.WatchList](docs/WatchList.md)
 - [GitChrisQueen_TDA_JS.WatchListInstrument](docs/WatchListInstrument.md)
 - [GitChrisQueen_TDA_JS.WatchListRequest](docs/WatchListRequest.md)
 - [GitChrisQueen_TDA_JS.WatchListRequestInstrument](docs/WatchListRequestInstrument.md)
 - [GitChrisQueen_TDA_JS.WatchListRequestWatchlistItems](docs/WatchListRequestWatchlistItems.md)
 - [GitChrisQueen_TDA_JS.WatchListResponse](docs/WatchListResponse.md)
 - [GitChrisQueen_TDA_JS.WatchListWatchlistItems](docs/WatchListWatchlistItems.md)


## Documentation for Authorization


### application

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://auth.tdameritrade.com/auth?response_type=code&redirect_uri=http%3A%2F%2Flocalhost&client_id=YHJUQFCHRMJ7XODGVGGPINB05SCG2H45%40AMER.OAUTHAP
- **Scopes**: N/A

### bearerAuth

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header