firstock 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import Firstock from "./Classes/Firstock";
+export default Firstock;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Firstock_1 = __importDefault(require("./Classes/Firstock"));
+exports.default = Firstock_1.default;

package/dist/shared/commonFunction.d.ts

@@ -0,0 +1,26 @@
+interface BasketMarginObject {
+    exchange?: string;
+    tradingSymbol?: string;
+    quantity?: string | number;
+    transactionType?: string;
+    [key: string]: any;
+}
+interface JsonData {
+    [key: string]: {
+        jKey: string;
+        [key: string]: any;
+    };
+}
+declare const saveData: (data: any, file: string, callback: (err: NodeJS.ErrnoException | null) => void) => void;
+declare const readData: (callback: (err: Error | string | null, data: JsonData | null) => void) => void;
+declare const checkifUserLoggedIn: ({ userId, jsonData }: {
+    userId: string;
+    jsonData: JsonData;
+}, callback: (err: string | null, jKey: string | null) => void) => void;
+declare const errorMessageMapping: (jsonData: {
+    message?: string;
+}) => string;
+declare const validateBasketMarginObject: (data: BasketMarginObject) => boolean;
+declare const validateBasketMargin: (data: BasketMarginObject[]) => boolean;
+declare const handleError: (error: any) => any;
+export { saveData, readData, validateBasketMarginObject, validateBasketMargin, handleError, checkifUserLoggedIn, errorMessageMapping, };

package/dist/shared/commonFunction.js

@@ -0,0 +1,110 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorMessageMapping = exports.checkifUserLoggedIn = exports.handleError = exports.validateBasketMargin = exports.validateBasketMarginObject = exports.readData = exports.saveData = void 0;
+const fs = __importStar(require("fs"));
+const saveData = (data, file, callback) => {
+    const path = "./config.json";
+    const jsonData = JSON.stringify(data, null, 2);
+    fs.writeFile(path, jsonData, callback);
+};
+exports.saveData = saveData;
+const readData = (callback) => {
+    const path = "./config.json";
+    fs.readFile(path, "utf-8", (err, jsonString) => {
+        if (err) {
+            callback(err, null);
+        }
+        else {
+            try {
+                const data = JSON.parse(jsonString);
+                callback(null, data);
+            }
+            catch (error) {
+                callback(error, null);
+            }
+        }
+    });
+};
+exports.readData = readData;
+const checkifUserLoggedIn = ({ userId, jsonData }, callback) => {
+    if (jsonData[userId]) {
+        const jKey = jsonData[userId].jKey;
+        callback(null, jKey);
+    }
+    else {
+        callback("Please login to Firstock", null);
+    }
+};
+exports.checkifUserLoggedIn = checkifUserLoggedIn;
+const jsonErrorMessage = {
+    "Unexpected end of JSON input": "Please login to Firstock",
+};
+const errorMessageMapping = (jsonData) => {
+    var _a, _b;
+    return (_b = (_a = jsonErrorMessage[jsonData.message || ""]) !== null && _a !== void 0 ? _a : jsonData.message) !== null && _b !== void 0 ? _b : "Unknown error";
+};
+exports.errorMessageMapping = errorMessageMapping;
+const validateBasketMarginObject = (data) => {
+    if (data["exchange"] &&
+        data["tradingSymbol"] &&
+        data["quantity"] &&
+        data["transactionType"]) {
+        return true;
+    }
+    return false;
+};
+exports.validateBasketMarginObject = validateBasketMarginObject;
+const validateBasketMargin = (data) => {
+    return data.every((a) => validateBasketMarginObject(a));
+};
+exports.validateBasketMargin = validateBasketMargin;
+const handleError = (error) => {
+    if (error) {
+        if (error.response) {
+            if (error.response.data) {
+                return error.response.data;
+            }
+            else {
+                return error.response;
+            }
+        }
+        else {
+            return error;
+        }
+    }
+    return "error";
+};
+exports.handleError = handleError;

package/dist/shared/constant.d.ts

@@ -0,0 +1,2 @@
+declare const API_LINK = "https://api.firstock.in/V1";
+export { API_LINK };

package/dist/shared/constant.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_LINK = void 0;
+const API_LINK = "https://api.firstock.in/V1";
+exports.API_LINK = API_LINK;

package/dist/test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test.js

@@ -0,0 +1,345 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Firstock_1 = __importDefault(require("./Classes/Firstock"));
+const firstock = new Firstock_1.default();
+let orderNumber = "";
+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: Error | null, result: any) => {
+//     console.log("Error: ", err);
+//     console.log("Result: ", result);
+//   }
+// );
+// // Order and report start
+// firstock.placeOrder(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NSE",
+//     tradingSymbol: "IDEA-EQ",
+//     quantity: "1",
+//     price: "7.00",
+//     product: "C",
+//     transactionType: "B",
+//     priceType: "LMT",
+//     retention: "DAY",
+//     triggerPrice: "0",
+//     remarks: "Add market protection",
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("Error, ", err);
+//     console.log("placeOrder Result: ", result);
+//     if (result?.data?.orderNumber) {
+//       orderNumber = result.data.orderNumber;
+//       modifyOrder(orderNumber);
+//     } else {
+//       console.log("No orderNumber returned");
+//     }
+//   }
+// );
+//  const modifyOrder = (orderNumber: string) => {
+//   firstock.modifyOrder(
+//     {
+//       userId: userDetails.userId,
+//       orderNumber: orderNumber,
+//       price: "7.01",
+//       quantity: "1",
+//       triggerPrice: "0",
+//       tradingSymbol: "IDEA-EQ",
+//       exchange: "NSE",
+//       priceType: "LMT",
+//       product:"C",
+//       retention:"DAY"
+//     },
+//     (err: Error | string | null, result: any) => {
+//       console.log("Error, ", err);
+//       console.log("modifyOrder Result: ", result);
+//       if (!err) {
+//         singleOrderHistory(orderNumber);
+//       }
+//     }
+//   );
+//  }
+// const singleOrderHistory = (orderNumber: string) => {
+//   firstock.singleOrderHistory({ userId: userDetails.userId, orderNumber: orderNumber }, (err: Error | string | null, result: any) => {
+//     console.log("Error, ", err);
+//     console.log("singleOrderHistory Result: ", result);
+//     if (!err) {
+//       cancelOrder(orderNumber);
+//     }
+//   });
+// };
+// const cancelOrder = (orderNumber: string) => {
+//   firstock.cancelOrder({ userId: userDetails.userId, orderNumber: orderNumber }, (err: Error | string | null, result: any) => {
+//     console.log("Error, ", err);
+//     console.log("Cancel Result: ", result);
+//   });
+// };
+// // Get User Details
+// firstock.userDetails(
+//   { userId: userDetails.userId },
+//   (err: Error | string | null, result: any) => {
+//     console.log("getUserDetails Error, ", err);
+//     console.log("getUserDetails Result: ", result);
+//   }
+// );
+// // Order Margin
+// firstock.orderMargin(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NSE",
+//     tradingSymbol: "IDEA-EQ",
+//     quantity: "1",
+//     price: "10.00",
+//     product: "C",
+//     transactionType: "B",
+//     priceType: "LMT",
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("orderMargin Error, ", err);
+//     console.log("orderMargin Result: ", result);
+//   }
+// );
+// // Order Book
+// firstock.orderBook(
+//   { userId: userDetails.userId },
+//   (err: Error | string | null, result: any) => {
+//     console.log("Error, ", err);
+//     console.log("orderBook Result: ", result);
+//   }
+// );
+// // Trade Book
+// firstock.tradeBook(
+//   { userId: userDetails.userId },
+//   (err: Error | string | null, result: any) => {
+//     console.log("tradeBook Error, ", err);
+//     console.log("tradeBook Result: ", result);
+//   }
+// );
+// // Positions Book
+// firstock.positionBook(
+//   { userId: userDetails.userId },
+//   (err: Error | string | null, result: any) => {
+//     console.log("positionsBook Error, ", err);
+//     console.log("positionsBook Result: ", result);
+//   }
+// );
+// Product Conversion
+// firstock.productConversion(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NFO",
+//     tradingSymbol: "NIFTY",
+//     quantity: "250",
+//     product: "C",
+//     previousProduct: "I"
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("productConversion Error, ", err);
+//     console.log("productConversion Result: ", result);
+//   }
+// );
+// Holdings
+// firstock.holdings(
+//   { userId: userDetails.userId},//, product: "C" 
+//   (err: Error | string | null, result: any) => {
+//     console.log("holdings Error, ", err);
+//     console.log("holdings Result: ", result);
+//   }
+// );
+// Limits
+// firstock.limit(
+//   { userId: userDetails.userId },
+//   (err: Error | string | null, result: any) => {
+//     console.log("Error, ", err);
+//     console.log("limits Result: ", result);
+//   }
+// );
+// Basket Margin
+// firstock.basketMargin(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NSE",
+//     transactionType: "B",
+//     product: "C",
+//     tradingSymbol: "RELIANCE-EQ",
+//     quantity: "1",
+//     priceType: "MKT",
+//     price: "0",
+//     BasketList_Params: [
+//       {
+//         exchange: "NSE",
+//         transactionType: "B",
+//         product: "C",
+//         tradingSymbol: "IDEA-EQ",
+//         quantity: "1",
+//         priceType: "MKT",
+//         price: "0"
+//       }
+//     ],
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("basketMargin Error, ", err);
+//     console.log("basketMargin Result: ", result);
+//   }
+// );
+// Get Quotes
+// firstock.getQuote(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NSE",
+//     tradingSymbol: "IDEA-EQ",
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("getQuotes Error, ", err);
+//     console.log("getQuotes Result: ", result);
+//   }
+// );
+// Get Quote LTP
+// firstock.getQuoteltp(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NSE",
+//     tradingSymbol: "RELIANCE-EQ",
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("getQuoteltp Error, ", err);
+//     console.log("getQuoteltp Result: ", result);
+//   }
+// );
+// Get Multi Quotes
+// firstock.getMultiQuotes(
+//   {
+//     userId: userDetails.userId,
+//     data: [
+//       { exchange: "NSE", tradingSymbol: "Nifty 50" },
+//       { exchange: "NSE", tradingSymbol: "NIFTY03APR25C23500" },
+//       { exchange: "NFO", tradingSymbol: "Nifty 50" },
+//       { exchange: "NFO", tradingSymbol: "NIFTY03APR25C23500" },
+//     ],
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("getMultiQuotes Error, ", err);
+//     console.log("getMultiQuotes Result: ", result);
+//   }
+// );
+// Get Multi Quotes LTP
+// firstock.getMultiQuotesltp(
+//   {
+//     userId: userDetails.userId,
+//     data: [{ exchange: "NSE", tradingSymbol: "Nifty 50" }],
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("getMultiQuotesltp Error, ", err);
+//     console.log("getMultiQuotesltp Result: ", result);
+//   }
+// );
+// Search Scripts
+// firstock.searchScrips(
+//   { userId: userDetails.userId, stext: "ITC" },
+//   (err: Error | string | null, result: any) => {
+//     console.log("searchScripts Error, ", err);
+//     console.log("searchScripts Result: ", result);
+//   }
+// );
+// firstock.securityInfo(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NSE",
+//     tradingSymbol: "NIFTY",
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("getSecurityInfo Error, ", err);
+//     console.log("getSecurityInfo Result: ", result);
+//   }
+// );
+// Get Index List
+// firstock.indexList(
+//   { userId: userDetails.userId, exchange: "NSE" },
+//   (err: Error | string | null, result: any) => {
+//     console.log("getIndexList Error, ", err);
+//     console.log("getIndexList Result: ", result);
+//   }
+// );
+// Get Option Chain
+// firstock.optionChain(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NFO",
+//     symbol: "NIFTY",
+//     expiry: "17APR25",
+//     count: "5",
+//     strikePrice: "23150"
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("optionChain Error, ", err);
+//     console.log("optionChain Result: ", result);
+//   }
+// );
+// firstock.timePriceSeries(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NSE",
+//     tradingSymbol: "NIFTY",
+//     startTime: "09:15:00 23-04-2025",
+//     endTime: "15:29:00 23-04-2025",
+//     interval: "1mi",
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("timePriceSeries Error, ", err);
+//     console.log("timePriceSeries Result: ", result);
+//   }
+// );
+// firstock.getExpiry(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NSE",
+//     tradingSymbol: "NIFTY"
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("getExpiry Error, ", err);
+//     console.log("getExpiry Result: ", result);
+//   }
+// );
+// firstock.brokerageCalculator(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NFO",
+//     tradingSymbol: "RELIANCE27FEB25F",
+//     transactionType: "B",
+//     Product: "M",
+//     quantity: "500",
+//     price: "125930",
+//     strike_price: "0",
+//     inst_name: "FUTSTK",
+//     lot_size: "1"
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("brokerageCalculator Error, ", err);
+//     console.log("brokerageCalculator Result: ", result)
+//   }
+// )
+// Logout
+// firstock.logout(
+//   { userId: userDetails.userId },
+//   (err: Error | string | null, result: any) => {
+//     console.log("Error, ", err);
+//     console.log("Result: ", result);
+//   }
+// );

package/index.js

@@ -0,0 +1,4 @@
+const Firstock = require("./Classes/Firstock");
+
+
+module.exports = Firstock;

package/index.ts

@@ -0,0 +1,4 @@
+import Firstock from "./Classes/Firstock";
+
+
+export default Firstock;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "firstock",
+  "version": "1.0.0",
+  "description": "Node js package for using firstock developer apis",
+  "main": "dist/index.js",
+  "type": "commonjs",
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/the-firstock/firstock-developer-sdk-nodejs"
+  },
+  "keywords": [
+    "firstock"
+  ],
+  "author": "firstock",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/the-firstock/firstock-developer-sdk-nodejs"
+  },
+  "homepage": "https://github.com/the-firstock/firstock-developer-sdk-nodejs#readme",
+  "dependencies": {
+    "axios": "^1.10.0",
+    "sha256": "^0.2.0"
+  },
+  "devDependencies": {
+    "@types/sha256": "^0.2.2",
+    "typescript": "^5.8.3"
+  }
+}

package/shared/commonFunction.ts

@@ -0,0 +1,99 @@
+import * as fs from "fs";
+
+interface BasketMarginObject {
+  exchange?: string;
+  tradingSymbol?: string;
+  quantity?: string | number;
+  transactionType?: string;
+  [key: string]: any;
+}
+
+interface JsonData {
+  [key: string]: {
+    jKey: string;
+    [key: string]: any;
+  };
+}
+
+const saveData = (data: any, file: string, callback: (err: NodeJS.ErrnoException | null) => void): void => {
+  const path = "./config.json";
+  const jsonData = JSON.stringify(data, null, 2);
+  fs.writeFile(path, jsonData, callback);
+};
+
+const readData = (callback: (err: Error | string | null, data: JsonData | null) => void): void => {
+  const path = "./config.json";
+  fs.readFile(path, "utf-8", (err: NodeJS.ErrnoException | null, jsonString: string) => {
+    if (err) {
+      callback(err, null);
+    } else {
+      try {
+        const data = JSON.parse(jsonString);
+        callback(null, data);
+      } catch (error) {
+        callback(error as Error, null);
+      }
+    }
+  });
+};
+
+const checkifUserLoggedIn = (
+  { userId, jsonData }: { userId: string; jsonData: JsonData },
+  callback: (err: string | null, jKey: string | null) => void
+): void => {
+  if (jsonData[userId]) {
+    const jKey = jsonData[userId].jKey;
+    callback(null, jKey);
+  } else {
+    callback("Please login to Firstock", null);
+  }
+};
+
+const jsonErrorMessage: { [key: string]: string } = {
+  "Unexpected end of JSON input": "Please login to Firstock",
+};
+
+const errorMessageMapping = (jsonData: { message?: string }): string => {
+    return jsonErrorMessage[jsonData.message || ""] ?? jsonData.message ?? "Unknown error";
+  };
+
+const validateBasketMarginObject = (data: BasketMarginObject): boolean => {
+  if (
+    data["exchange"] &&
+    data["tradingSymbol"] &&
+    data["quantity"] &&
+    data["transactionType"]
+  ) {
+    return true;
+  }
+  return false;
+};
+
+const validateBasketMargin = (data: BasketMarginObject[]): boolean => {
+  return data.every((a) => validateBasketMarginObject(a));
+};
+
+const handleError = (error: any): any => {
+  if (error) {
+    if (error.response) {
+      if (error.response.data) {
+        return error.response.data;
+      } else {
+        return error.response;
+      }
+    } else {
+      return error;
+    }
+  }
+  return "error";
+};
+
+export {
+  saveData,
+  readData,
+  validateBasketMarginObject,
+  validateBasketMargin,
+  handleError,
+  checkifUserLoggedIn,
+  errorMessageMapping,
+};

package/shared/constant.ts

@@ -0,0 +1,4 @@
+const API_LINK = "https://api.firstock.in/V1";
+
+
+export { API_LINK };