firstock 1.0.1 → 1.0.5

package/Readme.md

@@ -1,10 +1,11 @@
+
 # The Firstock Developer API Nodejs client - 
 
 To communicate with the Firstock Developer API using Nodejs, you can use the official Nodejs client library provided by Firstock.
 Licensed under the MIT License.
 
 
-[Version - 1.0.0](https://www.npmjs.com/package/firstock)
+[Version - 1.0.5](https://www.npmjs.com/package/firstock)
 
 
 ## Documentation
@@ -276,6 +277,149 @@ firstock.timePriceSeries({
 });
 ```
 
+```javascript
+WebSockets
+
+Order Update Feed
+
+const { Firstock, FirstockWebSocket } = require('./websockets');
+
+// Define callback method 
+function orderBookData(data) {
+    console.log(data);
+}
+
+const userId = 'YOUR_USER_ID';
+
+const model = new FirstockWebSocket({
+    order_data: orderBookData
+});
+
+async function main() {
+    const [conn, err] = await Firstock.initializeWebsockets(userId, model);
+    console.log("Error:", err);
+
+    await new Promise(resolve => setTimeout(resolve, 25000));
+
+    // Close WebSocket connection
+    const closeErr = await Firstock.closeWebsocket(conn);
+    console.log("Close Error:", closeErr);
+}
+
+main();
+
+Position Update Feed
+
+const { Firstock, FirstockWebSocket } = require('./websockets');
+
+// Define callback method 
+function positionBookData(data) {
+    console.log(data);
+}
+
+const userId = 'YOUR_USER_ID';
+
+const model = new FirstockWebSocket({
+    position_data: positionBookData
+});
+
+async function main() {
+    const [conn, err] = await Firstock.initializeWebsockets(userId, model);
+    console.log("Error:", err);
+
+    await new Promise(resolve => setTimeout(resolve, 25000));
+
+    // Close WebSocket connection
+    const closeErr = await Firstock.closeWebsocket(conn);
+    console.log("Close Error:", closeErr);
+}
+
+main();
+
+
+Subscribe Feed
+
+const { Firstock, FirstockWebSocket } = require('./websockets');
+
+// Define callback method 
+function subscribeFeedData(data) {
+    console.log(data);
+}
+
+const userId = 'YOUR_USER_ID';
+
+const model = new FirstockWebSocket({
+    subscribe_feed_data: subscribeFeedData,
+    tokens: ["NSE:26000"]
+});
+
+async function main() {
+    const [conn, err] = await Firstock.initializeWebsockets(userId, model);
+    console.log("Error:", err);
+
+    if (conn) {
+        const subscribeErr = await Firstock.subscribe(conn, ["BSE:1"]);
+        console.log("Subscribe Error:", subscribeErr);
+    }
+
+    await new Promise(resolve => setTimeout(resolve, 25000));
+
+    // Unsubscribe
+    const unsubErr = await Firstock.unsubscribe(conn, ["NSE:26000", "BSE:1"]);
+    console.log("Unsubscribe Error:", unsubErr);
+
+    await new Promise(resolve => setTimeout(resolve, 5000));
+
+    // Close WebSocket connection
+    const closeErr = await Firstock.closeWebsocket(conn);
+    console.log("Close Error:", closeErr);
+}
+
+main();
+
+Subscribe Option Greeks Feed
+
+const { Firstock, FirstockWebSocket } = require('./websockets');
+
+// Define callback method 
+function subscribeOptionGreeksData(data) {
+    console.log(data);
+}
+
+const userId = 'YOUR_USER_ID';
+
+const model = new FirstockWebSocket({
+    subscribe_option_greeks_data: subscribeOptionGreeksData,
+    option_greeks_tokens: ["NFO:44297"]
+});
+
+async function main() {
+    const [conn, err] = await Firstock.initializeWebsockets(userId, model);
+    console.log("Error:", err);
+
+    if (conn) {
+        const subscribeErr = await Firstock.subscribeOptionGreeks(conn, ["NFO:44298"]);
+        console.log("Subscribe Error:", subscribeErr);
+    }
+
+    await new Promise(resolve => setTimeout(resolve, 25000));
+
+    // Unsubscribe
+    const unsubErr = await Firstock.unsubscribeOptionGreeks(conn, ["NFO:44297", "NFO:44298"]);
+    console.log("Unsubscribe Error:", unsubErr);
+
+    await new Promise(resolve => setTimeout(resolve, 5000));
+
+    // Close WebSocket connection
+    const closeErr = await Firstock.closeWebsocket(conn);
+    console.log("Close Error:", closeErr);
+}
+
+main();
+
+```
+
+
 Refer to the [Firstock Connect Documentation](https://connect.thefirstock.com/)  for the complete list of supported methods.
 
 
@@ -283,3 +427,9 @@ Refer to the [Firstock Connect Documentation](https://connect.thefirstock.com/)
 ## Changelog
 
 Check release notes.
+
+
+
+
+
+

package/dist/Classes/Firstock.js

@@ -933,8 +933,8 @@ class Firstock extends AFirstock_1.default {
                         callBack(err, null);
                     }
                     else if (jKey) {
-                        axiosInterceptor
-                            .post(`productConversion`, {
+                        // Prepare the request payload
+                        const requestPayload = {
                             userId,
                             jKey,
                             exchange: params.exchange,
@@ -942,7 +942,13 @@ class Firstock extends AFirstock_1.default {
                             quantity: params.quantity,
                             product: params.product,
                             previousProduct: params.previousProduct,
-                        })
+                        };
+                        // Add msgFlag to payload if provided
+                        if (params.msgFlag) {
+                            requestPayload.msgFlag = params.msgFlag;
+                        }
+                        axiosInterceptor
+                            .post(`productConversion`, requestPayload)
                             .then((response) => {
                             const { data } = response;
                             callBack(null, data);
@@ -1767,5 +1773,53 @@ class Firstock extends AFirstock_1.default {
             }
         });
     }
+    /**
+     * Retrieves holdings details for a user from the Firstock API.
+     *
+     * This method sends a request to the Firstock holdingsDetails endpoint using the provided
+     * user ID and session token (jKey) retrieved from config.json. The response contains the user's holdings information.
+     *
+     * @param {Object} params - Holdings parameters.
+     * @param {string} params.userId - Firstock user ID (e.g., SU2707).
+     * @param {function} callBack - Callback with `(error, result)`:
+     * - `error`: Error object if the request fails.
+     * - `result`: Parsed response containing holdings information if successful.
+     */
+    getHoldingsDetails({ userId }, callBack) {
+        (0, commonFunction_1.readData)((err, data) => {
+            if (err) {
+                const errorMessage = err instanceof Error ? err.message : err;
+                callBack(new Error((0, commonFunction_1.errorMessageMapping)({ message: errorMessage })), null);
+            }
+            else if (data) {
+                (0, commonFunction_1.checkifUserLoggedIn)({ userId, jsonData: data }, (err, jKey) => {
+                    if (err) {
+                        callBack(new Error(err), null);
+                    }
+                    else if (jKey) {
+                        axiosInterceptor
+                            .post("holdingsDetails", {
+                            userId,
+                            jKey
+                        })
+                            .then((response) => {
+                            const { data } = response;
+                            this.userId = userId;
+                            callBack(null, data);
+                        })
+                            .catch((error) => {
+                            callBack((0, commonFunction_1.handleError)(error), null);
+                        });
+                    }
+                    else {
+                        callBack(new Error("No jKey found for userId in config.json"), null);
+                    }
+                });
+            }
+            else {
+                callBack(new Error("No config data found"), null);
+            }
+        });
+    }
 }
 exports.Firstock = Firstock;

package/dist/test.js

@@ -7,26 +7,30 @@ const index_1 = __importDefault(require("./index"));
 const firstock = new index_1.default();
 let orderNumber = "";
 const userDetails = {
-    userId: "",
-    password: "",
-    TOTP: "",
-    vendorCode: "",
-    apiKey: "",
+    userId: "NP2997",
+    password: "Skanda@2025",
+    TOTP: "1997",
+    vendorCode: "NP2997_API",
+    apiKey: "e55eb28e18ee1337fc0b2705f9b82465",
 };
-// Login and user Details start
-// firstock.login(
-//   {
-//     userId: userDetails.userId,
-//     password: userDetails.password,
-//     TOTP: userDetails.TOTP,
-//     vendorCode: userDetails.vendorCode,
-//     apiKey: userDetails.apiKey,
-//   },
-//   (err: Error | null, result: any) => {
-//     console.log("Error: ", err);
-//     console.log("Result: ", result);
-//   }
-// );
+// const userDetails = {
+//   userId: "",
+//   password: "",
+//   TOTP: "",
+//   vendorCode: "",
+//   apiKey: "",
+// };
+// // Login and user Details start
+firstock.login({
+    userId: userDetails.userId,
+    password: userDetails.password,
+    TOTP: userDetails.TOTP,
+    vendorCode: userDetails.vendorCode,
+    apiKey: userDetails.apiKey,
+}, (err, result) => {
+    console.log("Error: ", err);
+    console.log("Result: ", result);
+});
 // // Order and report start
 // firstock.placeOrder(
 //   {
@@ -155,6 +159,21 @@ const userDetails = {
 //     console.log("productConversion Result: ", result);
 //   }
 // );
+// firstock.productConversion(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NFO",
+//     tradingSymbol: "NIFTY",
+//     quantity: "250",
+//     product: "C",
+//     previousProduct: "I",
+//     msgFlag: "1" // Buy and Day
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("productConversion (Buy & Day) Error: ", err);
+//     console.log("productConversion (Buy & Day) Result: ", result);
+//   }
+// );
 // Holdings
 // firstock.holdings(
 //   { userId: userDetails.userId},//, product: "C" 
@@ -335,6 +354,16 @@ const userDetails = {
 //     console.log("brokerageCalculator Result: ", result)
 //   }
 // )
+// Get Holdings Details
+// firstock.getHoldingsDetails(
+//   {
+//     userId: userDetails.userId
+//     },
+//   (err: Error | null, result: any) => {
+//     console.log("Error: ", err);
+//     console.log("Result: ", result);
+//   }
+// );
 // Logout
 // firstock.logout(
 //   { userId: userDetails.userId },