Pix APIs - Realtime and Historical Data in Node.js

Pix APIs - Realtime and Historical Data in Node.js

Introduction

JavaScript library to connect and stream the market data.
This is websocket and fallback transport based library with all the functionalities to get eod and live streaming data

Simple and easy integration with your web application/portal, all heavy weight work are back lifted.

What’s new

v1.2.8 : 23-Jan-2024
1. Greeks Chain Range subscription and unsubscription method.

v1.2.6 : 29-Aug-2022
- Option Chain and Option Chain Range subscription and unsubscription method.

v1.2.5 : 15-May-2022
- Previous OI added – refer ‘Refs snapshot data’ section
- Master data api with Lot size

v1.2.4 : 28-Jan-2022
- Intraducing Option Greeks

v1.2.3 : 21-Aug-2021
- New callback for Trade snapshot during subscription, earlier it was provided along with Trade callback
- Segment subscription for the entitled user

v1.2.1 : 06-May-2021
- Upper and lower price band for EQ market added – refer ‘Refs snapshot data’ section
- Live ticks aggregation which provides current day minutes bar – refer ‘History data – Inraday’ section

Simple steps to up and running

For Streaming Data

  1. Initialize
  2. Register required callbacks in apidata.callbacks
  3. Do subscribe with symbols list in apidata.stream

For History Data

  1. Initialize
  2. Async call to respective methods exposed in apidata.history

Working sample is available at the bottom of this help page

Installation

  1. npm i pix-apidata --save
Import
  1. const apidata = require("pix-apidata");
Browser
Modules are available in ‘apidata’ from the bundle.js

  1. <script src=".srcbundle.js"></script>

Initialize

This should be the first api call before making any other

  1. const apiKey = "api-access-key" //provided by your data vendor
  2. const apiHost = "apidata.accelpix.in" or "apidata5.accelpix.in" //provided by your data vendor
  3. const scheme = "https" // use either http (default scheme) or https
  4. await apidata.initialize(apiKey, apiHost, scheme) 

  6. // *** IMPORTANT ***

  8. // *** initialize(...) - returns a Promise and wait for it to complete before making any other API calls.

Symbol Master

Use below REST API to get Master Data
(Only for master data download due to larger data size)
OR
With LOT size

OR

  1. // response data
  2. // Returns Master[] with following structure
  3. Master {
  4.   xid: 1, // segment id. 1 - EQ, 2 - F&O, 3 - NCD, 5 - MCX and so on
  5.   tkr: '20MICRONS', // ticker name - used to communicate with server for data
  6.   atkr: null, // alternative ticker - used for mapping or display purpose
  7.   ctkr: null, // contract ticker or current name of FUT - used for mapping or display purpose
  8.   exp: 1970-01-01T00:00:00.000Z, // contract expiry or default to UNIX time
  9.   utkr: null, // underlying ticker of F&O contract, eg. NIFTY for NIFTY FUT or NIFTY OPT
  10.   inst: 'EQUITY', // instrument name of the symbol - EQUITY, FUTSTK, FUTIDX, OPTSTK, OPTIDX etc.
  11.   a3tkr: null, // another alternative ticker - used for mapping or display purpose
  12.   sp: '0.00', // strike price of the option contract
  13.   tk: 16921, // exchange defined token of the symbol
  14.   lot: 0 //Lot size
  15. }

Modules available

  1. apidata.history
  2. apidata.stream
  3. apidata.callbacks

Callbacks for live streaming

Trade data

  1. //callback to listen for trade data
  2. apidata.callbacks.onTrade(msg => {
  3.   console.log(msg);
  4. })

  6. //response data
  7. Trade {
  8.   id: 0,
  9.   ticker: 'BANKNIFTY-1',
  10.   segmentId: 2,
  11.   time: 2020-11-16T15:30:00.000Z,
  12.   price: 23560,
  13.   qty: 300,
  14.   volume: 7499525,
  15.   oi: 1503450,
  16.   kind: 'T'
  17. }

Trade snapshot data
  1. //callback to listen for trade snapshot, called during subcription process, 
  2. //listen to onTrade callback for continuouse stream data
  3. apidata.callbacks.onTradeSnapshot(msg => {
  4.   console.log(msg);
  5. })

  7. //response data
  8. Trade {
  9.   id: 0,
  10.   ticker: 'BANKNIFTY-1',
  11.   segmentId: 2,
  12.   time: 2020-11-16T15:30:00.000Z,
  13.   price: 23560,
  14.   qty: 300,
  15.   volume: 7499525,
  16.   oi: 1503450,
  17.   kind: 'T'
  18. }

Best data

  1. //callback to listen for bid, ask and respective qty
  2. apidata.callbacks.onBest(msg => {
  3.   console.log(msg);
  4. })

  6. //response data
  7. Best {
  8.   ticker: 'NIFTY-1',
  9.   segmentId: 2,
  10.   kind: 'B',
  11.   bidPrice: 11766.65,
  12.   bidQty: 300,
  13.   askPrice: 11768.05,
  14.   askQty: 225,
  15.   time: 2061-09-02T07:00:00.000Z
  16. }

Recent change in Refs data

  1. //callback to listen for change in o, h, l, c, oi and avg data
  2. apidata.callbacks.onRefs(msg => {
  3.   console.log(msg);
  4. })

  6. //response data
  7. Refs {
  8.   kind: 'A',
  9.   ticker: 'NIFTY-1',
  10.   segmentId: 2,
  11.   price: 11788.17
  12. }

Refs snapshot data

  1. //callback to listen for o, h, l, c, oi and avg snapshot
  2. apidata.callbacks.onRefsSnapshot(msg => {
  3.   console.log(msg);
  4. })

  6. //response data
  7. RefsSnapshot {
  8.   kind: 'V',
  9.   ticker: 'BANKNIFTY-1',
  10.   segmentId: 2,
  11.   open: 23201.2,
  12.   close: 23110.3,
  13.   high: 23717,
  14.   low: 23183,
  15.   avg: 23470.65,
  16.   oi: 1503450,
  17.   upperBand: 0,
  18.   lowerBand: 0,
  19.   poi: 15898756
  20. }

Option Greek data

  1. //callback to listen for Greeks data
  2. apidata.callbacks.onGreeks(msg => {
  3.   console.log(msg);
  4. })

  6. //response data
  7. Greeks {
  8.   kind: 'G',
  9.   token: 0,
  10.   ticker: 'BANKNIFTY2240737500CE',
  11.   iv: 0.2588011622428894,
  12.   delta: 0.8822246193885803,
  13.   theta: -77.46974182128906,
  14.   vega: 2.561089515686035,
  15.   gamma: 0.0005879841046407819,
  16.   ivvwap: 0.18449798226356506,
  17.   vanna: -3.667503833770752,
  18.   charm: 1.109373927116394,
  19.   speed: -0.000002092838712997036,
  20.   zomma: 0.0009008663473650813,
  21.   color: 0.0002725007652770728,
  22.   volga: 5643.75439453125,
  23.   veta: 2929.610107421875,
  24.   tgr: -131754.828125,
  25.   tv: -30.24874496459961,
  26.   dtr: -0.011387989856302738,
  27.   highiv: 0,
  28.   lowiv: 0,
  29.   twapiv: 0.19661587476730347,
  30.   timestamp: 0  timestamp:1333597502420254464 //Time in nanoseconds from 01-Jan-1980 00:00:00 UTC
  31. }

Greek snapshot data

  1. //callback to listen greek snapshot
  2. apidata.callbacks.onGreekSnapshot(msg => {
  3.   console.log(msg);
  4. })

  6. //response data
  7. Greeks {
  8.   kind: 'G',
  9.   token: 0,
  10.   ticker: 'BANKNIFTY2240737500CE',
  11.   iv: 0.2588011622428894,
  12.   delta: 0.8822246193885803,
  13.   theta: -77.46974182128906,
  14.   vega: 2.561089515686035,
  15.   gamma: 0.0005879841046407819,
  16.   ivvwap: 0.18449798226356506,
  17.   vanna: -3.667503833770752,
  18.   charm: 1.109373927116394,
  19.   speed: -0.000002092838712997036,
  20.   zomma: 0.0009008663473650813,
  21.   color: 0.0002725007652770728,
  22.   volga: 5643.75439453125,
  23.   veta: 2929.610107421875,
  24.   tgr: -131754.828125,
  25.   tv: -30.24874496459961,
  26.   dtr: -0.011387989856302738,
  27.   highiv: 0,
  28.   lowiv: 0,
  29.   twapiv: 0.19661587476730347,
  30.   timestamp:1333597502420254464 //Time in nanoseconds from 01-Jan-1980 00:00:00 UTC
  31. }

Callbacks for connection status

  1. // Fired when connection is successful
  2. apidata.callbacks.onConnected(() => {
  3.   console.log("Connected successfully...");
  4. })

  6. // Fired when the connection is closed after automatic retry or some issues in networking
  7. // Need to re-establish the connection manually
  8. apidata.callbacks.onClosed((err) => {
  9.   console.log("Connected close due to...", err);
  10. })

Live stream subscription

Subscribe to receive updates of segments entitled to you

  1. var needSnapshot = false;
  2. var status = await apidata.stream.subscribeSegments(needSnapshot)
  3. // IMPORTANT NOTE:
  4. // If needSnapshot = true, then buffer the updates received on 'apidata.callbacks.onTradeSnapshot' and 'apidata.callbacks.onRefsSnapshot' before processing. 
  5. // Data transfer is huge and you may get disconnected from server in-case if you don't process the incoming updates as fast enough.
  6. // It's advised to buffer the data then process it once 'apidata.stream.subscribeSegments' method returns.

Subscribe to receive ALL updates of the symbols subscribed

  1. //subscribe single symbol
  2. await apidata.stream.subscribeAll(['NIFTY-1'])
  3. //subscribe multiple symbol
  4. await apidata.stream.subscribeAll(['NIFTY-1','BANKNIFTY-1'])

Subscribe to receive TRADE updates of the symbols subscribed

  1. await apidata.stream.subscribeTrade(['NIFTY-1','BANKNIFTY-1'])

Subscribe to receive REFS and BEST updates of the symbols subscribed

  1. await apidata.stream.subscribeBestAndRefs(['NIFTY-1','INFY-1']);

Subscribe Greek live stream

  1. await apidata.stream.subscribeGreeks(['NIFTY2220318500CE'])

Subscribe Optionchain live stream
  1. //params: underlying ticker, ExpiryDate
  2. await apidata.stream.subscribeOptionChain('NIFTY', '20220609');
Unsubscribe live stream

  1. //unsubscribe single symbol
  2. await apidata.stream.unsubscribeAll(['NIFTY-1'])
  3. //unsubscribe multiple symbol
  4. await apidata.stream.unsubscribeAll(['NIFTY-1','BANKNIFTY-1'])

Subscribe and Unsubscribe Greeks data

  1. await apidata.stream.subscribeGreeks(['NIFTY2220318500CE','NIFTY2220318000PE'])
  2. await apidata.stream.unsubscribeGreeks(['NIFTY2220318500CE','NIFTY2220318000PE'])

Subscribe and Unsubscribe Option Chain

  1. //subscribe to full chain
  2. await apidata.stream.subscribeOptionChain('BANKNIFTY','20220901')
  3. //subscribe to range of strikes(CE, PE) considering current spot value(at time of subscribe) as the mid-point, essentially 10 strike(CE,PE) below mid-point and 10 strikes(CE, PE) above mid-point and total of 40 contracts subscribed for the below call.
  4. await apidata.stream.subscribeOptionChainRange('NIFTY','20220901',10)
  5. //unsubscribe the chain
  6. await apidata.stream.unsubscribeOptionChain('NIFTY','20220901')

Subscribe and Unsubscribe Greeks Chain

  1. //subscribe to range of strikes(CE, PE) considering current spot value(at time of subscribe) as the mid-point, essentially 10 strike(CE,PE) below mid-point and 10 strikes(CE, PE) above mid-point and total of 40 contracts subscribed for the below call.
  2. //params: underlying ticker, ExpiryDate, NoOfStrikes

  4. await apidata.stream.subscribeGreeksChainRange('NIFTY','20220901',10)

  6. //unsubscribe the chain
  7. await apidata.stream.unsubscribeGreeksChain('NIFTY','20220901')

History data – Eod

  1. //*** Continues data
  2. //params: ticker, startDate, endDate
  3. await apidata.history.getEod("NIFTY-1", "20200828", "20200901")

  5. //*** Contract data
  6. //params: underlying ticker, startDate, endDate, contractExpiryDate
  7. await apidata.history.getEodContract("NIFTY", "20200828", "20200901", "20201029")

  9. //response data
  10. {
  11.   td: '2020-08-28T00:00:00',
  12.   op: 11630,
  13.   hp: 11708,
  14.   lp: 11617.05,
  15.   cp: 11689.05,
  16.   vol: 260625,
  17.   oi: 488325
  18. }

History data – Inraday

Provides intra-eod bars with the time resolution in minutes (default:’5′ mins)
You can set minute resolution to ‘1’, ‘5’, ’10’ and so on.
Custom minute resolution also supported like ‘3’, ‘7’ and so on.
Passing CURRENT DATE as parameter in ‘toDate’ will respond the LIVE ticks aggregated upto the time it traded today. Last BAR of the current day may be incomplete. Current day tick aggregation response will always provide complete bar list from the beginning of day.

  1. //*** Continues data
  2. //params: ticker, startDate, endDate, resolution
  3. await apidata.history.getIntraEod("NIFTY-1", "20200828", "20200901", "5")

  5. //*** Contract data
  6. //params: underlying ticker, startDate, endDate, contractExpiryDate
  7. await apidata.history.getIntraEodContract("NIFTY", "20200828", "20200901", "20201029", "5")

  9. //response data
  10. {
  11.   td: '2020-08-28T09:15:00',
  12.   op: 11630,
  13.   hp: 11643.45,
  14.   lp: 11630,
  15.   cp: 11639.8,
  16.   vol: 4575,
  17.   oi: 440475
  18. }
History data – Ticks

Provides back log ticks from the date time specified till current live time, that is the ticks available till request hit the server.

  1. //params: ticker, fromDateTime
  2. await apidata.history.getBackTicks("BANKNIFTY-1", "20201016 15:00:00")

  4. //response data
  5. {
  6.   td: 2020-11-16T15:00:01.000Z,
  7.   pr: 23600,
  8.   vol: 125,
  9.   oi: 1692375
  10. }

Sample API Example

  1. var apidata = require('pix-apidata')

  3. const apiKey = "your-api-key"
  4. const apiServer = "apidata.accelpix.in"

  6. apidata.callbacks.onTrade(t => {
  7.   console.log(t);
  8. })
  9. apidata.callbacks.onGreeks(greek => {
  10.   console.log(greek);
  11. })

  13. apidata.initialize(apiKey, apiServer)
  14.   .then(async () => {
  15.     await apidata.stream.subscribeAll(['NIFTY-1'])
  16.     await apidata.stream.subscribeGreeks(["NIFTY2220318500CE"])
  17.     await apidata.stream.subscribeOptionChainRange('NIFTY', '20220609',7)
  18.     await apidata.stream.subscribeGreeksChainRange('NIFTY', '20220609',5)
  19.     // await apidata.stream.unsubscribeOptionChain('NIFTY', '20220609');
  20.     let eod = await apidata.history.getEod('NIFTY 50', '20201001', '20201030')
  21.     console.log(eod);
  22.   })

    • Related Articles

    • Pix APIs - Realtime and Historical Data in Python

      Introduction Python library to connect and stream the market data. This is websocket and fallback transport based library with all the functionalities to get EOD and live streaming data Simple and easy integration with your web application, all ...

    • Pix APIs - Realtime and Historical Data in REST

      ACCELPIX REST API REST API for historical and tick data download EOD Data: GET http://{server}/api/fda/rest/{ticker}/{yyyyMMdd:start}/{yyyyMMdd:end}?api_token={your api key} Example: http://apidata5.accelpix.in/api/fda/rest/NIFTY ...

    • How to configure Realtime NSE Data in Excel ?

      India's Fastest Realtime (Tick by Tick 1 Sec Updates) Data in MS Excel. The following are the minimum requirements: - 1. Microsoft Office Excel 2010 or above 2. Pix Connect Elite and the Above plans can be used with Excel. How to Setup Pix Connect ...

    • Symbols Format for realtime data APIs

      We are providing all symbols as per NSE including Futures (Contract and Continuous Both) and Options (Weekly and Monthly). Let's go through some examples and understand the symbology. General Terminology in API:- T = Trade Packet B = Best Packet V = ...

    • How to download Daily IEOD Incremental Data using Pix Connect ?

      Intraday End of Day Data ( IEOD ) is too crucial for backtesting purposes, that's why we do provide for all our subscribers at FREE OF COST with REALTIME Data Subscription. We are updating these data every day within 25 min after the market close (at ...