❤
npm
Sign UpSign In

upstox-js-sdk

2.11.0 • Public • Published

Upstox Node Js SDK for API v2

Introduction

The official Node.js client for communicating with the Upstox API.

Upstox API is a set of rest APIs that provide data required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio, stream live market data (using Websocket), and more, with the easy to understand API collection.

  • API version: v2
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

This SDK is automatically generated by the Swagger Codegen project.

Documentation.

Upstox API Documentation

Installation

For Node.js

npm

npm install upstox-js-sdk --save

Examples

Sample Implementations can be found within /examples folder.

Getting Started

Please follow the installation instruction and execute the following JS code:

var UpstoxClient = require('upstox-js-sdk');
var defaultClient = UpstoxClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAUTH2
var OAUTH2 = defaultClient.authentications['OAUTH2'];
OAUTH2.accessToken = "YOUR ACCESS TOKEN"

var api = new UpstoxClient.ChargeApi()
var instrumentToken = "instrumentToken_example"; // {String} Key of the instrument
var quantity = 56; // {Number} Quantity with which the order is to be placed
var product = "product_example"; // {String} Product with which the order is to be placed
var transactionType = "transactionType_example"; // {String} Indicates whether its a BUY or SELL order
var price = 3.4; // {Number} Price with which the order is to be placed
var apiVersion = "apiVersion_example"; // {String} API Version Header

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBrokerage(instrumentToken, quantity, product, transactionType, price, apiVersion, callback);

Documentation for API Endpoints

All URIs are relative to https://api-v2.upstox.com

Class Method HTTP request Description
UpstoxClient.ChargeApi getBrokerage GET /v2/charges/brokerage Brokerage details
UpstoxClient.ChargeApi postMargin POST /v2/charges/margin Calculate Margin
UpstoxClient.HistoryApi getHistoricalCandleData GET /v2/historical-candle/{instrumentKey}/{interval}/{to_date} Historical candle data
UpstoxClient.HistoryApi getHistoricalCandleData1 GET /v2/historical-candle/{instrumentKey}/{interval}/{to_date}/{from_date} Historical candle data
UpstoxClient.HistoryApi getIntraDayCandleData GET /v2/historical-candle/intraday/{instrumentKey}/{interval} Intra day candle data
UpstoxClient.LoginApi authorize GET /v2/login/authorization/dialog Authorize API
UpstoxClient.LoginApi logout DELETE /v2/logout Logout
UpstoxClient.LoginApi token POST /v2/login/authorization/token Get token API
UpstoxClient.MarketHolidaysAndTimingsApi getExchangeTimings GET /v2/market/timings/{date} Get Exchange Timings on particular date
UpstoxClient.MarketHolidaysAndTimingsApi getHoliday GET /v2/market/holidays/{date} Get Holiday on particular date
UpstoxClient.MarketHolidaysAndTimingsApi getHolidays GET /v2/market/holidays Get Holiday list of current year
UpstoxClient.MarketHolidaysAndTimingsApi getMarketStatus GET /v2/market/status/{exchange} Get Market status for particular exchange
UpstoxClient.MarketQuoteApi getFullMarketQuote GET /v2/market-quote/quotes Market quotes and instruments - Full market quotes
UpstoxClient.MarketQuoteApi getMarketQuoteOHLC GET /v2/market-quote/ohlc Market quotes and instruments - OHLC quotes
UpstoxClient.MarketQuoteApi ltp GET /v2/market-quote/ltp Market quotes and instruments - LTP quotes.
UpstoxClient.OptionsApi getOptionContracts GET /v2/option/contract Get option contracts
UpstoxClient.OptionsApi getPutCallOptionChain GET /v2/option/chain Get option chain
UpstoxClient.OrderApi cancelMultiOrder DELETE /v2/order/multi/cancel Cancel multi order
UpstoxClient.OrderApi cancelOrder DELETE /v2/order/cancel Cancel order
UpstoxClient.OrderApi exitPositions POST /v2/order/positions/exit Exit all positions
UpstoxClient.OrderApi getOrderBook GET /v2/order/retrieve-all Get order book
UpstoxClient.OrderApi getOrderDetails GET /v2/order/history Get order history
UpstoxClient.OrderApi getOrderStatus GET /v2/order/details Get order details
UpstoxClient.OrderApi getTradeHistory GET /v2/order/trades/get-trades-for-day Get trades
UpstoxClient.OrderApi getTradesByOrder GET /v2/order/trades Get trades for order
UpstoxClient.OrderApi modifyOrder PUT /v2/order/modify Modify order
UpstoxClient.OrderApi placeMultiOrder POST /v2/order/multi/place Place multi order
UpstoxClient.OrderApi placeOrder POST /v2/order/place Place order
UpstoxClient.PortfolioApi convertPositions PUT /v2/portfolio/convert-position Convert Positions
UpstoxClient.PortfolioApi getHoldings GET /v2/portfolio/long-term-holdings Get Holdings
UpstoxClient.PortfolioApi getPositions GET /v2/portfolio/short-term-positions Get Positions
UpstoxClient.PostTradeApi getTradesByDateRange GET /v2/charges/historical-trades
UpstoxClient.TradeProfitAndLossApi getProfitAndLossCharges GET /v2/trade/profit-loss/charges Get profit and loss on trades
UpstoxClient.TradeProfitAndLossApi getTradeWiseProfitAndLossData GET /v2/trade/profit-loss/data Get Trade-wise Profit and Loss Report Data
UpstoxClient.TradeProfitAndLossApi getTradeWiseProfitAndLossMetaData GET /v2/trade/profit-loss/metadata Get profit and loss meta data on trades
UpstoxClient.UserApi getProfile GET /v2/user/profile Get profile
UpstoxClient.UserApi getUserFundMargin GET /v2/user/get-funds-and-margin Get User Fund And Margin
UpstoxClient.WebsocketApi getMarketDataFeed GET /v2/feed/market-data-feed Market Data Feed
UpstoxClient.WebsocketApi getMarketDataFeedAuthorize GET /v2/feed/market-data-feed/authorize Market Data Feed Authorize
UpstoxClient.WebsocketApi getPortfolioStreamFeed GET /v2/feed/portfolio-stream-feed Portfolio Stream Feed
UpstoxClient.WebsocketApi getPortfolioStreamFeedAuthorize GET /v2/feed/portfolio-stream-feed/authorize Portfolio Stream Feed Authorize

Documentation for Feeder Functions

Connecting to the WebSocket for market and portfolio updates is streamlined through two primary Feeder functions:

  1. MarketDataStreamer: Offers real-time market updates, providing a seamless way to receive instantaneous information on various market instruments.
  2. PortfolioDataStreamer: Delivers updates related to the user's orders, enhancing the ability to track order status and portfolio changes effectively.

Both functions are designed to simplify the process of subscribing to essential data streams, ensuring users have quick and easy access to the information they need.

Detailed Explanation of Feeder Functions

MarketDataStreamer

The MarketDataStreamer function is designed for effortless connection to the market WebSocket, enabling users to receive instantaneous updates on various instruments. The following example demonstrates how to quickly set up and start receiving market updates for selected instrument keys:

let UpstoxClient = require("upstox-js-sdk");
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications["OAUTH2"];
OAUTH2.accessToken = <ACCESS_TOKEN>;

const streamer = new UpstoxClient.MarketDataStreamer(["MCX_FO|426268", "MCX_FO|427608"], "full");
streamer.connect();

streamer.on("message", (data) => {
  const feed = data.toString("utf-8");
  console.log(feed);
});

In this example, you first authenticate using an access token, then instantiate MarketDataStreamer with specific instrument keys and a subscription mode. Upon connecting, the streamer listens for market updates, which are logged to the console as they arrive.

Feel free to adjust the access token placeholder and any other specifics to better fit your actual implementation or usage scenario.

Exploring the MarketDataStreamer Functionality

Modes

  • ltpc: ltpc provides information solely about the most recent trade, encompassing details such as the last trade price, time of the last trade, quantity traded, and the closing price from the previous day.
  • full: The full option offers comprehensive information, including the latest trade prices, D5 depth, 1-minute, 30-minute, and daily candlestick data, along with some additional details.

Functions

  1. constructor MarketDataStreamer(instrumentKeys, mode): Initializes the streamer with optional instrument keys and mode (full or ltpc).
  2. connect(): Establishes the WebSocket connection.
  3. subscribe(instrumentKeys, mode): Subscribes to updates for given instrument keys in the specified mode. Both parameters are mandatory.
  4. unsubscribe(instrumentKeys): Stops updates for the specified instrument keys.
  5. changeMode(instrumentKeys, mode): Switches the mode for already subscribed instrument keys.
  6. disconnect(): Ends the active WebSocket connection.
  7. autoReconnect(enable, interval, retryCount): Customizes auto-reconnect functionality. Parameters include a flag to enable/disable it, the interval(in seconds) between attempts, and the maximum number of retries.

Events

  • open: Emitted upon successful connection establishment.
  • close: Indicates the WebSocket connection has been closed.
  • message: Delivers market updates.
  • error: Signals an error has occurred.
  • reconnecting: Announced when a reconnect attempt is initiated.
  • autoReconnectStopped: Informs when auto-reconnect efforts have ceased after exhausting the retry count.

The following documentation includes examples to illustrate the usage of these functions and events, providing a practical understanding of how to interact with the MarketDataStreamer effectively.


  1. Subscribing to Market Data on Connection Open with MarketDataStreamer
let UpstoxClient = require("upstox-js-sdk");
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications["OAUTH2"];
OAUTH2.accessToken = <ACCESS_TOKEN>;

const streamer = new UpstoxClient.MarketDataStreamer();
streamer.connect();

// Subscribe to instrument keys upon the 'open' event
streamer.on("open", () => {
  streamer.subscribe(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full");
});

// Handle incoming market data messages
streamer.on("message", (data) => {
  const feed = data.toString("utf-8");
  console.log(feed);
});

  1. Subscribing to Instruments with Delays
let UpstoxClient = require("upstox-js-sdk");
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications["OAUTH2"];
OAUTH2.accessToken = <ACCESS_TOKEN>;

const streamer = new UpstoxClient.MarketDataStreamer();
streamer.connect();

// Subscribe to the first set of instrument keys immediately upon connection
streamer.on("open", () => {
  streamer.subscribe(["NSE_EQ|INE020B01018"], "full");
  
  // Subscribe to another set of instrument keys after a delay
  setTimeout(() => {
    streamer.subscribe(["NSE_EQ|INE467B01029"], "full");
  }, 5000); // 5-second delay before subscribing to the second set
});

// Handle incoming market data messages
streamer.on("message", (data) => {
  const feed = data.toString("utf-8");
  console.log(feed);
});

  1. Subscribing and Unsubscribing to Instruments
let UpstoxClient = require("upstox-js-sdk");
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications["OAUTH2"];
OAUTH2.accessToken = <ACCESS_TOKEN>;

const streamer = new UpstoxClient.MarketDataStreamer();
streamer.connect();

// Subscribe to instrument keys immediately upon connection
streamer.on("open", () => {
  console.log("Connected. Subscribing to instrument keys.");
  streamer.subscribe(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full");
  
  // Unsubscribe after a delay
  setTimeout(() => {
    console.log("Unsubscribing from instrument keys.");
    streamer.unsubscribe(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"]);
  }, 5000); // Adjust delay as needed
});

streamer.on("message", (data) => {
  const feed = data.toString("utf-8");
  console.log("Market Update:", feed);
});

  1. Subscribe, Change Mode and Unsubscribe
let UpstoxClient = require("upstox-js-sdk");
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications["OAUTH2"];
OAUTH2.accessToken = <ACCESS_TOKEN>;

const streamer = new UpstoxClient.MarketDataStreamer();
streamer.connect();

// Initially subscribe to instrument keys in 'full' mode
streamer.on("open", async () => {
  console.log("Connected. Subscribing in full mode...");
  streamer.subscribe(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full");

  // Change mode to 'ltpc' after a short delay
  setTimeout(() => {
    console.log("Changing subscription mode to ltpc...");
    streamer.changeMode(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "ltpc");
  }, 5000); // 5-second delay

  // Unsubscribe after another delay
  setTimeout(() => {
    console.log("Unsubscribing...");
    streamer.unsubscribe(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"]);
  }, 10000); // 10 seconds after subscription
});

// Setup event listeners to log messages, errors, and closure
streamer.on("message", (data) => {
  const feed = data.toString("utf-8");
  console.log("Market Update:", feed);
});
streamer.on("error", (error) => console.error("Error:", error));
streamer.on("close", () => console.log("Connection closed."));

  1. Disable Auto-Reconnect
let UpstoxClient = require("upstox-js-sdk");
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications["OAUTH2"];
OAUTH2.accessToken = <ACCESS_TOKEN>;

const streamer = new UpstoxClient.MarketDataStreamer();
streamer.connect();

// Disable auto-reconnect feature
streamer.autoReconnect(false);

streamer.on("autoReconnectStopped", (data) => {
  console.log(data);
});

  1. Modify Auto-Reconnect parameters
let UpstoxClient = require("upstox-js-sdk");
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications["OAUTH2"];
OAUTH2.accessToken = <ACCESS_TOKEN>;

const streamer = new UpstoxClient.MarketDataStreamer();
streamer.connect();

// Modify auto-reconnect parameters: enable it, set interval to 10 seconds, and retry count to 3
streamer.autoReconnect(true, 10, 3);

PortfolioDataStreamer

Connecting to the Portfolio WebSocket for real-time order updates is straightforward with the PortfolioDataStreamer function. Below is a concise guide to get you started on receiving updates:

let UpstoxClient = require("upstox-js-sdk");
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications["OAUTH2"];
OAUTH2.accessToken = "<ACCESS_TOKEN>";

const streamer = new UpstoxClient.PortfolioDataStreamer();
streamer.connect();

streamer.on("message", (data) => {
  const feed = data.toString("utf-8");
  console.log(feed);
});

This example demonstrates initializing the PortfolioDataStreamer, connecting it to the WebSocket, and setting up an event listener to receive and print order updates. Replace <ACCESS_TOKEN> with your valid access token to authenticate the session.

Exploring the PortfolioDataStreamer Functionality

Functions

  1. constructor PortfolioDataStreamer(): Initializes the streamer.
  2. connect(): Establishes the WebSocket connection.
  3. disconnect(): Ends the active WebSocket connection.
  4. autoReconnect(enable, interval, retryCount): Customizes auto-reconnect functionality. Parameters include a flag to enable/disable it, the interval(in seconds) between attempts, and the maximum number of retries.

Events

  • open: Emitted upon successful connection establishment.
  • close: Indicates the WebSocket connection has been closed.
  • message: Delivers market updates.
  • error: Signals an error has occurred.
  • reconnecting: Announced when a reconnect attempt is initiated.
  • autoReconnectStopped: Informs when auto-reconnect efforts have ceased after exhausting the retry count.

Documentation for Models

Readme

Keywords

Package Sidebar

Install

npm i upstox-js-sdk

Repository

github.com/upstox/upstox-nodejs

Homepage

github.com/upstox/upstox-nodejs#readme

Weekly Downloads

181

Version

2.11.0

License

MIT

Unpacked Size

2.39 MB

Total Files

381

Last publish

Collaborators

  • upstox
Try on RunKit
Report malware