Repository files navigation

A Javascript interface for FYERS API.
📦Node.js,🌐Web,📜Files,📰Docs.

FYERS is one of the cheapest online stock brokers in India, that offerstrading in the equity (NSE, BSE), currency (NSE), and commodity segments (MCX).The objective of this package is to provide a cleaner interface toFYERS API.Thehttp namespace provides the same interface as FYERS HTTP API. Thewebsocket namespace provides the same interface as FYERS WebSocket API, alongwith parsing of binary market data. This allows you to recieveinstantnotifications oforder update andmarket data. The top namespace (globalfunctions, classes) provide afacade for the HTTP and the WebSocket APIs andprovides additional utility functions, such as calculating charges.

Global functions associated with FYERS API, such asgetPositions(), arestateless and acceptAuthorization as the first parameter. On the otherhand, theApi class includes stateful functions which do not requiretheAuthorization parameter (required while creating object). Note thatthis authorization can be obtained be performing login withloginStep1()andloginStep2().

The goals for the future include doing a thorough interface check, and possiblywriting a CLI interface. Obtaining details of symbols, including images and morecould be done as part of a separate package.

This package is available in bothNode.js andWeb formats. The web formatis exposed asextra_fyers standalone variable and can be loaded fromjsDelivr CDN.

Stability:Experimental.

constfyers=require('extra-fyers');asyncfunctionmain(){varappId='****';// app_id recieved after creating appvaraccessToken='****';// access_token recieved after loginvarapi=newfyers.Api(appId,accessToken);// List equity and commodity fund limits.console.log(awaitapi.getFunds());// List holdings.console.log(awaitapi.getHoldings());// Place CNC market order for SBIN (equity) on NSE for 5 sharesvarid=awaitapi.placeOrder({symbol:'NSE:SBIN-EQ',quantity:5});// List postions for today (should list NSE:SBIN-EQ-CNC).console.log(awaitapi.getPositions());// Connect to Market data with WebSocket// and recieve real-time market quotes.awaitapi.connectMarketData(quote=>{console.log(quote);});// Choose which symbols you want to subscribe to.awaitapi.subscribeMarketDepth(['NSE:SBIN-EQ']);// Connect to Order update with WebSocket// and recieve real-time order status updates.awaitapi.connectOrderUpdate(order=>{console.log(order);});// Subscribe to order status updates.awaitapi.subscribeOrderUpdate();}main();

• FYERS API Docs
• FYERS Community
• FYERS Detailed Charges List
• fyers-api-v2 package
• C# wrapper of Fyers API v2 : ArthaChitra
• Fyers API golang client : Rishi Anand
• The Kite Connect API Javascript client - v4
• Intermarket Trading System (ITS)
• What are stop loss orders and how to use them?
• How to use Stoploss-limit(SL) order like a Stoploss-Market(SLM) order?
• What is disclosed quantity feature and how to use it?
• What are cover orders and how to use them?
• What does CNC, MIS and NRML mean?
• What is UNDCUR,UNDIRC, UNDIRT, UNDIRT in CDs? And what its use
• Can some one tell me what is FUTIRC?
• I want to know in nifty f & o what is futidx, futivx, futstk?
• What Is a Rally?