Skip to content

Commit edee2bb

Browse files
authored
Update README.md
1 parent 0a8a55f commit edee2bb

File tree

1 file changed

+41
-30
lines changed

1 file changed

+41
-30
lines changed

README.md

Lines changed: 41 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,18 @@
22

33
### [Downloads](https://github.com/VarunS2002/Python-NSE-Option-Chain-Analyzer/releases)
44
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
5+
[![Python: 3.6+](https://img.shields.io/badge/Python-3.6%2B-blue)](https://www.python.org/downloads)
6+
![Build: passing](https://img.shields.io/badge/build-passing-brightgreen)
57

6-
This program web scrapes and then generates useful analysis of the Option Chain for the specified security from the NSE website.
8+
For doing technical analysis for option traders, the Option Chain is the most important tool for deciding entry and exit strategies.
9+
The National Stock Exchange (NSE) has a website which displays the option chain for traders in near real-time. This program scrapes this data from the NSE site and then generates useful analysis of the Option Chain for the specified Security or Index from the NSE website.
710
It also continuously refreshes the Option Chain and visually displays the trend in various indicators and useful for Technical Analysis.
811

9-
## Usage:
10-
11-
-Select your Index and Expiry Date and enter your preferred Strike Price
12-
13-
-You can select all table data using Ctrl+A or select individual cells, rows and columns
14-
15-
-Then you can copy it using Ctrl+C or right click menu
12+
## Installation:
1613

17-
-You can then paste it in any spreadsheet application (Tested with MS Excel and Google Sheets)
18-
19-
-You can also export all data to a .csv file from the menu
14+
-Python 3.6+ from https://www.python.org/downloads/ (recommended)
2015

21-
## Note:
16+
-Add Python to PATH during installation in Windows (recommended)
2217

2318
-Required modules:
2419

@@ -35,26 +30,42 @@ json
3530

3631
-Install missing modules using `pip install module_name`
3732

38-
-In case of network or connection errors the program doesn't crash and will keep retrying infinitely
33+
## Usage:
34+
35+
-Select your Index or Security option and it's Expiry Date
36+
37+
-Enter your preferred Strike Price
38+
39+
## Note:
40+
41+
-If there is an error in fetching dates then try refreshing
42+
43+
-In case of network or connection errors the program doesn't crash and will keep retrying until manually stopped
3944

4045
-If a ZeroDivisionError occurs or some data doesn't exist the value of the variable will be defaulted to 0
4146

4247
-All data is retrieved from `https://www.nseindia.com/api/option-chain-indices?symbol=*index_name*`
4348

4449
## Features:
4550

46-
-The program infinitely refreshes every minute
51+
-The program continuously retrieves and refreshes the option chain every minute giving near real-time analysis to the traders
4752

48-
-Supported Indexes : NIFTY, BANKNIFTY and NIFTYIT
53+
-New data row is added only if the NSE server updates its time or data (To prevent printing duplicate data)
4954

50-
-New data is displayed only if the server time has increased (To prevent printing duplicate data)
55+
-Supported Indexes : NIFTY, BANKNIFTY and NIFTYIT
5156

5257
-Red and Green colour indication for data based on trends
5358

5459
-Program title format: NSE-Option-Chain-Analyzer - {index} - {expiry_date} - {strike_price}
5560

5661
-Stop and Start functionality
5762

63+
-You can select all table data using Ctrl+A or select individual cells, rows and columns
64+
65+
-Then you can copy it using Ctrl+C or right click menu
66+
67+
-You can then paste it in any spreadsheet application (Tested with MS Excel and Google Sheets)
68+
5869
-Export to .csv file option
5970

6071
-About window with version and links for developer GitHub profile, README, license, releases and sources
@@ -67,28 +78,28 @@ json
6778

6879
Data | How it's calculated
6980
--- | ---
70-
Server Time | *Web Scraped*
71-
Underlying Index Points | *Web Scraped*
72-
Call Sum | Sum of the Change in Call Open Interests of the given Strike Price and the next two Strike Prices (in lacs)
73-
Put Sum | Sum of the Change in Put Open Interests of the given Strike Price and the next two Strike Prices (in lacs)
74-
Difference | Difference between the Call Sum and Put Sum
75-
Call Boundary | Change in Call Open Interest for 2 Strike Prices above the given Strike Price. This is used to determine if Call writers are exiting their positions.
76-
Put Boundary | Change in Put Open Interest for the given Strike Price. This is used to determine if Put writers are exiting their positions.
77-
Call In The Money(ITM) | This indicates that bullish trend could continue and Value could cross 4 Strike Prices above given Strike Price. It's the ratio of Put writing and Call writing at the 4th Strike Price above the given Strike price.
78-
Put In The Money(ITM) | This indicates that bearish trend could continue and Value could cross 2 Strike Prices below given Strike Price. It's the ratio of Call writing and Put writing at the 2nd Strike Price below the given Strike price.
81+
Server Time | *Web Scraped*. Indicates last data update time by NSE server
82+
Underlying Instrument Value | *Web Scraped*. Indicates the value of the underlying Security or Index
83+
Call Sum | Calculated. Sum of the Changes in Call Open Interest contracts of the given Strike Price and the next immediate two Strike Prices (In Thousands)
84+
Put Sum | Calculated. Sum of the Change in Put Open Interest contracts of the given Strike Price and the next two Strike Prices (In Thousands)
85+
Difference | Calculated. Difference between the Call Sum and Put Sum. If its very -ve its bullish, if its very +ve then its bearish else its a sideways session.
86+
Call Boundary | Change in Call Open Interest contracts for 2 Strike Prices above the given Strike Price. This is used to determine if Call writers are taking new positions (Bearish) or exiting their positions (Bullish). (In Thousands)
87+
Put Boundary | Change in Put Open Interest for the given Strike Price. This is used to determine if Put writers are taking new positions (Bullish) or exiting their positions(Bearish). (In Thousands)
88+
Call In The Money(ITM) | This indicates that bullish trend could continue and Value could cross 4 Strike Prices above given Strike Price. It's calculated as the ratio of Put writing and Call writing at the 4th Strike Price above the given Strike price. If the absolute ratio > 1.5 then its bullish sign.
89+
Put In The Money(ITM) | This indicates that bearish trend could continue and Value could cross 2 Strike Prices below given Strike Price. It's calculated as the ratio of Call writing and Put writing at the 2nd Strike Price below the given Strike price. If the absolute ratio > 1.5 then its bearish sign.
7990

8091
-Label Data displayed:
8192

8293
Data | How it's calculated
8394
--- | ---
84-
Max Call Open Interest and Strike Price | Highest Call Open Interest (in lacs) and it's corresponding Strike Price
85-
Max Put Open Interest and Strike Price | Highest Put Open Interest (in lacs) and it's corresponding Strike Price
86-
Put Call Ratio(PCR) | Total Put Open Interest divided by Total Call Open Interest
95+
Max Call Open Interest and Strike Price | Highest Call Open Interest contracts (in thousands) and it's corresponding Strike Price
96+
Max Put Open Interest and Strike Price | Highest Put Open Interest contracts (in thousands) and it's corresponding Strike Price
97+
Put Call Ratio(PCR) | Sum Total of Put Open Interest contracts divided by Sum Total of Call Open Interest contracts
8798
Open Interest | This indicates if the latest OI data record indicates Bearish or Bullish signs near Indicated Strike Price. If the Call Sum is more than the Put Sum then the OI is considered Bearish as there is more Call writing than Puts. If the Put Sum is more than the Call sum then the OI Is considered Bullish as the Put writing exceeds the Call writing.
8899
Call Exits | This indicates if the Call writers are exiting near given Strike Price in the latest OI data record. If the Call sum is < 0 or if the change in Call OI at the Call boundary (2 Strike Prices above the given Strike Price) is < 0, then Call writers are exiting their positions and the Bulls have a clear path.
89100
Put Exits | This indicates if the Put writers are exiting near given Strike Price in the latest OI data record. If the Put sum is < 0 or if the change in Put OI at the Put boundary (the given Strike Price) is < 0, then Put writers are exiting their positions and the Bears have a clear path.
90-
Call In The Money(ITM) | This indicates if the Call writers are also exiting far OTM strike prices (4 Strike Prices above the given Strike Price) showing extreme bullishness. Conditions are if the Call writers are exiting their far OTM positions and the Put writers are writing at the same Strike Price. This signal also changes to Yes if the change in Call OI at the far OTM is < 0.
91-
Put In The Money(ITM) | This indicates if the Put writers are also exiting far OTM strike prices (2 Strike Prices below the given Strike Price) showing extreme bearishness. Conditions are if the Put writers are exiting their far OTM positions and the Call writers are writing at the same Strike Price. This signal also changes to Yes if the change in Put OI at the far OTM is < 0.
101+
Call In The Money(ITM) | This indicates if the Call writers are also exiting far OTM strike prices (4 Strike Prices above the given Strike Price) showing extreme bullishness. Conditions are if the Call writers are exiting their far OTM positions and the Put writers are writing at the same Strike Price & if the absolute ratio > 1.5 then its bullish sign. This signal also changes to Yes if the change in Call OI at the far OTM is < 0.
102+
Put In The Money(ITM) | This indicates if the Put writers are also exiting far OTM strike prices (2 Strike Prices below the given Strike Price) showing extreme bearishness. Conditions are if the Put writers are exiting their far OTM positions and the Call writers are writing at the same Strike Price & if the absolute ratio > 1.5 then its a bearish sign. . This signal also changes to Yes if the change in Put OI at the far OTM is < 0.
92103

93104

94105
## Screenshots:

0 commit comments

Comments
 (0)