23 |
24 |
25 |
52 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # TD Ameritrade Auth and Websocket
2 |
3 | #### What is this?
4 | Auth with the TD Ameritrade API is a bit of a pain.
5 | This is a web app that allows you to authorize and authenticate yourself to use the TD Websocket API.
6 | A TD trading account is required.
7 |
8 | #### Instructions
9 | 1. Go to https://developer.tdameritrade.com and register an app. Use 'https://localhost:8080/td-login-redirect' as your redirect url.
10 | 1. Copy your consumer key into the `VUE_APP_TD_CONSUMER_KEY` var in the .env.local file.
11 | 1. `npm install`
12 | 1. `npm run serve`
13 | 1. Navigate to https://localhost:8080 (Yes, we are running https locally. The TD redirect requires https.)
14 | 1. Click the td auth link at the top of the page and go through the log in process.
15 |
16 | After logging in, a refresh token is stored locally for 90 days, so next time you run the app you won't have to log in again.
17 |
18 | ---
19 |
20 | #### High level overview of the code
21 | 1. A link is created allowing you to log in to your td account. After logging in, it returns an OAuth code to the redirect url.
22 | - If a refresh token exists in local storage, we use that to get an access token.
23 | 1. Using the code, we retrieve an access token and store it in vuex. We also store the refresh token in local storage.
24 | 1. Using the access token, we authenticate and connect to the websocket api.
25 | 1. Requests are made to set the QOS to retrieve real time data and quotes on hot stock picks.
26 |
27 | #### Notes
28 |
29 | - This was created with vue cli
30 | - We need to use history mode for the router instead of hash mode because td won't accept a redirect url with a hash. Since the redirect is a deep link back to localhost, historyApiFallback has to be set to true in vue.config.js
31 |
32 | #### TD docs for the websocket api
33 | https://developer.tdameritrade.com/content/streaming-data
34 |
35 | ---
36 |
37 | If you find yourself making an abundance of money (or are planning on making an abundance of money) using this code, please show your support to a fellow dev.
38 |
39 | [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=HJAFUFTAEY6C4)
40 |
41 |
--------------------------------------------------------------------------------
/src/views/Home.vue:
--------------------------------------------------------------------------------
1 |
2 |
30 |
31 |
32 |
107 |
--------------------------------------------------------------------------------
/src/assets/js/td.js:
--------------------------------------------------------------------------------
1 | import qs from 'qs'
2 |
3 | class SocketWithPrincipals {
4 | constructor(principals, socket) {
5 | console.log("Generated socket with principals.")
6 | console.log("Socket: ", socket);
7 | this.principals = principals;
8 | this.socket = socket;
9 | }
10 |
11 | send(...requests) {
12 |
13 | let result = {
14 | "requests": []
15 | }
16 |
17 | let i = 0;
18 | requests.forEach(request => {
19 | request.account = this.principals.accounts[0].accountId;
20 | request.source = this.principals.streamerInfo.appId;
21 | request.requestid = i;
22 | result.requests.push(request);
23 | i++;
24 | })
25 |
26 | console.log("Sending " + i + " request(s)");
27 |
28 | this.socket.send(JSON.stringify(result));
29 | }
30 | }
31 |
32 | const connect = function(accessToken, messageHandler) {
33 | return authenticate(accessToken)
34 | .then(userPrincipalsResponse => {
35 | return startWebSocket(userPrincipalsResponse, messageHandler)
36 | })
37 | }
38 |
39 | //Returns user principals response
40 | const authenticate = function(accessToken) {
41 | console.log("Authenticating");
42 | const authenticationUrl = 'https://api.tdameritrade.com/v1/userprincipals?fields=streamerSubscriptionKeys,streamerConnectionInfo'
43 | const params = {headers: {'Authorization' : 'Bearer ' + accessToken}}
44 | return new Promise(resolve => {
45 | fetch(authenticationUrl, params)
46 | .then(response => {
47 | resolve(response.json());
48 | })
49 | })
50 | }
51 |
52 | const startWebSocket = function(userPrincipalsResponse, messageHandler) {
53 |
54 | return new Promise(resolve => {
55 |
56 | console.log("Starting web socket");
57 |
58 | let mySock = new WebSocket("wss://" + userPrincipalsResponse.streamerInfo.streamerSocketUrl + "/ws");
59 |
60 |
61 | //We start off with the login handler since you can't do anything without being logged in.
62 | //After login, set the message handler to the one passed in.
63 |
64 | const loginHandler = function(evt) {
65 | const data = JSON.parse(evt.data);
66 | if (data.response) {
67 | if (data.response[0].content.code === 0) {
68 | mySock.onmessage = messageHandler;
69 | console.log("Logged in to streaming API");
70 | resolve(new SocketWithPrincipals(userPrincipalsResponse, mySock));
71 | }
72 | }
73 | }
74 |
75 | mySock.onmessage = loginHandler;
76 | mySock.onclose = function() { console.log("Socket Closed"); };
77 |
78 | const loginRequest = {
79 | "requests": [
80 | {
81 | "service": "ADMIN",
82 | "command": "LOGIN",
83 | "requestid": 0,
84 | "account": userPrincipalsResponse.accounts[0].accountId,
85 | "source": userPrincipalsResponse.streamerInfo.appId,
86 | "parameters": {
87 | "credential": qs.stringify(makeCredentials(userPrincipalsResponse)),
88 | "token": userPrincipalsResponse.streamerInfo.token,
89 | "version": "1.0"
90 | }
91 | }
92 | ]
93 | }
94 |
95 | //Wait a second for the socket to initialize;
96 | setTimeout(function() {
97 | console.log("Logging in to streaming api");
98 | mySock.send(JSON.stringify(loginRequest));
99 | }, 1000)
100 | })
101 |
102 | }
103 |
104 | function makeCredentials(userPrincipalsResponse) {
105 |
106 | //Converts ISO-8601 response in snapshot to ms since epoch accepted by Streamer
107 | const tokenTimeStampAsDateObj = new Date(userPrincipalsResponse.streamerInfo.tokenTimestamp);
108 | const tokenTimeStampAsMs = tokenTimeStampAsDateObj.getTime();
109 |
110 | const credentials = {
111 | "userid": userPrincipalsResponse.accounts[0].accountId,
112 | "token": userPrincipalsResponse.streamerInfo.token,
113 | "company": userPrincipalsResponse.accounts[0].company,
114 | "segment": userPrincipalsResponse.accounts[0].segment,
115 | "cddomain": userPrincipalsResponse.accounts[0].accountCdDomainId,
116 | "usergroup": userPrincipalsResponse.streamerInfo.userGroup,
117 | "accesslevel": userPrincipalsResponse.streamerInfo.accessLevel,
118 | "authorized": "Y",
119 | "timestamp": tokenTimeStampAsMs,
120 | "appid": userPrincipalsResponse.streamerInfo.appId,
121 | "acl": userPrincipalsResponse.streamerInfo.acl
122 | }
123 |
124 | return credentials;
125 | }
126 |
127 | export default connect;
128 |
--------------------------------------------------------------------------------
/src/store.js:
--------------------------------------------------------------------------------
1 | import Vue from 'vue'
2 | import Vuex from 'vuex'
3 | import axios from 'axios'
4 | import qs from 'qs'
5 |
6 | Vue.use(Vuex)
7 |
8 | export default new Vuex.Store({
9 | state: {
10 | tdAccessToken: '',
11 | tdRefreshToken: '',
12 | tdAccessTokenExpiration: null
13 | },
14 | getters: {
15 | tdAccessToken: state => {
16 | return state.tdAccessToken && state.tdAccessTokenExpiration < new Date() ? state.tdAccessToken : null;
17 | },
18 | tdRefreshToken: state => {
19 | let refreshToken;
20 | if (state.tdRefreshToken) {
21 | refreshToken = state.tdRefreshToken;
22 | } else {
23 | refreshToken = window.localStorage.getItem("TD_REFRESH_TOKEN");
24 | if (refreshToken) {
25 | let refreshTokenExp = window.localStorage.getItem("TD_REFRESH_TOKEN_EXPIRATION");
26 | if (new Date() > refreshTokenExp) {
27 | refreshToken = null;
28 | }
29 | }
30 | }
31 | return refreshToken;
32 | },
33 | tdAccessTokenExpiration: state => { return state.tdAccessTokenExpiration; },
34 | },
35 | mutations: {
36 | setTdAccessToken(state, accessToken, expiresIn) {
37 | console.log("Setting access token: ", accessToken);
38 | state.tdAccessToken = accessToken;
39 | let date = new Date();
40 | date.setSeconds(date.getSeconds() + expiresIn);
41 | state.tdAccessTokenExpiration = date;
42 | },
43 | setTdRefreshToken(state, refreshToken) {
44 | state.tdRefreshToken = refreshToken;
45 |
46 | window.localStorage.setItem("TD_REFRESH_TOKEN", refreshToken);
47 |
48 | //Refresh token valid for 90 days
49 | let d = new Date();
50 | d.setDate(d.getDate() + 89);
51 | window.localStorage.setItem("TD_REFRESH_TOKEN_EXPIRATION", d);
52 | },
53 | },
54 | actions: {
55 | getTdAccessToken({commit, state, getters, dispatch}, code) {
56 | if (code) {
57 | return dispatch("getTdAccessTokenFromCode", code);
58 | } else {
59 | return new Promise((resolve, reject) => {
60 | if (getters.tdAccessToken) {
61 | resolve(getters.tdAccessToken);
62 | } else {
63 | dispatch("refreshTdAccessToken")
64 | .then(result => {
65 | if (result) {
66 | resolve(result);
67 | } else {
68 | reject("Access token and refresh token do not exist. Log in.")
69 | }
70 | })
71 | }
72 | })
73 | }
74 |
75 | },
76 | getTdAccessTokenFromCode({commit, state}, code) {
77 | return new Promise(resolve => {
78 |
79 | console.log("Getting access token from code: ", code);
80 | const body = {
81 | "grant_type": "authorization_code",
82 | "refresh_token": "",
83 | "access_type": "offline",
84 | "code": code,
85 | "client_id": process.env.VUE_APP_TD_CONSUMER_KEY,
86 | "redirect_uri": process.env.VUE_APP_TD_LOGIN_REDIRECT_URL
87 | }
88 | axios.post(
89 | "https://api.tdameritrade.com/v1/oauth2/token",
90 | qs.stringify(body),
91 | {
92 | headers: {
93 | 'Content-Type': 'application/x-www-form-urlencoded',
94 | }
95 | }
96 | )
97 | .then(response => {
98 | console.log(response);
99 | commit('setTdAccessToken', response.data.access_token, response.data.expires_in);
100 | commit('setTdRefreshToken', response.data.refresh_token);
101 | resolve(response.data.access_token);
102 | })
103 | })
104 | },
105 | refreshTdAccessToken({commit, getters, state}) {
106 | const refreshToken = getters.tdRefreshToken;
107 | console.log("Refresh token: ", refreshToken);
108 | if (!refreshToken) { return null; }
109 | const body = {
110 | "grant_type": "refresh_token",
111 | "refresh_token": refreshToken,
112 | "client_id": process.env.VUE_APP_TD_CONSUMER_KEY,
113 | }
114 | return axios.post(
115 | "https://api.tdameritrade.com/v1/oauth2/token",
116 | qs.stringify(body),
117 | {
118 | headers: {
119 | 'Content-Type': 'application/x-www-form-urlencoded',
120 | }
121 | }
122 | )
123 | .then(response => {
124 | console.log(response);
125 | commit('setTdAccessToken', response.data.access_token, response.data.expires_in);
126 | return response.data.access_token;
127 | })
128 | .catch(error => {
129 | console.error("Error refreshing token");
130 | })
131 | }
132 | },
133 | modules: {
134 | }
135 | })
136 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------