feat: watchlist/get service

src/client/mockWsJsonClient.ts

@@ -31,9 +31,10 @@
   LookupAlertsResponse,
 } from "./types/alertTypes";
 import { MarketDepthResponse } from "./services/marketDepthMessageHandler";
+import { GetWatchlistResponse } from "./services/getWatchlistMessageHandler";
 
 export default class MockWsJsonClient implements WsJsonClient {
   async *accountPositions(_: string): AsyncIterable<PositionsResponse> {
     return yield {
       service: "positions",
       positions: [],
@@ -44,14 +45,14 @@
     return Promise.resolve(null);
   }
 
   cancelAlert(_: number): Promise<CancelAlertResponse> {
     return Promise.resolve({
       service: "alerts/cancel",
       alerts: [],
     });
   }
 
   cancelOrder(_: number): Promise<CancelOrderResponse> {
     return Promise.resolve({
       service: "cancel_order",
       orderId: 123,
@@ -60,7 +61,7 @@
     });
   }
 
   async *chart(_: ChartRequestParams): AsyncIterable<ChartResponse> {
     return yield {
       service: "chart",
       symbol: "",
@@ -68,7 +69,7 @@
     };
   }
 
   createAlert(_: CreateAlertRequestParams): Promise<CreateAlertResponse> {
     return Promise.resolve({
       service: "alerts/create",
       alerts: [],
@@ -96,7 +97,7 @@
     };
   }
 
   optionChain(_: string): Promise<OptionChainResponse> {
     return Promise.resolve({
       series: [],
       service: "optionSeries",
@@ -104,7 +105,7 @@
   }
 
   optionChainDetails(
     _: OptionChainDetailsRequest
   ): Promise<OptionChainDetailsResponse> {
     return Promise.resolve({
       service: "option_chain/get",
@@ -113,7 +114,7 @@
   }
 
   async *optionChainQuotes(
     _: string
   ): AsyncIterable<OptionSeriesQuotesResponse> {
     return yield {
       series: [],
@@ -122,7 +123,7 @@
   }
 
   async *optionQuotes(
     _: OptionQuotesRequestParams
   ): AsyncIterable<OptionQuotesResponse> {
     return yield {
       items: [],
@@ -131,7 +132,7 @@
   }
 
   placeOrder(
     _: PlaceLimitOrderRequestParams
   ): Promise<PlaceOrderSnapshotResponse> {
     return Promise.resolve({
       service: "place_order",
@@ -201,4 +202,16 @@
       service: "market_depth",
     };
   }
+
+  watchlist(watchlistId: number): Promise<GetWatchlistResponse> {
+    return Promise.resolve({
+      service: "watchlist/get",
+      watchlist: {
+        id: watchlistId,
+        name: "foo",
+        type: "STATIC",
+        symbols: ["AAPL", "GOOG", "MSFT"],
+      },
+    });
+  }
 }

src/client/realWsJsonClient.ts

@@ -75,6 +75,9 @@ import {
   CreateAlertResponse,
   LookupAlertsResponse,
 } from "./types/alertTypes";
+import GetWatchlistMessageHandler, {
+  GetWatchlistResponse,
+} from "./services/getWatchlistMessageHandler";
 
 export const CONNECTION_REQUEST_MESSAGE = {
   ver: "27.*.*",
@@ -111,6 +114,7 @@ const messageHandlers: WebSocketApiMessageHandler<never, any>[] = [
   new LoginMessageHandler(),
   new SubmitOrderMessageHandler(),
   new MarketDepthMessageHandler(),
+  new GetWatchlistMessageHandler(),
 ];
 
 export default class RealWsJsonClient implements WsJsonClient {
@@ -282,6 +286,13 @@ export default class RealWsJsonClient implements WsJsonClient {
     return this.dispatchHandler(CancelOrderMessageHandler, orderId).promise();
   }
 
+  watchlist(watchlistId: number): Promise<GetWatchlistResponse> {
+    return this.dispatchHandler(
+      GetWatchlistMessageHandler,
+      watchlistId
+    ).promise();
+  }
+
   userProperties(): Promise<UserPropertiesResponse> {
     return this.dispatchHandler(
       UserPropertiesMessageHandler,

src/client/services/apiService.ts

@@ -17,4 +17,5 @@ export type ApiService =
   | "alerts/lookup"
   | "optionSeries/quotes"
   | "market_depth"
+  | "watchlist/get"
   | "fake"; // testing only

src/client/services/getWatchlistMessageHandler.ts

@@ -0,0 +1,95 @@
+import WebSocketApiMessageHandler, {
+  newPayload,
+} from "./webSocketApiMessageHandler";
+import { RawPayloadRequest, RawPayloadResponse } from "../tdaWsJsonTypes";
+import { ApiService } from "./apiService";
+import { isObject } from "lodash";
+
+export type GetWatchListResponseItem = {
+  id: number;
+  name: string;
+  type?: string;
+  symbols?: string[];
+};
+
+export type GetWatchlistSnapshotResponse = {
+  watchlist: GetWatchListResponseItem;
+  service: "watchlist/get";
+};
+
+export type GetWatchlistPatchResponse = {
+  patches: {
+    op: string;
+    path: string;
+    value: { watchlist: GetWatchListResponseItem } | number | string | string[];
+  }[];
+  service: "watchlist/get";
+};
+
+export type GetWatchlistResponse = GetWatchlistSnapshotResponse;
+
+export default class GetWatchlistMessageHandler
+  implements WebSocketApiMessageHandler<number, GetWatchlistResponse | null>
+{
+  buildRequest(watchlistId: number): RawPayloadRequest {
+    return newPayload({
+      header: {
+        service: "watchlist/get",
+        id: "watchlist/get",
+        ver: 0,
+      },
+      params: { watchlistId },
+    });
+  }
+
+  parseResponse(message: RawPayloadResponse): GetWatchlistResponse | null {
+    const [{ header, body }] = message.payload;
+    switch (header.type) {
+      case "snapshot": {
+        if ("watchlist" in body) {
+          const { watchlist } = body as { watchlist: GetWatchListResponseItem };
+          return { watchlist, service: "watchlist/get" };
+        } else {
+          console.warn(
+            "Unexpected watchlist/get snapshot response with missing `watchlist` object",
+            message
+          );
+          return null;
+        }
+      }
+      case "patch": {
+        return parseGetWatchlistPatchResponse(
+          body as GetWatchlistPatchResponse
+        );
+      }
+      default:
+        console.warn("Unexpected watchlist/get response", message);
+        return null;
+    }
+  }
+
+  service: ApiService = "watchlist/get";
+}
+
+function parseGetWatchlistPatchResponse(
+  body: GetWatchlistPatchResponse
+): GetWatchlistResponse {
+  const { patches } = body as GetWatchlistPatchResponse;
+  const { path, value } = patches[0];
+  if (path === "" && isObject(value)) {
+    const { watchlist } = value as {
+      watchlist: GetWatchListResponseItem;
+    };
+    return { watchlist, service: "watchlist/get" };
+  }
+  const watchlist: Record<string, any> = {};
+  patches.forEach(({ path, value }) => {
+    const pathParts = path.split("/");
+    const key = pathParts[pathParts.length - 1];
+    watchlist[key] = value;
+  });
+  return {
+    watchlist: watchlist as GetWatchListResponseItem,
+    service: "watchlist/get",
+  };
+}

src/client/wsJsonClient.ts

@@ -30,6 +30,7 @@ import {
   LookupAlertsResponse,
 } from "./types/alertTypes";
 import { MarketDepthResponse } from "./services/marketDepthMessageHandler";
+import { GetWatchlistResponse } from "./services/getWatchlistMessageHandler";
 
 export interface WsJsonClient {
   authenticate(): Promise<RawLoginResponseBody | null>;
@@ -83,4 +84,6 @@ export interface WsJsonClient {
   disconnect(): void;
 
   marketDepth(symbol: string): AsyncIterable<MarketDepthResponse>;
+
+  watchlist(watchlistId: number): Promise<GetWatchlistResponse>;
 }

src/example/testApp.ts

@@ -148,6 +148,12 @@ class TestApp {
       logger("bid quotes: %O", stateUpdater.bidQuotes);
     }
   }
+
+  async getWatchlist(watchlistId: number) {
+    logger(" --- getWatchlist() get watchlist ---");
+    const watchlist = await this.client.watchlist(watchlistId);
+    logger("getWatchlist() %O", watchlist);
+  }
 }
 
 async function run() {
@@ -170,7 +176,8 @@ async function run() {
   );
   const { client } = await authClient.authenticateWithRetry(token);
   const app = new TestApp(client);
-  await app.marketDepth("/NQ");
+  await app.getWatchlist(-3);
+  await app.getWatchlist(126216147);
 }
 
 run().catch(console.error);