Socket
Socket
Sign inDemoInstall

5paisajs

Package Overview
Dependencies
87
Maintainers
1
Versions
22
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

5paisajs

Javascript client for 5paisa APIs natively written in .NET

    0.0.20
    GitHub
    npm

Version published
Maintainers
1
Weekly downloads
59
decreased by-26.25%

Weekly downloads

Readme

Source

5paisajs

Official Javascript client for 5paisa APIs natively written in .NET

Installation

npm install 5paisajs --save

Documentation

Docs are hosted at https://5paisa.github.io/5paisa-js/

Usage

Authentication

Get your API keys from https://www.5paisa.com/DeveloperAPI/APIKeys

// Configuration for your app
const conf = {
  appSource: "",
  appName: "",
  userId: "",
  password: "",
  userKey: "",
  encryptionKey: ""
};

const { FivePaisaClient } = require("5paisajs");

var client = new FivePaisaClient(conf);

// This client object can be used to login multiple users.
client
  .get_TOTP_Session("Client code", "TOTP", "PIN")
  .then(response => {
    // Fetch holdings, positions or place orders here.
    // Some things to try out are given below.
  })
  .catch(err => {
    // Oh no :/
    console.log(err);
  });

Fetch Holdings

client
  .getHoldings()
  .then(holdings => {
    console.log(holdings);
  })
  .catch(err => {
    console.log(err);
  });

/*
[
  {
    BseCode: 535755,
    CurrentPrice: 140,
    DPQty: 0,
    Exch: '\x00',
    ExchType: 'C',
    FullName: 'XYZ ABC',
    NseCode: 30108,
    POASigned: 'N',
    PoolQty: 1,
    Quantity: 1,
    ScripMultiplier: 1,
    Symbol: 'XYZ'
  }
]
*/

Fetch Positions

client
  .getPositions()
  .then(positions => {
    console.log(positions);
  })
  .catch(err => {
    console.log(err);
  });

Place order

var options = {
  exchangeSegment: "C",
  atMarket: false,
  isStopLossOrder: false,
  stopLossPrice: 0,
  isVTD: false,
  isIOCOrder: false,
  isIntraday: false,
  ahPlaced: "N",
  IOCOrder: false,
  price: 208
};
try {
  client.placeOrder("BUY", "1660", "1", "N", options).then(response => {
    console.log(response);
  });
} catch (err) {
  console.log(err);
}

Modify order

    client.modifyOrder("1100000007628729", "1", "210", "1660", false, "N", "C", true).then((response) => {
            console.log(response)
        })
    } ).catch((err) => {
        console.log(err)
    });

Cancel Order

 client.cancelOrder("1100000007973827", "1", "205", "1660", false, "N", "C", false).then((response) => {
            console.log(response)
        })
    } ).catch((err) => {
        console.log(err)
    });

Place BO-CO Order

var a = {};
client
  .bocoorder(1660, 1, 205, 0, 217, "B", "N", "C", "P", 200, a)
  .then(Response => {
    console.log(Response);
  })
  .catch(err => {
    console.log(err);
  });
// Note : For Cover order par Order_for='c'

Modified Bo-Co Order

var a = {
  ExchOrderId: "1100000008193800"
};
client
  .bocoorder(1660, 1, 205, 0, 217, "B", "N", "C", "M", 200, a)
  .then(Response => {
    console.log(Response);
  })
  .catch(err => {
    console.log(err);
  });

// Note : We Can not Modify Target And Stoploss legs

Modify legs of Executed Bo-Co Order

var ab = {
  price: 215
};

client
  .Mod_bo_order("S", 1660, 1, "N", "1100000008697274", ab)
  .then(Response => {
    console.log(Response);
  })
  .catch(err => {
    console.log(err);
  });
// Note : This is for modify profit order.

var ab = {
  isStopLossOrder: true,
  stopLossPrice: 205,
  isIntraday: true,
  atMarket: true
};

client
  .Mod_bo_order("S", 1660, 1, "N", "1100000008697274", ab)
  .then(Response => {
    console.log(Response);
  })
  .catch(err => {
    console.log(err);
  });
// Note : this is for modify stoploss order.

MarketFeed

a = [
  {
    Exch: "N",
    ExchType: "D",
    Symbol: "NIFTY 27 MAY 2021 CE 14500.00",
    Expiry: "20210527",
    StrikePrice: "14500",
    OptionType: "CE"
  }
];

client
  .getMarketFeed(a)
  .then(response => {
    console.log(response);
  })
  .catch(err => {
    console.log(err);
  });

MarketDepth

a = [
  { Exchange: "N", ExchangeType: "D", ScripCode: "51440" },
  { Exchange: "N", ExchangeType: "C", ScripCode: "1660" }
];
client
  .getmarketdepth(a)
  .then(response => {
    console.log(response);
  })
  .catch(err => {
    console.log(err);
  });

Historical Data

// historicalData(<Exchange>,<Exchange Type>,<Scrip Code>,<Time Frame>,<From Data>,<To Date>)
a = client.historicalData("n", "c", "1660", "1m", "2021-05-31", "2021-06-01");

//Note: Timeframe should be from this list ['1m','5m','10m','15m','30m','60m','1d']

Keywords

FAQs

Last updated on 13 Jun 2023

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc