NSEPython

https://unofficed.com/nse-python/documentation
Admin
NSEPython is a Python library designed to access publicly available data from the NSE website,...
Tokens:30,246
Snippets:114
Trust Score:8.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Fetch NSE Indices

Source: https://unofficed.com/nse-python/documentation/index

Demonstrates how to import the nsepython library and fetch a list of available NSE indices. This is a basic example for getting started with the library.

```python
from nsepython import *
print(indices)
```

--------------------------------

### Example: Get Top Gainers

Source: https://unofficed.com/nse-python/documentation/nsetools

Demonstrates how to call the `nse_get_top_gainers()` function to fetch the list of top gaining stocks.

```python
print(nse_get_top_gainers())
```

--------------------------------

### Example: Get Top Losers

Source: https://unofficed.com/nse-python/documentation/nsetools

Demonstrates how to call the `nse_get_top_losers()` function to fetch the list of top losing stocks.

```python
print(nse_get_top_losers())
```

--------------------------------

### Example: Get F&O Lot Sizes (All Symbols, Default Mode)

Source: https://unofficed.com/nse-python/documentation/nsetools

Illustrates calling `nse_get_fno_lot_sizes()` without arguments to retrieve F&O lot sizes for all symbols in the default list format.

```python
print(nse_get_fno_lot_sizes())
```

--------------------------------

### Install NSEPython Server Edition

Source: https://unofficed.com/nse-python/documentation/index

Installs the server edition of the NSEPython library using pip. This version is designed for server environments such as AWS, Google Colab, and DigitalOcean.

```Shell
pip install nsepythonserver
```

--------------------------------

### Example: Get F&O Lot Sizes (Single Symbol, List Mode)

Source: https://unofficed.com/nse-python/documentation/nsetools

Shows how to get the F&O lot size for a specific stock symbol ('adaniports') in list format.

```python
print(nse_get_fno_lot_sizes("adaniports"))
```

--------------------------------

### Install NSEPython Local Edition

Source: https://unofficed.com/nse-python/documentation/index

Installs the local edition of the NSEPython library using pip. This version is specifically tailored for compatibility with Windows 9 and Windows 10 environments.

```Shell
pip install nsepython
```

--------------------------------

### Example: Get F&O Lot Sizes (Single Symbol, Pandas Mode)

Source: https://unofficed.com/nse-python/documentation/nsetools

Demonstrates fetching F&O lot sizes for a specific stock symbol ('adaniports') and returning the output as a Pandas DataFrame.

```python
print(nse_get_fno_lot_sizes("adaniports","pandas"))
```

--------------------------------

### NSE Expiry Details Output Example

Source: https://unofficed.com/nse-python/documentation/custom

Illustrates the typical output format for the nse_expirydetails function, showing the expiry date and the number of days remaining until expiry.

```text
2021-06-10
11
```

--------------------------------

### NSEPython Logger Function Example

Source: https://unofficed.com/nse-python/documentation/basic

Demonstrates how to enable and use Python's logging module with NSEPython to debug network requests and data retrieval. It shows fetching 'lastPrice' and 'pChange' for a given symbol from the F&O list.

```python
from nsepython import *
logging.basicConfig(level=logging.DEBUG)

def nse_custom_function_secfno(symbol,attribute="lastPrice"):
    positions = nsefetch('https://www.nseindia.com/api/equity-stockIndices?index=SECURITIES%20IN%20F%26O')
    endp = len(positions['data'])
    for x in range(0, endp):
        if(positions['data'][x]['symbol']==symbol.upper()):
            return positions['data'][x][attribute]

print(nse_custom_function_secfno("Reliance"))
print(nse_custom_function_secfno("Reliance","pChange"))
```

--------------------------------

### NSE Expiry Details Usage Example

Source: https://unofficed.com/nse-python/documentation/custom

Shows how to use the nse_expirydetails function to get the expiry date and DTE for the next expiry. The output displays the expiry date and the calculated DTE.

```python
payload=nse_optionchain_scrapper('BANKNIFTY')
currentExpiry,dte=nse_expirydetails(payload,1)
print(currentExpiry)
print(dte)
```

--------------------------------

### Sample Derivative Data Output

Source: https://unofficed.com/nse-python/documentation/nsepy

An example of the tabular data output returned by a derivative history query. It includes various financial metrics like symbol, prices, volume, and timestamps for a given security.

```text
_id CH_SYMBOL CH_SERIES CH_MARKET_TYPE  CH_TRADE_HIGH_PRICE  CH_TRADE_LOW_PRICE  CH_OPENING_PRICE  CH_CLOSING_PRICE  CH_LAST_TRADED_PRICE  CH_PREVIOUS_CLS_PRICE  CH_TOT_TRADED_QTY  CH_TOT_TRADED_VAL  CH_52WEEK_HIGH_PRICE  CH_52WEEK_LOW_PRICE  CH_TOTAL_TRADES       CH_ISIN CH_TIMESTAMP  TIMESTAMP                 createdAt  
0  60c744e8fa749200099709a1      SBIN        EQ              N                432.45              416.70            427.00            430.35                430.00                 429.60           30106015       1.279312e+10                441.95               169.25           279081  INE062A01020   2021-06-14  2021-06-13T18:30:00.000Z  2021-06-14T12:00:40.201Z  
1  60c3505b99ad6d0008be9c68      SBIN        EQ              N                435.50              425.25            434.85            429.60            429.40                 432.25           26831924       1.153870e+10                441.95               169.25           211915  INE062A01020   2021-06-11  2021-06-10T18:30:00.000Z  2021-06-11T12:00:27.251Z  
2  60c1fefe81433a00081e9a8d      SBIN        EQ              N                433.30              422.40            424.90            432.25            432.40                 421.45           27397712       1.174471e+10                441.95               169.25           211924  INE062A01020   2021-06-10  2021-06-09T18:30:00.000Z  2021-06-10T12:01:02.131Z  
3  60c0ad631318bc0008009871      SBIN        EQ              N                432.30              418.20            427.50            421.45            421.95                 427.20           27784834       1.185249e+10                441.95               169.25           241080  INE062A01020   2021-06-09  2021-06-08T18:30:00.000Z  2021-06-09T12:00:35.995Z  
4  60bf5be2d2265400080d7d9b      SBIN        EQ              N                432.50              424.00            432.25            427.20            427.40                 432.25           31113823       1.330030e+10                441.95               169.25           247824  INE062A01020   2021-06-08  2021-06-07T18:30:00.000Z  2021-06-08T12:00:34.187Z  

                  updatedAt  __v    VWAP   mTIMESTAMP
0  2021-06-14T12:00:40.201Z    0  424.94  14-Jun-2021
1  2021-06-11T12:00:27.251Z    0  430.04  11-Jun-2021
2  2021-06-10T12:01:02.131Z    0  428.67  10-Jun-2021
3  2021-06-09T12:00:35.995Z    0  426.58  09-Jun-2021
4  2021-06-08T12:00:34.187Z    0  427.47  08-Jun-2021
```

--------------------------------

### Example Usage: Fetching Trade Info with nse_quote

Source: https://unofficed.com/nse-python/documentation/basic

Demonstrates how to use the updated `nse_quote` function with the `section` parameter to retrieve specific trade information for a given symbol.

```python
print(nse_quote("INFY","trade_info"))
```

--------------------------------

### NSE F&O Lotsize Data Dictionary

Source: https://unofficed.com/nse-python/documentation/nsetools

This snippet displays a Python dictionary containing the lotsizes for various NSE F&O symbols. It serves as an output example for fetching this data.

```python
{
	'BANKNIFTY': 25, 
	'FINNIFTY': 40, 
	'NIFTY': 75, 
	'AUROPHARMA': 650, 
	'ADANIPORTS': 1250, 
	'AARTIIND': 425, 
	'ALKEM': 200, 
	'AMARAJABAT': 1000, 
	'APLLTD': 550, 
	'APOLLOHOSP': 250, 
	'APOLLOTYRE': 2500, 
	'ASHOKLEY': 4500, 
	'ASIANPAINT': 300, 
	'AUBANK': 500, 
	'CADILAHC': 2200, 
	'AXISBANK': 1200, 
	'BAJAJ-AUTO': 250, 
	'BAJAJFINSV': 125, 
	'BERGEPAINT': 1100, 
	'BAJFINANCE': 125, 
	'BALKRISIND': 400, 
	'BANDHANBNK': 1800, 
	'BEL': 3800, 
	'BIOCON': 2300, 
	'BHARATFORG': 1500, 
	'BHARTIARTL': 1851, 
	'BHEL': 10500, 
	'DEEPAKNTR': 500, 
	'BRITANNIA': 200, 
	'CHOLAFIN': 1250, 
	'COALINDIA': 4200, 
	'COFORGE': 375, 
	'DIVISLAB': 200, 
	'CONCOR': 1563, 
	'FEDERALBNK': 10000, 
	'DABUR': 1250, 
	'HCLTECH': 700, 
	'DLF': 3300, 
	'EICHERMOT': 350, 
	'ESCORTS': 550, 
	'EXIDEIND': 3600, 
	'GAIL': 6100, 
	'GLENMARK': 1150, 
	'GODREJCP': 1000, 
	'GODREJPROP': 650, 
	'GRANULES': 1550, 
	'GRASIM': 475, 
	'GUJGASLTD': 1250, 
	'M&MFIN': 4000, 
	'HAVELLS': 500, 
	'HDFC': 300, 
	'HDFCAMC': 200, 
	'HDFCBANK': 550, 
	'HINDALCO': 2150, 
	'HINDPETRO': 2700, 
	'HINDUNILVR': 300, 
	'IBULHSGFIN': 3100, 
	'ICICIBANK': 1375, 
	'ICICIGI': 425, 
	'IDFCFIRSTB': 9500, 
	'INDIGO': 500, 
	'IRCTC': 325, 
	'ITC': 3200, 
	'JINDALSTEL': 2500, 
	'SAIL': 9500, 
	'JSWSTEEL': 1350, 
	'JUBLFOOD': 250, 
	'KOTAKBANK': 400, 
	'LALPATHLAB': 250, 
	'LICHSGFIN': 2000, 
	'LT': 575, 
	'LTI': 150, 
	'LTTS': 200, 
	'SUNTV': 1500, 
	'LUPIN': 850, 
	'M&M': 700, 
	'MANAPPURAM': 6000, 
	'WIPRO': 1600, 
	'MCDOWELL-N': 1250, 
	'MFSL': 650, 
	'MINDTREE': 400, 
	'MOTHERSUMI': 3500, 
	'MPHASIS': 325, 
	'MUTHOOTFIN': 750, 
	'NAM-INDIA': 1600, 
	'NATIONALUM': 17000, 
	'NAUKRI': 125, 
	'NESTLEIND': 50, 
	'ADANIENT': 1000, 
	'NMDC': 6700, 
	'NTPC': 5700, 
	'PAGEIND': 30, 
	'PETRONET': 3000, 
	'PFC': 6200, 
	'PFIZER': 125, 
	'PIDILITIND': 500, 
	'PIIND': 250, 
	'POWERGRID': 4000, 
	'PVR': 407, 
	'RAMCOCEM': 850, 
	'RECLTD': 6000, 
	'SBILIFE': 750, 
	'SHREECEM': 25, 
	'SRTRANSFIN': 400, 
	'SUNPHARMA': 1400, 
	'TATACHEM': 1000, 
	'TATACONSUM': 1350, 
	'TATAMOTORS': 2850, 
	'CUB': 3100, 
	'TATAPOWER': 6750, 
	'TATASTEEL': 850, 
	'ICICIPRULI': 1500, 
	'TECHM': 600, 
	'TITAN': 375, 
	'TORNTPHARM': 250, 
	'TORNTPOWER': 1500, 
	'TVSMOTOR': 1400, 
	'UBL': 700, 
	'MARICO': 2000, 
	'CIPLA': 650, 
	'UPL': 1300, 
	'VOLTAS': 500, 
	'ZEEL': 3000, 
	'ACC': 500, 
	'NAVINFLUOR': 225, 
	'SRF': 125, 
	'AMBUJACEM': 3000, 
	'BOSCHLTD': 50, 
	'INFY': 600, 
	'L&TFH': 8924, 
	'BANKBARODA': 11700, 
	'BATAINDIA': 550, 
	'BPCL': 1800, 
	'ONGC': 7700, 
	'COLPAL': 350, 
	'VEDL': 3100, 
	'CUMMINSIND': 600, 
	'DRREDDY': 125, 
	'HDFCLIFE': 1100, 
	'IGL': 1375, 
	'INDUSTOWER': 2800, 
	'IOC': 6500, 
	'MARUTI': 100, 
	'TRENT': 725, 
	'MGL': 600, 
	'MRF': 10, 
	'PEL': 275, 
	'RELIANCE': 250, 
	'SBIN': 1500, 
	'SIEMENS': 275, 
	'TCS': 300, 
	'ULTRACEMCO': 100, 
	'CANBK': 5400, 
	'HEROMOTOCO': 300, 
	'PNB': 16000, 
	'GMRINFRA': 22500, 
	'IDEA': 70000, 
	'INDUSINDBK': 900, 
	'RBLBANK': 2900
}
```

--------------------------------

### Python NSE Live Quotes Fetching

Source: https://unofficed.com/nse-python/documentation/basic

Provides Python code examples for fetching live stock quotes from the NSE. It shows how to use `nse_eq()` for equity quotes and `nse_fno()` for derivatives (FNO) quotes. The text also mentions alternative functions `quote_equity()` and `quote_derivative()` which perform the same tasks.

```python
print(nse_eq("JUSTDIAL"))
print(nse_fno("BANKNIFTY"))
```

--------------------------------

### Derivative History Function Usage Example

Source: https://unofficed.com/nse-python/documentation/nsepy

Demonstrates how to call the derivative_history function with specific parameters for fetching options data. It shows how to set variables for symbol, dates, instrument type, expiry, strike price, and option type.

```Python
symbol = "SBIN"
start_date = "15-05-2021"
end_date ="15-06-2021"
instrumentType = "options"
expiry_date ="24-Jun-2021"
strikePrice = 300
optionType="PE"

print(derivative_history(symbol,start_date,end_date,instrumentType,expiry_date,strikePrice,optionType))
```

--------------------------------

### NSE Option Chain LTP Usage Example

Source: https://unofficed.com/nse-python/documentation/custom

Demonstrates how to use the nse_optionchain_ltp function to fetch the bid price for a specific option contract. It first obtains the necessary payload using nse_optionchain_scrapper.

```python
payload=nse_optionchain_scrapper('BANKNIFTY')
print(nse_optionchain_ltp(payload,23000,"CE",0,"sell"))
```

--------------------------------

### NSEPython Get FNO List

Source: https://unofficed.com/nse-python/documentation/basic

Provides a simple function call to retrieve the list of securities available in the Futures and Options (F&O) segment using the NSEPython library.

```python
print(fnolist())
```

--------------------------------

### Get Stock Sector PE and Name using nse_eq

Source: https://unofficed.com/nse-python/documentation/basic

Retrieves sector-specific information, including PE ratio and sector name, for a stock. It accesses `pdSectorPe` and `pdSectorInd` from the `metadata` dictionary.

```python
print(nse_eq("JUSTDIAL")['metadata']['pdSectorPe'])
print(nse_eq("JUSTDIAL")['metadata']['pdSectorInd'])
```

--------------------------------

### Get Stock OHLC and High/Low using nse_eq

Source: https://unofficed.com/nse-python/documentation/basic

Retrieves Open, High, Low, and Close prices for a stock. It accesses these values from `priceInfo` and `intraDayHighLow` within the `nse_eq` function's output.

```python
print(nse_eq("JUSTDIAL")['priceInfo']['open'])
print(nse_eq("JUSTDIAL")['priceInfo']['intraDayHighLow']['min'])
print(nse_eq("JUSTDIAL")['priceInfo']['intraDayHighLow']['max'])
print(nse_eq("JUSTDIAL")['priceInfo']['close'])
```

--------------------------------

### Equity History Fetching

Source: https://unofficed.com/nse-python/documentation/nsepy

Fetches historical data for a specific equity symbol. Requires the symbol, series, start date, and end date as input. The output is typically a pandas DataFrame containing the historical price data.

```APIDOC
equity_history(symbol: str, series: str, start_date: str, end_date: str)

  Fetches historical equity data.

  Parameters:
    symbol (str): The stock symbol (e.g., "SBIN").
    series (str): The series of the stock (e.g., "EQ" for Equity).
    start_date (str): The start date for the history in DD-MM-YYYY format (e.g., "08-06-2021").
    end_date (str): The end date for the history in DD-MM-YYYY format (e.g., "14-06-2021").

  Returns:
    pandas.DataFrame: DataFrame containing historical equity data.

  Example Usage:
    symbol = "SBIN"
    series = "EQ"
    start_date = "08-06-2021"
    end_date ="14-06-2021"
    print(equity_history(symbol, series, start_date, end_date))
```

--------------------------------

### Download NSE Data with nsefetch()

Source: https://unofficed.com/nse-python/documentation/nsefetch

Demonstrates the basic usage of the `nsefetch` function to download JSON data from a specified NSE API endpoint. It shows how to call the function and print the raw JSON output.

```python
from nsepython import *
positions = nsefetch('https://www.nseindia.com/api/equity-stockIndices?index=SECURITIES%20IN%20F%26O')
print(positions)
```

--------------------------------

### NSEPython Basic Functions Overview

Source: https://unofficed.com/nse-python/documentation/index

Lists various basic functions available in the nsepython library for fetching specific types of financial data. These functions cover market data, options, and quotes.

```APIDOC
Logger Function
Getting the FNO List
Running Status
Getting Option Chain Data
OI Chain Builder Function
Getting live Quotes API
Stocks API
Derivatives API
Quote API
Quote API Delivery Details
Quote LTP API
Quote Meta API
Expiry List Function
```

--------------------------------

### Get Index PE, PB, Dividend Yield using Python

Source: https://unofficed.com/nse-python/documentation/nsepy

Fetches historical Price-to-Earnings (PE), Price-to-Book (PB) ratios, and dividend yield for a specified stock market index. Requires the index symbol, start date, and end date as input. Returns a pandas DataFrame with the data.

```Python
symbol = "NIFTY 50"
start_date = "01-Mar-2011"
end_date = "07-Jun-2021"
print(index_pe_pb_div(symbol,start_date,end_date))
```

--------------------------------

### Black Scholes Formula Implementation

Source: https://unofficed.com/nse-python/documentation/special

Provides an implementation of the Black-Scholes option pricing model in Python.

```APIDOC
API Group: Option Pricing

Function: The Black Scholes API

Description: Implements the Black-Scholes model to calculate the theoretical price of European-style options.

Parameters:
- S: Current price of the underlying asset
- K: Strike price of the option
- T: Time to expiration (in years)
- r: Risk-free interest rate (annualized)
- sigma: Volatility of the underlying asset (annualized)
- option_type: 'call' or 'put'

Returns:
- Theoretical price of the option.
```

--------------------------------

### Black Scholes Formula Implementation

Source: https://unofficed.com/nse-python/documentation/index

Provides an implementation of the Black-Scholes option pricing model in Python.

```APIDOC
API Group: Option Pricing

Function: The Black Scholes API

Description: Implements the Black-Scholes model to calculate the theoretical price of European-style options.

Parameters:
- S: Current price of the underlying asset
- K: Strike price of the option
- T: Time to expiration (in years)
- r: Risk-free interest rate (annualized)
- sigma: Volatility of the underlying asset (annualized)
- option_type: 'call' or 'put'

Returns:
- Theoretical price of the option.
```

--------------------------------

### Python Market Running Status Function

Source: https://unofficed.com/nse-python/documentation/basic

Defines a Python function `running_status` that determines the current market operating hours. It calculates the start and end times for the trading day (9:15 AM to 3:30 PM) and can be used to check if the market is currently open. The function returns the calculated start time.

```python
import datetime

def running_status():
    start_now=datetime.datetime.now().replace(hour=9, minute=15, second=0, microsecond=0)
    end_now=datetime.datetime.now().replace(hour=15, minute=30, second=0, microsecond=0)
    return start_now
```

--------------------------------

### Get NSE Index Column Names

Source: https://unofficed.com/nse-python/documentation/nsetools

Demonstrates how to retrieve the names of all available columns from the NSE index data, typically returned as a Pandas DataFrame.

```python
print(nse_index().columns.values)

# Expected Output:
# ['yearLow' 'last' 'indexName' 'yearHigh' 'previousClose' 'high'
#  'indexType' 'low' 'timeVal' 'percChange' 'indexOrder' 'open'
#  'indexSubType']
```

--------------------------------

### Get Derivative Underlying Value using nse_fno

Source: https://unofficed.com/nse-python/documentation/basic

Retrieves the underlying value for a derivative contract using the `nse_fno` function. It accesses the `underlyingValue` from the returned data.

```python
print(nse_fno("BANKNIFTY")['underlyingValue'])
```

--------------------------------

### Get NSE Index List

Source: https://unofficed.com/nse-python/documentation/nsetools

Fetches a comprehensive list of all available NSE index names. This function is useful for identifying valid index identifiers for other API calls.

```python
print(nse_get_index_list())

# Example Output:
# ['NIFTY 50', 'NIFTY NEXT 50', 'NIFTY IT', 'NIFTY BANK', 'INDIA VIX', ...]
```

--------------------------------

### NSE Python Library API Documentation

Source: https://unofficed.com/nse-python/documentation/nsefetch

Comprehensive API documentation for the unofficed-nse-python library, detailing various functions for accessing NSE data. This includes endpoints for basic market data, custom analytics, special reports, and historical data retrieval.

```APIDOC
NSE Python Library API Reference

This section details the various API endpoints and functions available within the unofficed-nse-python library.

## Basic Functions

- **Logger Function**: Provides logging capabilities for the library's operations.
- **Getting the FNO List**: Retrieves the list of Futures and Options (FNO) instruments.
- **Running Status**: Checks the operational status of the NSE data feeds.
- **Getting Option Chain Data**: Fetches real-time option chain data for specific instruments.
- **OI Chain Builder Function**: Builds and retrieves Open Interest (OI) chain data.
- **Getting Live Quotes API**: Provides live quote data for stocks and indices.
- **Stocks API**: Accesses general stock information and data.
- **Derivatives API**: Retrieves data related to derivatives instruments (Futures & Options).
- **Quote API**: General endpoint for fetching stock quotes.
- **Quote API Delivery Details**: Provides delivery-based trading details for stocks.
- **Quote LTP API**: Fetches the Last Traded Price (LTP) for instruments.
- **Quote Meta API**: Retrieves metadata for stock quotes.
- **Expiry List Function**: Lists available expiry dates for derivatives.

## Custom Functions

- **Illiquid Options Bid Ask**: Fetches bid-ask data for illiquid options.
- **INP Variable**: Provides access to the INP (Implied Net Position) variable.
- **PCR API**: Retrieves the Put-Call Ratio (PCR) data.
- **Expiry Details API**: Fetches detailed information about specific expiries.
- **SecFNO Scraper Function**: Scrapes data for Security FNO.
- **Black Scholes API**: Implements the Black-Scholes model for option pricing.
- **NSE Price Band Hitters**: Identifies stocks hitting their price bands.
- **NSE Large Deal API**: Retrieves information on large deals executed on NSE.
- **NSE Large Deal Historical API**: Fetches historical data for large deals.

## Special Functions

- **The Results API**: Provides access to company financial results.
- **The Holiday API**: Lists NSE trading holidays.
- **The Event Calendar API**: Provides a calendar of market events.
- **The Past Results API**: Retrieves historical financial results.
- **The Block Deals API**: Fetches details of block deals.
- **The Market Status API**: Provides current market operating status.
- **The NSE Circular API**: Accesses official NSE circulars.
- **The FII/DII API**: Retrieves Foreign Institutional Investor (FII) and Domestic Institutional Investor (DII) data.
- **The Beta API**: Calculates and provides the Beta value for stocks.
- **The NSE PreOpen API**: Fetches data from the NSE pre-open market session.
- **The NSE PreOpen Movers API**: Identifies movers during the NSE pre-open session.
- **The NSE Most Active API**: Lists the most active stocks.
- **The StockList API**: Retrieves a list of all available stocks.
- **NSE FNO Participant Wise OI**: Provides Participant-wise Open Interest data for FNO.

## NSETools Functions

- **Getting a Stock Quote**: Fetches quote data for a specific stock.
- **And the Index Quote**: Retrieves quote data for a specific index.
- **Advances Declines**: Provides data on advancing and declining stocks.
- **Top Losers & Gainers**: Lists the top performing and worst performing stocks.
- **Getting Lot Sizes**: Retrieves the lot sizes for derivatives contracts.

## NSEPy Functions

- **Equity History**: Fetches historical data for equity stocks.
- **Derivative History**: Retrieves historical data for derivatives.
- **Expiry History**: Fetches historical expiry data.
- **Index History**: Retrieves historical data for indices.
- **Index Historical PE, PB and Dividend Ratio**: Provides historical P/E, P/B, and Dividend Ratios for indices.
- **Total Index Returns**: Calculates and provides total returns for indices.
- **Daily Bhav Copy**: Fetches daily Bhav Copy data.
- **Getting Block Deals of NSE**: Retrieves block deal data from NSE.
- **Getting Bulk Deals of NSE**: Fetches bulk deal data from NSE.
```

--------------------------------

### NSE Python Library API Documentation

Source: https://unofficed.com/nse-python/documentation/basic

Comprehensive API documentation for the unofficed-nse-python library, detailing various functions for accessing NSE data. This includes endpoints for basic market data, custom analytics, special reports, and historical data retrieval.

```APIDOC
NSE Python Library API Reference

This section details the various API endpoints and functions available within the unofficed-nse-python library.

## Basic Functions

- **Logger Function**: Provides logging capabilities for the library's operations.
- **Getting the FNO List**: Retrieves the list of Futures and Options (FNO) instruments.
- **Running Status**: Checks the operational status of the NSE data feeds.
- **Getting Option Chain Data**: Fetches real-time option chain data for specific instruments.
- **OI Chain Builder Function**: Builds and retrieves Open Interest (OI) chain data.
- **Getting Live Quotes API**: Provides live quote data for stocks and indices.
- **Stocks API**: Accesses general stock information and data.
- **Derivatives API**: Retrieves data related to derivatives instruments (Futures & Options).
- **Quote API**: General endpoint for fetching stock quotes.
- **Quote API Delivery Details**: Provides delivery-based trading details for stocks.
- **Quote LTP API**: Fetches the Last Traded Price (LTP) for instruments.
- **Quote Meta API**: Retrieves metadata for stock quotes.
- **Expiry List Function**: Lists available expiry dates for derivatives.

## Custom Functions

- **Illiquid Options Bid Ask**: Fetches bid-ask data for illiquid options.
- **INP Variable**: Provides access to the INP (Implied Net Position) variable.
- **PCR API**: Retrieves the Put-Call Ratio (PCR) data.
- **Expiry Details API**: Fetches detailed information about specific expiries.
- **SecFNO Scraper Function**: Scrapes data for Security FNO.
- **Black Scholes API**: Implements the Black-Scholes model for option pricing.
- **NSE Price Band Hitters**: Identifies stocks hitting their price bands.
- **NSE Large Deal API**: Retrieves information on large deals executed on NSE.
- **NSE Large Deal Historical API**: Fetches historical data for large deals.

## Special Functions

- **The Results API**: Provides access to company financial results.
- **The Holiday API**: Lists NSE trading holidays.
- **The Event Calendar API**: Provides a calendar of market events.
- **The Past Results API**: Retrieves historical financial results.
- **The Block Deals API**: Fetches details of block deals.
- **The Market Status API**: Provides current market operating status.
- **The NSE Circular API**: Accesses official NSE circulars.
- **The FII/DII API**: Retrieves Foreign Institutional Investor (FII) and Domestic Institutional Investor (DII) data.
- **The Beta API**: Calculates and provides the Beta value for stocks.
- **The NSE PreOpen API**: Fetches data from the NSE pre-open market session.
- **The NSE PreOpen Movers API**: Identifies movers during the NSE pre-open session.
- **The NSE Most Active API**: Lists the most active stocks.
- **The StockList API**: Retrieves a list of all available stocks.
- **NSE FNO Participant Wise OI**: Provides Participant-wise Open Interest data for FNO.

## NSETools Functions

- **Getting a Stock Quote**: Fetches quote data for a specific stock.
- **And the Index Quote**: Retrieves quote data for a specific index.
- **Advances Declines**: Provides data on advancing and declining stocks.
- **Top Losers & Gainers**: Lists the top performing and worst performing stocks.
- **Getting Lot Sizes**: Retrieves the lot sizes for derivatives contracts.

## NSEPy Functions

- **Equity History**: Fetches historical data for equity stocks.
- **Derivative History**: Retrieves historical data for derivatives.
- **Expiry History**: Fetches historical expiry data.
- **Index History**: Retrieves historical data for indices.
- **Index Historical PE, PB and Dividend Ratio**: Provides historical P/E, P/B, and Dividend Ratios for indices.
- **Total Index Returns**: Calculates and provides total returns for indices.
- **Daily Bhav Copy**: Fetches daily Bhav Copy data.
- **Getting Block Deals of NSE**: Retrieves block deal data from NSE.
- **Getting Bulk Deals of NSE**: Fetches bulk deal data from NSE.
```

--------------------------------

### Get NSE Bulk Deals

Source: https://unofficed.com/nse-python/documentation/nsepy

Fetches bulk deals data from the NSE. This function retrieves a CSV file containing daily bulk deals and parses it into a Pandas DataFrame.

```python
print(get_bulkdeals())
```

--------------------------------

### Get NSE Equity Symbols

Source: https://unofficed.com/nse-python/documentation/special

Retrieves all equity symbols from NSE in a single list. As of 22-08-2023, it returns 1898 codes. This function serves as a helper for the StockList API feature request.

```python
nse_eq_symbols()
```

--------------------------------

### NSE PreOpen API

Source: https://unofficed.com/nse-python/documentation/special

Fetches pre-open market data for various NSE segments. Allows retrieval in raw JSON or Pandas DataFrame format.

```python
nse_preopen(key: str, type: str = "pandas")

Parameters:
  key: The market segment key. Options include "NIFTY", "BANKNIFTY", "SME", "FO", "OTHERS", "ALL". Defaults to "NIFTY".
  type: The output format. "raw" for JSON, "pandas" for DataFrame. Defaults to "pandas".

Example 1 (Raw JSON for FO segment):
  payload = nse_preopen("FO", "raw")
  print(payload)
  print(payload["advances"])
  print(payload["declines"])
  print(payload["unchanged"])

Example 2 (Pandas DataFrame for FO segment):
  payload = nse_preopen("FO", "pandas") # Returns a Pandas DataFrame
```

--------------------------------

### NSE Python Library API Documentation

Source: https://unofficed.com/nse-python/documentation/nsetools

Comprehensive API documentation for the unofficed-nse-python library, detailing various functions for accessing NSE data. This includes endpoints for basic market data, custom analytics, special reports, and historical data retrieval.

```APIDOC
NSE Python Library API Reference

This section details the various API endpoints and functions available within the unofficed-nse-python library.

## Basic Functions

- **Logger Function**: Provides logging capabilities for the library's operations.
- **Getting the FNO List**: Retrieves the list of Futures and Options (FNO) instruments.
- **Running Status**: Checks the operational status of the NSE data feeds.
- **Getting Option Chain Data**: Fetches real-time option chain data for specific instruments.
- **OI Chain Builder Function**: Builds and retrieves Open Interest (OI) chain data.
- **Getting Live Quotes API**: Provides live quote data for stocks and indices.
- **Stocks API**: Accesses general stock information and data.
- **Derivatives API**: Retrieves data related to derivatives instruments (Futures & Options).
- **Quote API**: General endpoint for fetching stock quotes.
- **Quote API Delivery Details**: Provides delivery-based trading details for stocks.
- **Quote LTP API**: Fetches the Last Traded Price (LTP) for instruments.
- **Quote Meta API**: Retrieves metadata for stock quotes.
- **Expiry List Function**: Lists available expiry dates for derivatives.

## Custom Functions

- **Illiquid Options Bid Ask**: Fetches bid-ask data for illiquid options.
- **INP Variable**: Provides access to the INP (Implied Net Position) variable.
- **PCR API**: Retrieves the Put-Call Ratio (PCR) data.
- **Expiry Details API**: Fetches detailed information about specific expiries.
- **SecFNO Scraper Function**: Scrapes data for Security FNO.
- **Black Scholes API**: Implements the Black-Scholes model for option pricing.
- **NSE Price Band Hitters**: Identifies stocks hitting their price bands.
- **NSE Large Deal API**: Retrieves information on large deals executed on NSE.
- **NSE Large Deal Historical API**: Fetches historical data for large deals.

## Special Functions

- **The Results API**: Provides access to company financial results.
- **The Holiday API**: Lists NSE trading holidays.
- **The Event Calendar API**: Provides a calendar of market events.
- **The Past Results API**: Retrieves historical financial results.
- **The Block Deals API**: Fetches details of block deals.
- **The Market Status API**: Provides current market operating status.
- **The NSE Circular API**: Accesses official NSE circulars.
- **The FII/DII API**: Retrieves Foreign Institutional Investor (FII) and Domestic Institutional Investor (DII) data.
- **The Beta API**: Calculates and provides the Beta value for stocks.
- **The NSE PreOpen API**: Fetches data from the NSE pre-open market session.
- **The NSE PreOpen Movers API**: Identifies movers during the NSE pre-open session.
- **The NSE Most Active API**: Lists the most active stocks.
- **The StockList API**: Retrieves a list of all available stocks.
- **NSE FNO Participant Wise OI**: Provides Participant-wise Open Interest data for FNO.

## NSETools Functions

- **Getting a Stock Quote**: Fetches quote data for a specific stock.
- **And the Index Quote**: Retrieves quote data for a specific index.
- **Advances Declines**: Provides data on advancing and declining stocks.
- **Top Losers & Gainers**: Lists the top performing and worst performing stocks.
- **Getting Lot Sizes**: Retrieves the lot sizes for derivatives contracts.

## NSEPy Functions

- **Equity History**: Fetches historical data for equity stocks.
- **Derivative History**: Retrieves historical data for derivatives.
- **Expiry History**: Fetches historical expiry data.
- **Index History**: Retrieves historical data for indices.
- **Index Historical PE, PB and Dividend Ratio**: Provides historical P/E, P/B, and Dividend Ratios for indices.
- **Total Index Returns**: Calculates and provides total returns for indices.
- **Daily Bhav Copy**: Fetches daily Bhav Copy data.
- **Getting Block Deals of NSE**: Retrieves block deal data from NSE.
- **Getting Bulk Deals of NSE**: Fetches bulk deal data from NSE.
```

--------------------------------

### NSETools Functions

Source: https://unofficed.com/nse-python/documentation/index

A collection of utility functions for common NSE data retrieval tasks, including stock quotes, index quotes, advances/declines, top gainers/losers, and lot size information.

```APIDOC
API Group: NSETools

Description: Utility functions for common NSE data retrieval and analysis.

Functions:
- Getting a Stock Quote: Retrieves real-time or historical quote data for a specific stock.
- Index Quote: Fetches quote data for a given NSE index.
- Advances Declines: Provides data on the number of advancing and declining stocks.
- Top Losers & Gainers: Lists the top performing and worst performing stocks.
- Getting Lot Sizes: Retrieves contract lot size information for derivatives.
```

--------------------------------

### Python OI Chain Builder Usage

Source: https://unofficed.com/nse-python/documentation/basic

Demonstrates the usage of the `oi_chain_builder` function to fetch Option Chain data for a given FNO symbol. It explains the parameters: `symbol`, optional `expiry` (defaults to 'latest'), and optional `oi_mode` ('full' or 'compact'). The function returns Option Chain data as a Pandas DataFrame, the Last Traded Price (LTP), and the data's updation time.

```python
oi_data,ltp,crontime=oi_chain_builder(symbol,expiry,oi_mode,mode)

# Example call:
oi_data, ltp, crontime = oi_chain_builder("RELIANCE","latest","full")
print(oi_data)
print(ltp)
print(crontime)
```

--------------------------------

### Get NSE Index Quote

Source: https://unofficed.com/nse-python/documentation/nsetools

Retrieves quote data for NSE indices such as CNX NIFTY and BANK NIFTY. This function is designed to provide market-wide index status. The output is returned as a Pandas DataFrame, suitable for further analysis.

```python
print(nse_index())
```

--------------------------------

### NSE Python Library API Documentation

Source: https://unofficed.com/nse-python/documentation/nsepy

Comprehensive API documentation for the unofficed-nse-python library, detailing various functions for accessing NSE data. This includes endpoints for basic market data, custom analytics, special reports, and historical data retrieval.

```APIDOC
NSE Python Library API Reference

This section details the various API endpoints and functions available within the unofficed-nse-python library.

## Basic Functions

- **Logger Function**: Provides logging capabilities for the library's operations.
- **Getting the FNO List**: Retrieves the list of Futures and Options (FNO) instruments.
- **Running Status**: Checks the operational status of the NSE data feeds.
- **Getting Option Chain Data**: Fetches real-time option chain data for specific instruments.
- **OI Chain Builder Function**: Builds and retrieves Open Interest (OI) chain data.
- **Getting Live Quotes API**: Provides live quote data for stocks and indices.
- **Stocks API**: Accesses general stock information and data.
- **Derivatives API**: Retrieves data related to derivatives instruments (Futures & Options).
- **Quote API**: General endpoint for fetching stock quotes.
- **Quote API Delivery Details**: Provides delivery-based trading details for stocks.
- **Quote LTP API**: Fetches the Last Traded Price (LTP) for instruments.
- **Quote Meta API**: Retrieves metadata for stock quotes.
- **Expiry List Function**: Lists available expiry dates for derivatives.

## Custom Functions

- **Illiquid Options Bid Ask**: Fetches bid-ask data for illiquid options.
- **INP Variable**: Provides access to the INP (Implied Net Position) variable.
- **PCR API**: Retrieves the Put-Call Ratio (PCR) data.
- **Expiry Details API**: Fetches detailed information about specific expiries.
- **SecFNO Scraper Function**: Scrapes data for Security FNO.
- **Black Scholes API**: Implements the Black-Scholes model for option pricing.
- **NSE Price Band Hitters**: Identifies stocks hitting their price bands.
- **NSE Large Deal API**: Retrieves information on large deals executed on NSE.
- **NSE Large Deal Historical API**: Fetches historical data for large deals.

## Special Functions

- **The Results API**: Provides access to company financial results.
- **The Holiday API**: Lists NSE trading holidays.
- **The Event Calendar API**: Provides a calendar of market events.
- **The Past Results API**: Retrieves historical financial results.
- **The Block Deals API**: Fetches details of block deals.
- **The Market Status API**: Provides current market operating status.
- **The NSE Circular API**: Accesses official NSE circulars.
- **The FII/DII API**: Retrieves Foreign Institutional Investor (FII) and Domestic Institutional Investor (DII) data.
- **The Beta API**: Calculates and provides the Beta value for stocks.
- **The NSE PreOpen API**: Fetches data from the NSE pre-open market session.
- **The NSE PreOpen Movers API**: Identifies movers during the NSE pre-open session.
- **The NSE Most Active API**: Lists the most active stocks.
- **The StockList API**: Retrieves a list of all available stocks.
- **NSE FNO Participant Wise OI**: Provides Participant-wise Open Interest data for FNO.

## NSETools Functions

- **Getting a Stock Quote**: Fetches quote data for a specific stock.
- **And the Index Quote**: Retrieves quote data for a specific index.
- **Advances Declines**: Provides data on advancing and declining stocks.
- **Top Losers & Gainers**: Lists the top performing and worst performing stocks.
- **Getting Lot Sizes**: Retrieves the lot sizes for derivatives contracts.

## NSEPy Functions

- **Equity History**: Fetches historical data for equity stocks.
- **Derivative History**: Retrieves historical data for derivatives.
- **Expiry History**: Fetches historical expiry data.
- **Index History**: Retrieves historical data for indices.
- **Index Historical PE, PB and Dividend Ratio**: Provides historical P/E, P/B, and Dividend Ratios for indices.
- **Total Index Returns**: Calculates and provides total returns for indices.
- **Daily Bhav Copy**: Fetches daily Bhav Copy data.
- **Getting Block Deals of NSE**: Retrieves block deal data from NSE.
- **Getting Bulk Deals of NSE**: Fetches bulk deal data from NSE.
```

--------------------------------

### Get Stock Last Price (LTP) using nse_eq

Source: https://unofficed.com/nse-python/documentation/basic

Retrieves the Last Traded Price (LTP) for a given stock symbol using the `nse_eq` function. It accesses the `lastPrice` from the `priceInfo` dictionary within the returned data.

```python
print(nse_eq("JUSTDIAL")['priceInfo']['lastPrice'])
```
Tokens:
Raw