Documentation

Getting Started

You must register to use NSE APIs, and you will be entitled to products attached to the package you subscribed to. Products are mainly API data sources, however we are adding widget (or dashboard) products and mass downloads.

General Features

The API is RESTful based, thus it permits seamless integration of market data to your software solutions
Data coverage includes equities, debts, exchange traded products and indices
All data sources are intentionally delayed between 15 to 20 minutes
You can retrieve data in Json or XML format with a poll based connection
Our data subscription pricing is largely based on maximum monthly data download (i.e. hits)
Most data products basically use number of data request count to compute usage hits, while others could use retrieved data record counts or request parameters for usage hit computation
You need to specify your data access token in order to retrieve any data from NSE Market data API

Basic Integration Guide

URL format: http://marketdataapi.nse.com.ng/version/product.{format}?{parameters}_t={token}
URL example: http://marketdataapi.nse.com.ng/v2/api/index/indexmembers.json?s=ASI&_t=Dud70!kl
Secured URL: https://marketdataapi.nse.com.ng:8447/v2/api/index/indexmembers.json?s=ASI&_t=Dud70!kl

Contact NSE to purchase a subscription
You will receive an on-boarding email containing portal login credentials and data access token covering your interested data products
Construct your data access using above url format i.e. concatenating root URL and product path.
Pass your access token along with your URL with _t parameter.
Alternatively, you can use basic http authorization header but using concatenation of your username and your access token as password (i.e. username:token) all encoded using the RFC2045-MIME variant of Base64.
Make provision for exception handling. See the specific product detail below to learn the data schema and use accordingly.
Whenever possible, do not expose your data access token on the client side.
If you are integrating to a very frequently visited page, consider developing internal data management feature to ensure you stay within your subscription recommended monthly maximum hit band.
You can leverage on 3rd party cloud streaming middleware such as Streamdata.io to convert our API to a data push service.
Contact us for beskope requirements

API Products

Category	Data	Description	Parameters	Sample
Fundamental	Dividends	Provides dividends paid by listed companies Request URL: `~/api/fundamental/dividends.{ext}` Usage Calculation: 0 - 10 records = 1 hit. Above 10 records = 2 hits. If no period (from date and to date) parameter is specified, you can retrieve up to a 30 years dividend payment history.	s: company symbol. e.g. s=DANGCEM f: optional. from date. e.g. f=1990-01-01 t: optional. to date. e.g. f=2000-01-01	xml json
Index	Index Members	Provides index members of NSE indices as at request date Request URL: `~/api/index/indexmembers.{ext}` Usage Calculation: 1 Identifier = 1 hit. If no index identifier parameter is specified, system will return all index members for all NSE indices e.g. ASI, and NSE30.	s: comma seperated index symbols. e.g. s=NSE30	xml json
Market Activities	Market Status	Provides current market status (open or close) and other details such as trading date, previous and next trading dates. Request URL: `~/api/marketactivity/marketstatus.{ext}` Usage Calculation: All requests = 0 hit. Free.	None	xml json
	Most Active	Provides list of most active traded stock by volume. Request URL: `~/api/marketactivity/mostactives.{ext}` Usage Calculation: 1 request = 1 hit. If maximum number of securities are not specified, system defaults to 10.	n: Optional. Max number of securities. e.g. n=5	xml json
	Top Gainers	Provides list of stocks with highest price appreciation. Request URL: `~/api/marketactivity/topgainers.{ext}` Usage Calculation: 1 request = 1 hit. If maximum number of securities are not specified, system defaults to 10.	n: Optional. Max number of securities. e.g. n=5	xml json
	Top Losers	Provides list of stocks with highest price depreciation. Request URL: `~/api/marketactivity/toplosers.{ext}` Usage Calculation: 1 request = 1 hit. If maximum number of securities are not specified, system defaults to 10.	n: Optional. Max number of securities. e.g. n=5	xml json
Prices	Price Tickers	Provides prices tickers for all tradable securities or asset classes i.e. equities, fixed income and exchange traded funds. Request URL: `~/api/price/pricetickers.{ext}` Usage Calculation: 1 request = 1 hit. If no asset classification parameter is specified then price tickers for all asset classes will be returned.	a: Optional. Asset classification (EQUITY, DEBT, ETF). e.g. a=EQUITY.	xml json rss
	Interday Prices	Provides up to 10 years OHLCV price history for specified security. Date is in ticks followed by Open price, Day High price, Day Low price, Day Close price and Volume traded. Request URL: `~/api/price/interdayprices.{ext}` Usage Calculation: 0 - 300 records = 1 hit. 301 - 1500 records = 2 hits. Above 1500 records = 3 hits.	s: Symbol. e.g. s=FBNH f: Optional. From date. e.g. f=2005-01-01 t: Optional. To date. e.g. f=2005-01-01	xml json
	End of day Prices	Provides end of day price data for all asset classes. Request URL: `~/api/price/endofdayprices.{ext}` Usage Calculation: 1 request = 2 hits.	a: Optional. Asset class (EQUITY,DEBT,ETF) e.g. a=DEBT	xml json
Quotes	Stock Quote	Provides stock quote for companies listed on The Exchange. Request URL: `~/api/quote/stockquotes.{ext}` Usage Calculation: 1 record = 1 hit.	s: Comma separated company symbols e.g. s=DANGCEM	xml json
Trades	Today Trades	Provides trade data for the current trade date. Request URL: `~/api/trade/todaytrades.{ext}` Usage Calculation: 0 - 1000 records = 1 hit. 1001 - 5000 = 2 hits. Above 5000 = 3 hits.	s: Optional. Comma separated company symbols e.g. s=DANGCEM f: Optional. From time e.g. f=2016-10-31 10:00:00 t: Optional. To time e.g. f=2016-10-31 10:20:00	xml json

CSI data field means Compliance Standard Indicator. The Exchange uses it to disclore or indicate listed company's compliance status. Hence, you are mandated to display this [CSI] field on your all finished widgets.

Dashboards & Widgets Products

Ticker Tape

This allows you to streamlessly embed NSE price ticker tape on your website, or other display units. You can perform basic branding by supplying desired customization parameter(s) which in turn will override the widget's internal css classes. If you require extensive customization, you could consider developing your own ticker tape by directly using our Price Tickers API data source.

Request URL: ~/app/tickertape
Usage Calculation: 1 request = 1 hit.

Customization Parameters:
font-size: This changes widget font size. Default value is "50px".
font-family: This changes widget font family. Default value is "'Helvetica Neue', Helvetica, Arial, sans-serif".
item-left: Ticker item left side padding. Default value is "20px".
item-right: Ticker item right side padding. Default value is "15px".
font-color: Widget font color setting. Default value is "black".
up-color: Ticker up price movement color. Default value is "#3c763d".
dwn-color: Ticker down price movement color. Default value is "#a94442".
nil-color: Ticker no price movement color. Default value is "#8a6d3b".

~/app/tickertape?font-size=small&item-left=10px&nil-color=#3c763d
The above customized url will change the widget's font size to css 'small' value, reduce each security's item left padding and set no price movement color same as up price movement color.