extra-fyers/README.md

A Javascript interface for FYERS API.<br>
📦 [Node.js](https://www.npmjs.com/package/extra-fyers),
🌐 [Web](https://www.npmjs.com/package/extra-fyers.web),
📜 [Files](https://unpkg.com/extra-fyers/),
📰 [Docs](https://nodef.github.io/extra-fyers/).

[FYERS] is one of the cheapest online stock brokers in India, that offers
trading in the equity (NSE, BSE), currency (NSE), and commodity segments (MCX).
The objective of this package is to provide a cleaner interface to [FYERS API].
The `http` namespace provides the same interface as FYERS HTTP API. The
`websocket` namespace provides the same interface as FYERS WebSocket API, along
with parsing of binary market data. This allows you to recieve *instant*
notifications of *order update* and *market data*. The top namespace (global
functions, classes) provide a [facade] for the HTTP and the WebSocket APIs and
provides additional utility functions, such as calculating charges.

Global functions associated with FYERS API, such as `getPositions()`, are
stateless and accept `Authorization` as the first parameter. On the other
hand, the `Api` class includes stateful functions which do not require
the `Authorization` parameter (required while creating object). Note that
this authorization can be obtained be performing login with `loginStep1()`
and `loginStep2()`.

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

This package is available in both *Node.js* and *Web* formats. The web format
is exposed as `extra_fyers` standalone variable and can be loaded from
[jsDelivr CDN].

> Stability: [Experimental](https://www.youtube.com/watch?v=L1j93RnIxEo).

[FYERS]: https://fyers.in
[FYERS API]: https://myapi.fyers.in/docs/
[facade]: https://en.wikipedia.org/wiki/Facade_pattern
[jsDelivr CDN]: https://cdn.jsdelivr.net/npm/extra-fyers.web/index.js

<br>

```javascript
const fyers = require('extra-fyers');

async function main() {
  var appId       = '****';  // app_id recieved after creating app
  var accessToken = '****';  // access_token recieved after login
  var api = new fyers.Api(appId, accessToken);

  // List equity and commodity fund limits.
  console.log(await api.getFunds());

  // List holdings.
  console.log(await api.getHoldings());

  // Place CNC market order for SBIN (equity) on NSE for 5 shares
  var id = await api.placeOrder({symbol: 'NSE:SBIN-EQ', quantity: 5});

  // List postions for today (should list NSE:SBIN-EQ-CNC).
  console.log(await api.getPositions());


  // Connect to Market data with WebSocket
  // and recieve real-time market quotes.
  await api.connectMarketData(quote => {
    console.log(quote);
  });
  // Choose which symbols you want to subscribe to.
  await api.subscribeMarketDepth(['NSE:SBIN-EQ']);

  // Connect to Order update with WebSocket
  // and recieve real-time order status updates.
  await api.connectOrderUpdate(order => {
    console.log(order);
  });
  // Subscribe to order status updates.
  await api.subscribeOrderUpdate();
}
main();
```

<br>
<br>


## Index

| Property | Description |
|  ----  |  ----  |
| [exchangeDescription] | Get exchange description. |
| [exchange] | Get exchange code. |
| [segmentDescription] | Get segment description. |
| [segment] | Get segment code. |
| [positionSideDescription] | Get position side description. |
| [positionSide] | Get position side code. |
| [orderSideDescription] | Get order side description. |
| [orderSide] | Get order side code. |
| [orderSourceDescription] | Get order source description. |
| [orderSource] | Get order source code. |
| [orderStatusDescription] | Get order status description. |
| [orderStatus] | Get order status code. |
| [orderTypeDescription] | Get order type description. |
| [orderType] | Get order type code. |
| [orderValidityDescription] | Get order validity description. |
| [orderValidity] | Get order validity code. |
| [optionTypeDescription] | Get option type description. |
| [optionType] | Get option type code. |
| [derivativeTypeDescription] | Get derivative type description. |
| [derivativeType] | Get derivative type code. |
| [holdingTypeDescription] | Get holding type description. |
| [holdingType] | Get holding type code. |
| [productTypeDescription] | Get product type description. |
| [productType] | Get product type code. |
| [instrumentTypeDescription] | Get instrument type description. |
| [instrumentType] | Get instrument type code. |
|  |  |
| [symbolName] | Get symbol exchange, underlying, currency-pair, or commodity name. |
| [symbolExchange] | Get symbol exchange. |
| [symbolSeries] | Get symbol exchange series. |
| [symbolOptionType] | Get symbol option type. |
| [symbolDerivativeType] | Get symbol derivative type. |
| [symbolStrikePrice] | Get symbol strike price. |
| [symbolToken] | Get symbol token, a unique identifier. |
| [symbolDescription] | Get symbol description. |
| [symbolIsin] | Get symbol ISIN. |
| [symbolLotSize] | Get symbol minimum lot size. |
|  |  |
| [equityDeliveryCharges] | Get equity delivery charges. |
| [equityIntradayCharges] | Get equity intraday charges. |
| [equityFuturesCharges] | Get equity futures charges. |
| [equityOptionsCharges] | Get equity options charges. |
| [currencyFuturesCharges] | Get currency futures charges. |
| [currencyOptionsCharges] | Get currency options charges. |
| [commodityFuturesCharges] | Get commodity futures charges. |
| [commodityOptionsCharges] | Get commodity options charges. |
|  |  |
| [loginStep1] | Get request step 1 for authorization. |
| [loginStep2] | Get request step 2 for authorization. |
|  |  |
| [getProfile] | Get basic details of the client. |
| [getFunds] | Get balance available for the user for capital as well as the commodity market. |
| [getHoldings] | Get the equity and mutual fund holdings which the user has in this demat account. |
|  |  |
| [getOrder] | Get details of an order placed in the current trading day. |
| [getOrders] | Get details of all the orders placed in the current trading day. |
| [getPositions] | Get details of all the positions in the current trading day. |
| [getTrades] | Get details of all the trades in the current trading day. |
| [placeOrder] | Place an order to any exchange via Fyers. |
| [placeOrders] | Place multiple orders to any exchange via Fyers. |
| [modifyOrder] | Modifies an order placed on any exchange via Fyers. |
| [modifyOrders] | Modifies orders placed on any exchange via Fyers. |
| [cancelOrder] | Cancels an order placed on any exchange via Fyers. |
| [cancelOrders] | Cancels orders placed on any exchange via Fyers. |
| [exitPosition] | Exits a position on the current trading day. |
| [exitAllPositions] | Exits all positions on the current trading day. |
| [convertPosition] | Converts a position on the current trading day. |
|  |  |
| [getMarketStatus] | Get the current market status of all the exchanges and their segments. |
| [getMarketHistory] | Get the market history for a particular symbol. |
| [getMarketQuotes] | Get the current market quotes for a set of symbols. |
| [getMarketDepth] | Get the current market depth for a particular symbol. |
|  |  |
| [getSymbolMaster] | Get all the latest symbols of all the exchanges from the symbol master files. |
| [processSymbolMaster] | Get details of symbols from the symbol master file text. |
| [loadSymbolMaster] | Get details of symbols from the symbol master files. |
|  |  |
| [generateEdisTpin] | Generate e-DIS TPIN for validating/authorising transaction. |
| [getEdisTransactions] | Get the necessary information regarding the holdings you have on your and also the status of the holdings. |
| [submitEdisHoldingsStep] | Redirect to CDSL page for login where you can submit your Holdings information and accordingly you can provide the same to exchange to Sell your holdings (browser only). |
| [inquireEdisTransaction] | Inquire the information/status of the provided transaction Id for the respective holdings you have on your end. |
|  |  |
| [connectMarketData] | Connect to Market data URL with WebSocket. |
| [subscribeMarketQuote] | Subscribe to market quote. |
| [subscribeMarketDepth] | Subscribe to market depth. |
| [unsubscribeMarketQuote] | Unsubscribe to market quote. |
| [unsubscribeMarketDepth] | Unsubscribe to market depth. |
| [connectOrderUpdate] | Connect to Order update URL with WebSocket. |
| [subscribeOrderUpdate] | Subscribe to order update. |
| [unsubscribeOrderUpdate] | Unsubscribe to order update. |
|  |  |
| [Api] | Stateful interface for FYERS API. |

<br>
<br>


## References

- [FYERS API Docs](https://myapi.fyers.in/docs/)
- [FYERS Community](https://community.fyers.in/)
- [FYERS Detailed Charges List](https://fyers.in/charges-list/)
- [fyers-api-v2 package](https://www.npmjs.com/package/fyers-api-v2)
- [C# wrapper of Fyers API v2 : ArthaChitra](https://github.com/arthachitra/FyersAPI)
- [Fyers API golang client : Rishi Anand](https://github.com/rishi-anand/fyers-go-client)
- [The Kite Connect API Javascript client - v4](https://kite.trade/docs/kiteconnectjs/v3/index.html)
- [Intermarket Trading System (ITS)](https://www.investopedia.com/terms/i/intermarket-trading-system.asp)
- [What are stop loss orders and how to use them?](https://support.zerodha.com/category/trading-and-markets/margin-leverage-and-product-and-order-types/articles/what-are-stop-loss-orders-and-how-to-use-them)
- [How to use Stoploss-limit(SL) order like a Stoploss-Market(SLM) order?](https://support.zerodha.com/category/trading-and-markets/margin-leverage-and-product-and-order-types/articles/how-to-use-sl-l-order-like-a-sl-m-order)
- [What is disclosed quantity feature and how to use it?](https://support.zerodha.com/category/trading-and-markets/kite-web-and-mobile/articles/what-is-disclosed-quantity-feature-and-how-to-use-it)
- [What are cover orders and how to use them?](https://support.zerodha.com/category/trading-and-markets/product-and-order-types/order/articles/what-are-cover-orders-and-how-to-use-them)
- [What does CNC, MIS and NRML mean?](https://support.zerodha.com/category/trading-and-markets/margin-leverage-and-product-and-order-types/articles/what-does-cnc-mis-and-nrml-mean)
- [What is UNDCUR,UNDIRC, UNDIRT, UNDIRT in CDs? And what its use](https://tradingqna.com/t/what-is-undcur-undirc-undirt-undirt-in-cds-and-what-its-use/756)
- [Can some one tell me what is FUTIRC?](https://tradingqna.com/t/can-some-one-tell-me-what-is-futirc/34069)
- [I want to know in nifty f & o what is futidx, futivx, futstk?](https://tradingqna.com/t/i-want-to-know-in-nifty-f-o-what-is-futidx-futivx-futstk/2367)
- [What Is a Rally?](https://www.investopedia.com/terms/r/rally.asp)

<br>
<br>

[![](https://img.youtube.com/vi/AGCC-_Cuhhw/maxresdefault.jpg)](https://www.youtube.com/watch?v=AGCC-_Cuhhw)
[![ORG](https://img.shields.io/badge/org-nodef-green?logo=Org)](https://nodef.github.io)
[![DOI](https://zenodo.org/badge/459926913.svg)](https://zenodo.org/badge/latestdoi/459926913)


[exchangeDescription]: https://nodef.github.io/extra-fyers/functions/exchangeDescription.html
[exchange]: https://nodef.github.io/extra-fyers/functions/exchange.html
[segmentDescription]: https://nodef.github.io/extra-fyers/functions/segmentDescription.html
[segment]: https://nodef.github.io/extra-fyers/functions/segment.html
[positionSideDescription]: https://nodef.github.io/extra-fyers/functions/positionSideDescription.html
[positionSide]: https://nodef.github.io/extra-fyers/functions/positionSide.html
[orderSideDescription]: https://nodef.github.io/extra-fyers/functions/orderSideDescription.html
[orderSide]: https://nodef.github.io/extra-fyers/functions/orderSide.html
[orderSourceDescription]: https://nodef.github.io/extra-fyers/functions/orderSourceDescription.html
[orderSource]: https://nodef.github.io/extra-fyers/functions/orderSource.html
[orderStatusDescription]: https://nodef.github.io/extra-fyers/functions/orderStatusDescription.html
[orderStatus]: https://nodef.github.io/extra-fyers/functions/orderStatus.html
[orderTypeDescription]: https://nodef.github.io/extra-fyers/functions/orderTypeDescription.html
[orderType]: https://nodef.github.io/extra-fyers/functions/orderType.html
[orderValidityDescription]: https://nodef.github.io/extra-fyers/functions/orderValidityDescription.html
[orderValidity]: https://nodef.github.io/extra-fyers/functions/orderValidity.html
[optionTypeDescription]: https://nodef.github.io/extra-fyers/functions/optionTypeDescription.html
[optionType]: https://nodef.github.io/extra-fyers/functions/optionType.html
[derivativeTypeDescription]: https://nodef.github.io/extra-fyers/functions/derivativeTypeDescription.html
[derivativeType]: https://nodef.github.io/extra-fyers/functions/derivativeType.html
[holdingTypeDescription]: https://nodef.github.io/extra-fyers/functions/holdingTypeDescription.html
[holdingType]: https://nodef.github.io/extra-fyers/functions/holdingType.html
[productTypeDescription]: https://nodef.github.io/extra-fyers/functions/productTypeDescription.html
[productType]: https://nodef.github.io/extra-fyers/functions/productType.html
[instrumentTypeDescription]: https://nodef.github.io/extra-fyers/functions/instrumentTypeDescription.html
[instrumentType]: https://nodef.github.io/extra-fyers/functions/instrumentType.html
[symbolName]: https://nodef.github.io/extra-fyers/functions/symbolName.html
[symbolExchange]: https://nodef.github.io/extra-fyers/functions/symbolExchange.html
[symbolSeries]: https://nodef.github.io/extra-fyers/functions/symbolSeries.html
[symbolOptionType]: https://nodef.github.io/extra-fyers/functions/symbolOptionType.html
[symbolDerivativeType]: https://nodef.github.io/extra-fyers/functions/symbolDerivativeType.html
[symbolStrikePrice]: https://nodef.github.io/extra-fyers/functions/symbolStrikePrice.html
[symbolToken]: https://nodef.github.io/extra-fyers/functions/symbolToken.html
[symbolDescription]: https://nodef.github.io/extra-fyers/functions/symbolDescription.html
[symbolIsin]: https://nodef.github.io/extra-fyers/functions/symbolIsin.html
[symbolLotSize]: https://nodef.github.io/extra-fyers/functions/symbolLotSize.html
[equityDeliveryCharges]: https://nodef.github.io/extra-fyers/functions/equityDeliveryCharges.html
[equityIntradayCharges]: https://nodef.github.io/extra-fyers/functions/equityIntradayCharges.html
[equityFuturesCharges]: https://nodef.github.io/extra-fyers/functions/equityFuturesCharges.html
[equityOptionsCharges]: https://nodef.github.io/extra-fyers/functions/equityOptionsCharges.html
[currencyFuturesCharges]: https://nodef.github.io/extra-fyers/functions/currencyFuturesCharges.html
[currencyOptionsCharges]: https://nodef.github.io/extra-fyers/functions/currencyOptionsCharges.html
[commodityFuturesCharges]: https://nodef.github.io/extra-fyers/functions/commodityFuturesCharges.html
[commodityOptionsCharges]: https://nodef.github.io/extra-fyers/functions/commodityOptionsCharges.html
[loginStep1]: https://nodef.github.io/extra-fyers/functions/loginStep1.html
[loginStep2]: https://nodef.github.io/extra-fyers/functions/loginStep2.html
[getProfile]: https://nodef.github.io/extra-fyers/functions/getProfile.html
[getFunds]: https://nodef.github.io/extra-fyers/functions/getFunds.html
[getHoldings]: https://nodef.github.io/extra-fyers/functions/getHoldings.html
[getOrder]: https://nodef.github.io/extra-fyers/functions/getOrder.html
[getOrders]: https://nodef.github.io/extra-fyers/functions/getOrders.html
[getPositions]: https://nodef.github.io/extra-fyers/functions/getPositions.html
[getTrades]: https://nodef.github.io/extra-fyers/functions/getTrades.html
[placeOrder]: https://nodef.github.io/extra-fyers/functions/placeOrder.html
[placeOrders]: https://nodef.github.io/extra-fyers/functions/placeOrders.html
[modifyOrder]: https://nodef.github.io/extra-fyers/functions/modifyOrder.html
[modifyOrders]: https://nodef.github.io/extra-fyers/functions/modifyOrders.html
[cancelOrder]: https://nodef.github.io/extra-fyers/functions/cancelOrder.html
[cancelOrders]: https://nodef.github.io/extra-fyers/functions/cancelOrders.html
[exitPosition]: https://nodef.github.io/extra-fyers/functions/exitPosition.html
[exitAllPositions]: https://nodef.github.io/extra-fyers/functions/exitAllPositions.html
[convertPosition]: https://nodef.github.io/extra-fyers/functions/convertPosition.html
[getMarketStatus]: https://nodef.github.io/extra-fyers/functions/getMarketStatus.html
[getMarketHistory]: https://nodef.github.io/extra-fyers/functions/getMarketHistory.html
[getMarketQuotes]: https://nodef.github.io/extra-fyers/functions/getMarketQuotes.html
[getMarketDepth]: https://nodef.github.io/extra-fyers/functions/getMarketDepth.html
[getSymbolMaster]: https://nodef.github.io/extra-fyers/functions/getSymbolMaster.html
[processSymbolMaster]: https://nodef.github.io/extra-fyers/functions/processSymbolMaster.html
[loadSymbolMaster]: https://nodef.github.io/extra-fyers/functions/loadSymbolMaster.html
[generateEdisTpin]: https://nodef.github.io/extra-fyers/functions/generateEdisTpin.html
[getEdisTransactions]: https://nodef.github.io/extra-fyers/functions/getEdisTransactions.html
[submitEdisHoldingsStep]: https://nodef.github.io/extra-fyers/functions/submitEdisHoldingsStep.html
[inquireEdisTransaction]: https://nodef.github.io/extra-fyers/functions/inquireEdisTransaction.html
[connectMarketData]: https://nodef.github.io/extra-fyers/functions/connectMarketData.html
[subscribeMarketQuote]: https://nodef.github.io/extra-fyers/functions/subscribeMarketQuote.html
[subscribeMarketDepth]: https://nodef.github.io/extra-fyers/functions/subscribeMarketDepth.html
[unsubscribeMarketQuote]: https://nodef.github.io/extra-fyers/functions/unsubscribeMarketQuote.html
[unsubscribeMarketDepth]: https://nodef.github.io/extra-fyers/functions/unsubscribeMarketDepth.html
[connectOrderUpdate]: https://nodef.github.io/extra-fyers/functions/connectOrderUpdate.html
[subscribeOrderUpdate]: https://nodef.github.io/extra-fyers/functions/subscribeOrderUpdate.html
[unsubscribeOrderUpdate]: https://nodef.github.io/extra-fyers/functions/unsubscribeOrderUpdate.html
[Api]: https://nodef.github.io/extra-fyers/classes/Api.html