@tastytrade/api 3.1.0 → 5.0.0

package/.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Typescript",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "runtimeExecutable": "ts-node",
+      // "runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only"],
+      "args": ["thingy/main.ts"]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Javascript",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "runtimeExecutable": "node",
+      "args": ["thingy/default.js"]
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,41 @@
+# @tastytrade/api
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [5.0.0] - 2024-09-17
+
+The `TastytradeClient` constructor now takes a single config object instead of 2 urls.
+
+### Changed
+
+- Add optional logging; update example app [#44](https://github.com/tastytrade/tastytrade-api-js/pull/44)
+- Add future option quote streaming example to README
+
+### Fixed
+
+- Update README.md [#42](https://github.com/tastytrade/tastytrade-api-js/pull/35)
+- README corrections
+- typo on json account node name [#39](https://github.com/tastytrade/tastytrade-api-js/pull/39)
+
+## [4.0.0] - 2024-03-12
+
+### Changed
+
+- Tsconfig library updates [#35](https://github.com/tastytrade/tastytrade-api-js/pull/35)
+- target modern JS modules [#30](https://github.com/tastytrade/tastytrade-api-js/pull/30)
+- Deprecate MarketDataStreamer [#29](https://github.com/tastytrade/tastytrade-api-js/pull/29)
+- Target moden node runtimes [#22](https://github.com/tastytrade/tastytrade-api-js/pull/22)
+
+### Fixed
+
+- add missing return in getDefaultHeaders [#32](https://github.com/tastytrade/tastytrade-api-js/pull/32)
+- Dont set User-Agent header in browser environment [#28](https://github.com/tastytrade/tastytrade-api-js/pull/28)
+
+### Removed
+
+- Remove https.Agent in `tastytrade-http-client` [#24](https://github.com/tastytrade/tastytrade-api-js/pull/24)
+- Remove un-needed types dependency [#21](https://github.com/tastytrade/tastytrade-api-js/pull/21)

package/CODEOWNERS

@@ -0,0 +1 @@
+* @dmoss18

package/README.md

@@ -2,53 +2,84 @@
 
 ## Installation
 npm:
-`npm -i @tastytrade/api`
+`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'])
+import TastytradeApi from "@tastytrade/api"
+
+const tastytradeApi = new TastytradeApi(baseUrl, accountStreamerUrl)
+const loginResponse = await tastytradeApi.sessionService.login(usernameOrEmail, password)
+const accounts = await tastytradeApi.accountsAndCustomersService.getCustomerAccounts()
+const accountPositions = await tastytradeApi.balancesAndPositionsService.getPositionsList(accounts[0].account['account-number'])
 ```
 
 ### Market Data
+The MarketDataStreamer in this package is deprecated. We recommend using DxFeed's [@dxfeed/dxlink-api](https://github.com/dxFeed/dxLink/blob/main/dxlink-javascript/dxlink-api/README.md) instead.
+
+Here's a node example of how you can subscribe to some future option quotes using `@dxfeed/dxlink-api`:
 ```js
-import TastytradeClient, { MarketDataStreamer, MarketDataSubscriptionType } from "@tastytrade-api"
-const tastytradeClient = new TastytradeClient(baseUrl, accountStreamerUrl)
-await tastytradeClient.sessionService.login(usernameOrEmail, pasword)
-const tokenResponse = await tastytradeClient.AccountsAndCustomersService.getApiQuoteToken()
-const streamer = new MarketDataStreamer()
-streamer.connect(tokenResponse['dxlink-url'], tokenResponse.token)
-
-function handleMarketDataReceived(data) {
-  // Triggers every time market data event occurs
-  console.log(data)
-}
+/**
+ * Below code assumes you've hit GET /api-quote-tokens and received a token
+ * You should also hit GET /futures-option-chains/{future_contract_code}/nested to get the future options you want to subscribe to
+ * There is an equivalent GET /option-chains/{underlying_ticker_symbol}/nested for equity options
+ */
+
+const WebSocket = require('isomorphic-ws')
+const { DXLinkWebSocketClient, DXLinkFeed, FeedDataFormat } = require('@dxfeed/dxlink-api')
+global.WebSocket = WebSocket
 
-// Add a listener for incoming market data. Returns a remove() function that removes the listener from the quote streamer
-const removeDataListener = streamer.addDataListener(handleMarketDataReceived)
+const token = '<api quote token>'
+const client = new DXLinkWebSocketClient()
+client.connect('wss://tasty-openapi-ws.dxfeed.com/realtime')
+client.setAuthToken(token)
+
+const feed = new DXLinkFeed(client, 'AUTO')
+
+// Note: Calling feed.configure is optional - omitting it means DxLink will return all fields
+feed.configure({
+  acceptAggregationPeriod: 10,
+  acceptDataFormat: FeedDataFormat.COMPACT,
+  acceptEventFields: {
+    Quote: ['eventSymbol', 'askPrice', 'bidPrice']
+  },
+})
+
+feed.addEventListener((events) => {
+  events.map(event => {
+    console.log(event)
+  })
+})
+
+feed.addSubscriptions({
+  type: 'Quote',
+  symbol: './EW4Q24C5750:XCME', // Please note: we don't update this README daily. This symbol may be expired. You'll have to find an unexpired symbol.
+})
+```
 
-// Subscribe to a single equity quote
-streamer.addSubscription('AAPL')
-// Optionally specify which market data events you want to subscribe to
-streamer.addSubscription('SPY', { subscriptionTypes: [MarketDataSubscriptionType.Quote] })
+To run the above code, save it to a file and run `node <filename>.js` in a terminal.
 
-// Subscribe to a single equity option quote
-const optionChain = await tastytradeClient.instrumentsService.getOptionChain('AAPL')
-streamer.addSubscription(optionChain[0]['streamer-symbol'])
+When adding a subscription, the `symbol` value should be the `put-streamer-symbol` or `call-streamer-symbol` returned by the `GET /futures-option-chains/{future_contract_code}/nested` endpoint. For example:
+```js
+// GET /futures-option-chains/ES/nested response:
+{
+  "strike-price": "5750.0",
+  "call": "./ESU4 EW4Q4 240823C5750",
+  "call-streamer-symbol": "./EW4Q24C5750:XCME", <-- use this value
+  "put": "./ESU4 EW4Q4 240823P5750",
+  "put-streamer-symbol": "./EW4Q24P5750:XCME" <-- or this value
+}
 ```
 
+To subscribe to equities quotes, the `symbol` is just the ticker symbol, like `AAPL`.
+
 ### Account Streamer
 ```js
-const TastytradeApi = require("@tastytrade/api")
-const TastytradeClient = TastytradeApi.default
-const { AccountStreamer } = TastytradeApi
-const _ = require('lodash')
+import TastytradeApi from "@tastytrade/api"
+import _ from 'lodash'
 
 function handleStreamerMessage(json) {
   console.log('streamer message received: ', json)
@@ -58,7 +89,7 @@ function handleStreamerStateChange(streamerState) {
   console.log('streamer state changed: ', streamerState)
 }
 
-const tastytradeClient = new TastytradeClient(baseUrl, accountStreamerUrl)
+const tastytradeClient = new TastytradeApi(baseUlr, accountStreamerUrl)
 const accountStreamer = tastytradeClient.accountStreamer
 const loginResponse = await tastytradeClient.sessionService.login(usernameOrEmail, password)
 const accounts = await tastytradeClient.accountsAndCustomersService.getCustomerAccounts()
@@ -95,6 +126,8 @@ API_PASSWORD=<your cert password>
 API_ACCOUNT_NUMBER=<your cert account number>
 ```
 
+These values should match whatever username/password/account you set up in the tastytrade sandbox environment. Head to developer.tastyworks.com to get that set up.
+
 ## Running example app
 ```sh
 npm run build

package/dist/account-streamer.d.ts

@@ -1,17 +1,19 @@
-import type { JsonValue } from './utils/json-util';
-import { JsonBuilder } from './utils/json-util';
-import TastytradeSession from './models/tastytrade-session';
+import type { JsonValue } from './utils/json-util.js';
+import { JsonBuilder } from './utils/json-util.js';
+import TastytradeSession from './models/tastytrade-session.js';
+import type Logger from './logger.js';
 export declare enum STREAMER_STATE {
     Open = 0,
     Closed = 1,
     Error = 2
 }
-export declare type Disposer = () => void;
-export declare type StreamerStateObserver = (streamerState: STREAMER_STATE) => void;
-export declare type StreamerMessageObserver = (json: object) => void;
+export type Disposer = () => void;
+export type StreamerStateObserver = (streamerState: STREAMER_STATE) => void;
+export type StreamerMessageObserver = (json: object) => void;
 export declare class AccountStreamer {
     private readonly url;
     private readonly session;
+    private readonly logger;
     private websocket;
     private startResolve;
     private startReject;
@@ -25,12 +27,11 @@ export declare class AccountStreamer {
     private readonly streamerMessageObservers;
     private startPromise;
     private readonly requestPromises;
-    private readonly logger;
     /**
      *
      * @param url Url of the account streamer service
      */
-    constructor(url: string, session: TastytradeSession);
+    constructor(url: string, session: TastytradeSession, logger: Logger);
     get streamerState(): STREAMER_STATE;
     set streamerState(streamerState: STREAMER_STATE);
     private get authToken();
@@ -90,3 +91,4 @@ export declare class AccountStreamer {
     addMessageObserver(observer: StreamerMessageObserver): Disposer;
     private readonly handleOneMessage;
 }
+//# sourceMappingURL=account-streamer.d.ts.map

package/dist/account-streamer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-streamer.d.ts","sourceRoot":"","sources":["../lib/account-streamer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAW,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,iBAAiB,MAAM,gCAAgC,CAAA;AAE9D,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,oBAAY,cAAc;IACxB,IAAI,IAAI;IACR,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AAeD,MAAM,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAA;AAEjC,MAAM,MAAM,qBAAqB,GAAG,CAAC,aAAa,EAAE,cAAc,KAAK,IAAI,CAAA;AAE3E,MAAM,MAAM,uBAAuB,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;AAa5D,qBAAa,eAAe;IA8BxB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO;IA9B1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,SAAS,CAAyB;IAC1C,OAAO,CAAC,YAAY,CAA2C;IAC/D,OAAO,CAAC,WAAW,CAAwC;IAC3D,OAAO,CAAC,cAAc,CAAY;IAClC,OAAO,CAAC,MAAM,CAAe;IAE7B,OAAO,CAAC,gBAAgB,CAAuC;IAE/D,cAAc,EAAE,GAAG,CAAO;IAC1B,cAAc,EAAE,GAAG,CAAO;IAC1B,OAAO,CAAC,cAAc,CAAwC;IAE9D,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA8B;IAErE,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAgC;IAEzE,OAAO,CAAC,YAAY,CAAgC;IAEpD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAGnB;IAEb;;;OAGG;gBAEgB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,iBAAiB,EAC3C,MAAM,EAAE,MAAM;IAKhB,IAAI,aAAa,IAAI,cAAc,CAElC;IAED,IAAI,aAAa,CAAC,aAAa,EAAE,cAAc,EAM9C;IAED,OAAO,KAAK,SAAS,GAEpB;IAED;;;;OAIG;IACH,wBAAwB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,QAAQ;IAQnE,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAyB/B,IAAI;IAIJ,OAAO,CAAC,QAAQ;IAsBhB,QAAQ,CAAC,aAAa,aAGrB;IAED,OAAO,CAAC,sBAAsB;IAc9B,IAAI,oBAAoB,YAEvB;IAED,OAAO,CAAC,oBAAoB;IAc5B,OAAO,CAAC,qBAAqB;IAI7B;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,mBAAmB,UAAO,GAAG,MAAM;IA2B3D;;;;;OAKG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,GAAG,MAAM;IAS7D;;;;OAIG;IACI,eAAe,CAAC,cAAc,EAAE,MAAM;IAQ7C;;;;OAIG;IACU,mBAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAc3E,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAa1B;IAED,OAAO,CAAC,QAAQ,CAAC,WAAW,CAS3B;IAED,OAAO,CAAC,QAAQ,CAAC,WAAW,CAgB3B;IAED,OAAO,CAAC,QAAQ,CAAC,aAAa,CAW7B;IAED,kBAAkB,CAAC,QAAQ,EAAE,uBAAuB,GAAG,QAAQ;IAQ/D,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CA0BhC;CACF"}