@tastytrade/api 0.0.1 → 1.0.0

package/.env

@@ -1,5 +1,5 @@
-BASE_URL=https://api.tastyworks.com
-API_USERNAME=dmoss18
+BASE_URL=https://api.cert.tastyworks.com
+API_USERNAME=devin.moss@tastytrade.com
 API_PASSWORD=rebuke-padding-vizor
-API_CUSTOMER_ID=me
-API_ACCOUNT_NUMBER=5WT05020
+API_ACCOUNT_NUMBER=5WT05179
+API_CUSTOMER_ID=31

package/.vscode/launch.json

@@ -7,18 +7,14 @@
     {
       "type": "node",
       "request": "launch",
-      "name": "Integration Tests",
-      "skipFiles": ["<node_internals>/**"],
+      "name": "Launch Program",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
       "program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
-      "args": ["-i", "--", "tests/integration/service/instruments-service.test.ts"]
-    },
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Unit Tests",
-      "skipFiles": ["<node_internals>/**"],
-      "program": "${workspaceFolder}/node_modules/jest/bin/jest.js",
-      "args": ["-i", "--", "tests/unit/service/session-service.test.ts"]
+      "args": [
+        "-c", "jest.config.js", "tests/integration/service/accounts-and-customers-service.test.ts"
+      ]
     }
   ]
 }

package/README.md

@@ -1,4 +1,80 @@
 # Tastytrade Api Javascript SDK
+
+## Installation
+npm:
+`npm -i @tastytrade/api`
+
+yarn:
+`yarn add @tastytrade/api`
+
+## Quickstart
+```js
+import TastytradeClient from "@tastytrade/api"
+const tastytradeClient = new TastytradeClient(baseUrl, accountStreamerUrl)
+const loginResponse = await tastytradeClient.sessionService.login(usernameOrEmail, pasword)
+const accounts = await tastytradeClient.accountsAndCustomersService.getCustomerAccounts()
+const accountPositions = await tastytradeClient.balancesAndPositionsService.getPositionsList(accounts[0].accounts['account-number'])
+```
+
+### Market Data
+```js
+import TastytradeClient, { QuoteStreamer } from "@tastytrade-api"
+const tastytradeClient = new TastytradeClient(baseUrl, accountStreamerUrl)
+await tastytradeClient.sessionService.login(usernameOrEmail, pasword)
+const tokenResponse = await tastytradeClient.AccountsAndCustomersService.getQuoteStreamerTokens()
+const quoteStreamer = new QuoteStreamer(tokenResponse.token, `${tokenResponse['websocket-url']}/cometd`)
+quoteStreamer.connect()
+
+function handleMarketDataReceived(event) {
+  // Triggers every time market data event occurs
+  console.log(event)
+}
+// Subscribe to a single equity quote
+quoteStreamer.subscribe('AAPL', handleMarketDataReceived)
+
+// Subscribe to a single equity option quote
+const optionChain = await tastytradeClient.instrumentsService.getOptionChain('AAPL')
+quoteStreamer.subscribe(optionChain[0]['streamer-symbol'], handleMarketDataReceived)
+```
+
+### Account Streamer
+```js
+const TastytradeApi = require("@tastytrade/api")
+const TastytradeClient = TastytradeApi.default
+const { AccountStreamer, QuoteStreamer } = TastytradeApi
+const _ = require('lodash')
+
+function handleStreamerMessage(json) {
+  console.log('streamer message received: ', json)
+}
+
+function handleStreamerStateChange(streamerState) {
+  console.log('streamer state changed: ', streamerState)
+}
+
+const tastytradeClient = new TastytradeClient(baseUrl, accountStreamerUrl)
+const accountStreamer = tastytradeClient.accountStreamer
+const loginResponse = await tastytradeClient.sessionService.login(usernameOrEmail, password)
+const accounts = await tastytradeClient.accountsAndCustomersService.getCustomerAccounts()
+const accountNumbers = _.map(accounts, account => _.get(account, 'account.account-number'))
+await accountStreamer.start()
+await accountStreamer.subscribeToAccounts(accountNumbers)
+accountStreamer.addMessageObserver(handleStreamerMessage)
+accountStreamer.addStreamerStateObserver(handleStreamerStateChange)
+```
+
+You should then be able to place a trade and see live status updates for the order come through via `handleStreamerMessage`.
+
+## Running in Node
+The `cometd` package has an explicit reference to `window`, so there's not a perfect way to run this code in a NodeJs. You could fake the `window` object to get it running. You'll have to `npm install ws` and do this:
+
+```js
+const WebSocket = require('ws')
+
+global.WebSocket = WebSocket
+global.window = { WebSocket, setTimeout, clearTimeout }
+```
+
 ## Building Locally
 `npm run build`
 Outputs everything to `dist/`

package/dist/account-streamer.d.ts

@@ -8,7 +8,7 @@ export declare enum STREAMER_STATE {
 }
 export declare type Disposer = () => void;
 export declare type StreamerStateObserver = (streamerState: STREAMER_STATE) => void;
-export declare type StreamerMessageObserver = (messageType: string, action: string, status: string) => void;
+export declare type StreamerMessageObserver = (json: object) => void;
 export declare class AccountStreamer {
     private readonly url;
     private readonly session;

package/dist/account-streamer.js

@@ -143,7 +143,7 @@ var AccountStreamer = /** @class */ (function () {
         this.handleOneMessage = function (json) {
             _this.logger.info(json);
             var action = json.action;
-            _this.streamerMessageObservers.forEach(function (observer) { return observer(json.type, action, json.status); });
+            _this.streamerMessageObservers.forEach(function (observer) { return observer(json); });
             if (action) {
                 if (action === MessageAction.HEARTBEAT) {
                     // schedule next heartbeat

package/dist/services/accounts-and-customers-service.d.ts

@@ -3,8 +3,8 @@ export default class AccountsAndCustomersService {
     private httpClient;
     constructor(httpClient: TastytradeHttpClient);
     getCustomerAccounts(): Promise<any>;
-    getCustomerResource(customerId: string): Promise<any>;
-    getCustomerAccountResources(customerId: string): Promise<any>;
-    getFullCustomerAccountResource(customerId: string, accountNumber: string): Promise<any>;
+    getCustomerResource(): Promise<any>;
+    getCustomerAccountResources(): Promise<any>;
+    getFullCustomerAccountResource(accountNumber: string): Promise<any>;
     getQuoteStreamerTokens(): Promise<any>;
 }

package/dist/services/accounts-and-customers-service.js

@@ -58,12 +58,12 @@ var AccountsAndCustomersService = /** @class */ (function () {
         });
     };
     //Customers: Operations about customers
-    AccountsAndCustomersService.prototype.getCustomerResource = function (customerId) {
+    AccountsAndCustomersService.prototype.getCustomerResource = function () {
         return __awaiter(this, void 0, void 0, function () {
             var customerResource;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.httpClient.getData("/customers/".concat(customerId), {}, {})];
+                    case 0: return [4 /*yield*/, this.httpClient.getData("/customers/me", {}, {})];
                     case 1:
                         customerResource = (_a.sent());
                         return [2 /*return*/, (0, response_util_1.default)(customerResource)];
@@ -71,12 +71,12 @@ var AccountsAndCustomersService = /** @class */ (function () {
             });
         });
     };
-    AccountsAndCustomersService.prototype.getCustomerAccountResources = function (customerId) {
+    AccountsAndCustomersService.prototype.getCustomerAccountResources = function () {
         return __awaiter(this, void 0, void 0, function () {
             var customerAccountResources;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.httpClient.getData("/customers/".concat(customerId, "/accounts"), {}, {})];
+                    case 0: return [4 /*yield*/, this.httpClient.getData("/customers/me/accounts", {}, {})];
                     case 1:
                         customerAccountResources = (_a.sent());
                         return [2 /*return*/, (0, response_util_1.default)(customerAccountResources)];
@@ -84,12 +84,12 @@ var AccountsAndCustomersService = /** @class */ (function () {
             });
         });
     };
-    AccountsAndCustomersService.prototype.getFullCustomerAccountResource = function (customerId, accountNumber) {
+    AccountsAndCustomersService.prototype.getFullCustomerAccountResource = function (accountNumber) {
         return __awaiter(this, void 0, void 0, function () {
             var fullCustomerAccountResource;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.httpClient.getData("/customers/".concat(customerId, "/accounts/").concat(accountNumber), {}, {})];
+                    case 0: return [4 /*yield*/, this.httpClient.getData("/customers/me/accounts/".concat(accountNumber), {}, {})];
                     case 1:
                         fullCustomerAccountResource = (_a.sent());
                         return [2 /*return*/, (0, response_util_1.default)(fullCustomerAccountResource)];

package/lib/account-streamer.ts

@@ -26,7 +26,7 @@ export type Disposer = () => void
 
 export type StreamerStateObserver = (streamerState: STREAMER_STATE) => void
 
-export type StreamerMessageObserver = (messageType: string, action: string, status: string) => void
+export type StreamerMessageObserver = (json: object) => void
 
 const REQUEST_ID = 'request-id'
 
@@ -368,7 +368,7 @@ export class AccountStreamer {
     this.logger.info(json)
 
     const action = json.action as string
-    this.streamerMessageObservers.forEach(observer => observer(json.type as string, action, json.status as string))
+    this.streamerMessageObservers.forEach(observer => observer(json))
     if (action) {
       if (action === MessageAction.HEARTBEAT) {
         // schedule next heartbeat

package/lib/services/accounts-and-customers-service.ts

@@ -10,19 +10,19 @@ export default class AccountsAndCustomersService {
     }
 
     //Customers: Operations about customers
-    async getCustomerResource(customerId: string){
+    async getCustomerResource(){
         //Get a full customer resource.
-        const customerResource = (await this.httpClient.getData(`/customers/${customerId}`, {}, {}))
+        const customerResource = (await this.httpClient.getData(`/customers/me`, {}, {}))
         return extractResponseData(customerResource)
     }
-    async getCustomerAccountResources(customerId: string){
+    async getCustomerAccountResources(){
         //Get a list of all the customer account resources attached to the current customer.
-        const customerAccountResources = (await this.httpClient.getData(`/customers/${customerId}/accounts`, {}, {}))
+        const customerAccountResources = (await this.httpClient.getData(`/customers/me/accounts`, {}, {}))
         return extractResponseData(customerAccountResources)
     }
-    async getFullCustomerAccountResource(customerId: string, accountNumber: string){
+    async getFullCustomerAccountResource(accountNumber: string){
         //Get a full customer account resource.
-        const fullCustomerAccountResource = (await this.httpClient.getData(`/customers/${customerId}/accounts/${accountNumber}`, {}, {}))
+        const fullCustomerAccountResource = (await this.httpClient.getData(`/customers/me/accounts/${accountNumber}`, {}, {}))
         return extractResponseData(fullCustomerAccountResource)
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tastytrade/api",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "main": "dist/tastytrade-api.js",
   "typings": "dist/tastytrade-api.d.ts",
   "repository": "https://github.com/tastytrade/tastytrade-api-js",