firstock 1.0.0

package/Readme.md

@@ -0,0 +1,290 @@
+# 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.
+`<br />` Licensed under the MIT License.
+
+
+[Version - 1.0.0](https://www.npmjs.com/package/firstock)
+
+
+## Documentation
+
+* Nodejs client documentation
+
+## v3 - Changes
+
+* Error code response structured has been changed
+* Renamed
+
+## Installing the client
+
+Use the package manager [npm](https://www.npmjs.com/) to install thefirstock.
+
+```bash
+npm install firstock
+```
+
+## API usage
+
+```javascript
+const Firstock = require("firstock");
+
+const firstock = new Firstock();
+
+// Login
+firstock.login({
+  userId: "",
+  password: "",
+  TOTP: "",
+  DOBnPAN: "",
+  vendorCode: "",
+  apiKey: ""
+}, (err, result) => {
+  console.log("login Error, ", err);
+  console.log("login Result: ", result);
+});
+
+// Place an Order
+firstock.placeOrder({
+  userId: "",
+  exchange: "",
+  tradingSymbol: "",
+  quantity: "",
+  price: "",
+  product: "",
+  transactionType: "",
+  priceType: "",
+  retention: "",
+  triggerPrice: "",
+  remarks: "",
+}, (err, result) => {
+  console.log("placeOrder Error, ", err);
+  console.log("placeOrder Result: ", result);
+});
+
+// Modify an Order
+firstock.modifyOrder({
+  userId: "",
+  orderNumber: "",
+  price: "",
+  quantity: "",
+  triggerPrice: "",
+  tradingSymbol: "",
+  exchange: "",
+  priceType: "",
+  product: "",
+  retention: ""
+}, (err, result) => {
+  console.log("modifyOrder Error, ", err);
+  console.log("modifyOrder Result: ", result);
+});
+
+// Cancel an Order
+firstock.cancelOrder({
+  userId: "",
+  orderNumber: ""
+}, (err, result) => {
+  console.log("cancelOrder Error, ", err);
+  console.log("cancelOrder Result: ", result);
+});
+
+// Single Order History
+firstock.singleOrderHistory({
+  userId: "",
+  orderNumber: ""
+}, (err, result) => {
+  console.log("singleOrderHistory Error, ", err);
+  console.log("singleOrderHistory Result: ", result);
+});
+
+// Order Book
+firstock.orderBook({ userId: "" }, (err, result) => {
+  console.log("orderBook Error, ", err);
+  console.log("orderBook Result: ", result);
+});
+
+// Trade Book
+firstock.tradeBook({ userId: "" }, (err, result) => {
+  console.log("tradeBook Error, ", err);
+  console.log("tradeBook Result: ", result);
+});
+
+// Position Book
+firstock.positionBook({ userId: "" }, (err, result) => {
+  console.log("positionBook Error, ", err);
+  console.log("positionBook Result: ", result);
+});
+
+// Holdings
+firstock.holdings({ userId: "" }, (err, result) => {
+  console.log("holdings Error, ", err);
+  console.log("holdings Result: ", result);
+});
+
+// Limits
+firstock.limit({ userId: "" }, (err, result) => {
+  console.log("limit Error, ", err);
+  console.log("limit Result: ", result);
+});
+
+// Order Margin
+firstock.orderMargin({
+  userId: "",
+  exchange: "",
+  tradingSymbol: "",
+  quantity: "",
+  price: "",
+  product: "",
+  transactionType: "",
+  priceType: ""
+}, (err, result) => {
+  console.log("orderMargin Error, ", err);
+  console.log("orderMargin Result: ", result);
+});
+
+// Basket Margin
+firstock.basketMargin({
+  userId: "",
+  exchange: "",
+  transactionType: "",
+  product: "",
+  tradingSymbol: "",
+  quantity: "",
+  priceType: "",
+  price: "",
+  BasketList_Params: [ /* array of order objects */ ]
+}, (err, result) => {
+  console.log("basketMargin Error, ", err);
+  console.log("basketMargin Result: ", result);
+});
+
+// Product Conversion
+firstock.productConversion({
+  userId: "",
+  exchange: "",
+  tradingSymbol: "",
+  quantity: "",
+  product: "",
+  previousProduct: ""
+}, (err, result) => {
+  console.log("productConversion Error, ", err);
+  console.log("productConversion Result: ", result);
+});
+
+// Brokerage Calculator
+firstock.brokerageCalculator({
+  userId: "",
+  exchange: "",
+  tradingSymbol: "",
+  transactionType: "",
+  Product: "",
+  quantity: "",
+  price: "",
+  strike_price: "",
+  inst_name: "",
+  lot_size: ""
+}, (err, result) => {
+  console.log("brokerageCalculator Error, ", err);
+  console.log("brokerageCalculator Result: ", result);
+});
+
+// Get Quote
+firstock.getQuote({
+  userId: "",
+  exchange: "",
+  tradingSymbol: ""
+}, (err, result) => {
+  console.log("getQuote Error, ", err);
+  console.log("getQuote Result: ", result);
+});
+
+// Get LTP
+firstock.getQuoteltp({
+  userId: "",
+  exchange: "",
+  tradingSymbol: ""
+}, (err, result) => {
+  console.log("getQuoteltp Error, ", err);
+  console.log("getQuoteltp Result: ", result);
+});
+
+// Get Multi Quotes
+firstock.getMultiQuotes({
+  userId: "",
+  data: [
+    { exchange: "", tradingSymbol: "" },
+    // more symbols
+  ]
+}, (err, result) => {
+  console.log("getMultiQuotes Error, ", err);
+  console.log("getMultiQuotes Result: ", result);
+});
+
+// Get Multi Quotes LTP
+firstock.getMultiQuotesltp({
+  userId: "",
+  data: [
+    { exchange: "", tradingSymbol: "" },
+    // more symbols
+  ]
+}, (err, result) => {
+  console.log("getMultiQuotesltp Error, ", err);
+  console.log("getMultiQuotesltp Result: ", result);
+});
+
+// Get Index List
+firstock.indexList({ userId: "", exchange: "" }, (err, result) => {
+  console.log("indexList Error, ", err);
+  console.log("indexList Result: ", result);
+});
+
+// Get Expiry
+firstock.getExpiry({
+  userId: "",
+  exchange: "",
+  tradingSymbol: ""
+}, (err, result) => {
+  console.log("getExpiry Error, ", err);
+  console.log("getExpiry Result: ", result);
+});
+
+// Option Chain
+firstock.optionChain({
+  userId: "",
+  exchange: "",
+  symbol: "",
+  expiry: "",
+  count: "",
+  strikePrice: ""
+}, (err, result) => {
+  console.log("optionChain Error, ", err);
+  console.log("optionChain Result: ", result);
+});
+
+// Search Scrips
+firstock.searchScrips({ userId: "", stext: "" }, (err, result) => {
+  console.log("searchScrips Error, ", err);
+  console.log("searchScrips Result: ", result);
+});
+
+// Historical Data
+firstock.timePriceSeries({
+  userId: "",
+  exchange: "",
+  tradingSymbol: "",
+  startTime: "",
+  endTime: "",
+  interval: ""
+}, (err, result) => {
+  console.log("timePriceSeries Error, ", err);
+  console.log("timePriceSeries Result: ", result);
+});
+```
+
+Refer to the [Firstock Connect Documentation](https://connect.thefirstock.com/)  for the complete list of supported methods.
+
+
+
+## Changelog
+
+Check release notes.

package/config.json

@@ -0,0 +1,3 @@
+{
+  
+}

package/dist/Classes/AFirstock.d.ts

@@ -0,0 +1,227 @@
+interface Response {
+    data: {
+        [key: string]: any;
+    };
+}
+interface LoginParams {
+    userId: string;
+    password: string;
+    TOTP: string;
+    vendorCode: string;
+    apiKey: string;
+    [key: string]: any;
+}
+interface PlaceOrderParams {
+    userId: string;
+    exchange: string;
+    tradingSymbol: string;
+    quantity: string | number;
+    price: string | number;
+    product: string;
+    transactionType: string;
+    priceType: string;
+    retention: string;
+    remarks: string;
+    triggerPrice: string;
+    [key: string]: any;
+}
+interface CancelOrderParams {
+    userId: string;
+    orderNumber: string;
+    [key: string]: any;
+}
+interface ModifyOrderParams {
+    userId: string;
+    orderNumber: string;
+    price: string | number;
+    quantity: string | number;
+    triggerPrice: string | number;
+    tradingSymbol: string;
+    exchange: string;
+    priceType: string;
+    product: string;
+    retention: string;
+    [key: string]: any;
+}
+interface BasketItem {
+    exchange: string;
+    transactionType: string;
+    product: string;
+    tradingSymbol: string;
+    quantity: string | number;
+    priceType: string;
+    price: string | number;
+    [key: string]: any;
+}
+interface BasketMarginParams {
+    userId: string;
+    BasketList_Params: BasketItem[];
+    [key: string]: any;
+}
+interface SingleOrderHistoryParams {
+    userId: string;
+    orderNumber: string;
+    [key: string]: any;
+}
+interface UserDetailsParams {
+    userId: string;
+    [key: string]: any;
+}
+interface OrderMarginParams {
+    userId: string;
+    exchange: string;
+    tradingSymbol: string;
+    quantity: string | number;
+    price: string | number;
+    product: string;
+    transactionType: string;
+    priceType: string;
+    [key: string]: any;
+}
+interface ProductConversionParams {
+    userId: string;
+    exchange: string;
+    tradingSymbol: string;
+    quantity: string | number;
+    product: string;
+    previousProduct: string;
+    transactionType?: string;
+    positionType?: string;
+    [key: string]: any;
+}
+interface OrderBookParams {
+    userId: string;
+    [key: string]: any;
+}
+interface TradeBookParams {
+    userId: string;
+    [key: string]: any;
+}
+interface PositionsBookParams {
+    userId: string;
+    [key: string]: any;
+}
+interface MultiQuoteItem {
+    exchange: string;
+    tradingSymbol: string;
+    [key: string]: any;
+}
+interface GetMultiQuotesParams {
+    userId: string;
+    data: MultiQuoteItem[];
+    [key: string]: any;
+}
+interface GetQuoteLTPParams {
+    userId: string;
+    exchange: string;
+    tradingSymbol: string;
+    [key: string]: any;
+}
+interface GetMultiQuotesLTPParams {
+    userId: string;
+    data: MultiQuoteItem[];
+    [key: string]: any;
+}
+interface SearchScriptsParams {
+    userId: string;
+    stext: string;
+    [key: string]: any;
+}
+interface GetSecurityInfoParams {
+    userId: string;
+    exchange: string;
+    tradingSymbol: string;
+    [key: string]: any;
+}
+interface HoldingsParams {
+    userId: string;
+    product?: string;
+    [key: string]: any;
+}
+interface LimitsParams {
+    userId: string;
+    [key: string]: any;
+}
+interface GetQuotesParams {
+    userId: string;
+    exchange: string;
+    tradingSymbol: string;
+    [key: string]: any;
+}
+interface GetIndexListParams {
+    userId: string;
+    exchange: string;
+    [key: string]: any;
+}
+interface GetOptionChainParams {
+    userId: string;
+    exchange: string;
+    symbol: string;
+    strikePrice: string | number;
+    count: string | number;
+    expiry?: string;
+    [key: string]: any;
+}
+interface TimePriceSeriesParams {
+    userId: string;
+    exchange: string;
+    tradingSymbol: string;
+    endTime: string;
+    startTime: string;
+    interval: string | number;
+    [key: string]: any;
+}
+interface BrokerageCalculatorParams {
+    userId: string;
+    exchange: string;
+    tradingSymbol: string;
+    transactionType: string;
+    Product: string;
+    quantity: string | number;
+    price: string | number;
+    strike_price: string | number;
+    inst_name: string;
+    lot_size: string | number;
+    [key: string]: any;
+}
+interface GetExpiryParams {
+    userId: string;
+    exchange: string;
+    tradingSymbol: string;
+    [key: string]: any;
+}
+declare abstract class AFirstock {
+    constructor();
+    abstract getPosts(): Promise<any>;
+    abstract getUsers(): any;
+    abstract getPostByUserId(): any;
+    abstract login(params: LoginParams, callBack: (error: Error | null, result: Response | null) => void): void;
+    abstract logout(params: {
+        userId: string;
+    }, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract userDetails(params: UserDetailsParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract placeOrder(params: PlaceOrderParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract orderMargin(params: OrderMarginParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract cancelOrder(params: CancelOrderParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract modifyOrder(params: ModifyOrderParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract singleOrderHistory(params: SingleOrderHistoryParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract orderBook(params: OrderBookParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract tradeBook(params: TradeBookParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract positionBook(params: PositionsBookParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract productConversion(params: ProductConversionParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract holdings(params: HoldingsParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract limit(params: LimitsParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract basketMargin(params: BasketMarginParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract getQuote(params: GetQuotesParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract getQuoteltp(params: GetQuoteLTPParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract getMultiQuotesltp(params: GetMultiQuotesLTPParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract getMultiQuotes(params: GetMultiQuotesParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract searchScrips(params: SearchScriptsParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract securityInfo(params: GetSecurityInfoParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract indexList(params: GetIndexListParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract optionChain(params: GetOptionChainParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract timePriceSeries(params: TimePriceSeriesParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract getExpiry(params: GetExpiryParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+    abstract brokerageCalculator(params: BrokerageCalculatorParams, callBack: (error: Error | string | null, result: Response | null) => void): void;
+}
+export default AFirstock;

package/dist/Classes/AFirstock.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class AFirstock {
+    constructor() {
+        if (this.constructor === AFirstock) {
+            throw new Error("Abstract classes can't be instantiated.");
+        }
+    }
+}
+exports.default = AFirstock;