laplace-api 4.3.0 → 4.3.2

package/README.md

@@ -289,16 +289,25 @@ const results = await client.search(
 ### WebSocket Client
 
 ```typescript
+// Server Side
+// Initialize LivePriceClient for server side use
+const livePriceClient = new LivePriceClient(config, logger);
+
+// Retrieve a websocket connection URL for the client, pass the URL to the client
+const wsURL = await livePriceClient.getClientWebsocketUrl('external-user-id', [LivePriceFeed.LiveBist])
+
+// Client Side
+// Client side retrieves the websocket connection URL from the server as wsURL
 // Create WebSocket client for real-time data
 const webSocketClient = new LivePriceWebSocketClient();
 
 // Connect to WebSocket
-await webSocketClient.connect("ws://example.com/websocket");
+await webSocketClient.connect(wsURL);
 
 // Subscribe to live price feeds
 const unsubscribe = webSocketClient.subscribe(
   ["THYAO", "GARAN"],
-  "live_price_tr",
+  LivePriceFeed.LiveBist,
   (data) => {
     console.log("Received live data:", data);
   }
@@ -306,6 +315,10 @@ const unsubscribe = webSocketClient.subscribe(
 
 // Close connection
 await webSocketClient.close();
+
+// Server Side
+// Use livePriceClient.getWebsocketUsageForMonth for getting a report on websocket client usage
+const usage = await livePriceClient.getWebsocketUsageForMonth('8', '2025', LivePriceFeed.LiveBist);
 ```
 
 ### Capital Increase Client

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laplace-api",
-  "version": "4.3.0",
+  "version": "4.3.2",
   "description": "Client library for Laplace API for the US stock market and BIST (Istanbul stock market) fundamental financial data.",
   "main": "index.js",
   "scripts": {

package/src/client/live-price.ts

@@ -61,6 +61,12 @@ interface WebSocketUrlResponse {
   url: string;
 }
 
+interface WebSocketUsageResponse {
+  externalUserId: string;
+  firstConnectionTime: Date;
+  uniqueDeviceCount: number;
+}
+
 interface WebSocketUrlParams {
   externalUserId: string;
   feeds: LivePriceFeed[];
@@ -278,13 +284,21 @@ export class LivePriceClient extends Client {
     return response.url;
   }
 
-  async updateUserDetails(params: UpdateUserDetailsParams): Promise<void> {
-    const url = new URL(`${this["baseUrl"]}/api/v1/ws/user`);
-
-    await this.sendRequest<void>({
-      method: "PUT",
+  async getWebsocketUsageForMonth(
+    month: string,
+    year: string,
+    feedType: LivePriceFeed,
+  ): Promise<WebSocketUsageResponse[]> {
+    const url = new URL(`${this["baseUrl"]}/api/v1/ws/report`);
+    url.searchParams.append("month", month);
+    url.searchParams.append("year", year);
+    url.searchParams.append("feedType", feedType);
+
+    const response = await this.sendRequest<WebSocketUsageResponse[]>({
+      method: "GET",
       url: url.toString(),
-      data: params,
     });
+
+    return response;
   }
 }