A Python package to fetch and process live derivative prices and quotes from Sensibull's API
Project description
SensibullQuotes
SensibullQuotes is a Python package that provides an interface to fetch and process live derivative prices and quotes from Sensibull's API.
Features
- Fetch derivatives data including instrument tokens and trading symbols
- Get live derivative prices for a given instrument token
- Get quotes for one or multiple trading symbols
- Process and clean up the live derivative data for easy consumption
Installation
You can install SensibullQuotes using pip: pip install sensibull-quotes Copy
Usage
Here's a basic example of how to use SensibullQuotes:
from sensibull_quotes import SensibullQuotes
# Create an instance of SensibullQuotes
quotes = SensibullQuotes()
# Fetch derivatives data (this is done automatically when needed, but you can do it explicitly)
quotes.fetch_derivatives_data()
# Get a trading symbol for an instrument token
symbol = quotes.get_tradingsymbol(9073154)
print(f"Trading Symbol: {symbol}")
# Get quotes for a single trading symbol
single_quote = quotes.get_quotes('NIFTY')
print(f"NIFTY Quote: {single_quote}")
# Get quotes for multiple trading symbols
multiple_quotes = quotes.get_quotes(['NIFTY', 'BANKNIFTY', 'FINNIFTY'])
for symbol, quote in multiple_quotes.items():
print(f"{symbol} Quote: {quote}")
# Get live derivative prices for an instrument token
live_data = quotes.get_live_derivative_prices(260105)
if live_data:
print(f"Underlying Price: {live_data['underlying_price']}")
print(f"Last Updated: {live_data['last_updated_at']}")
for expiry in live_data['expiries']:
print(f"\nExpiry: {expiry['expiry']}")
print(f"ATM Strike: {expiry['atm_strike']}")
print(f"ATM IV: {expiry['atm_iv']}")
print(f"Future Price: {expiry['future_price']}")
print(f"Max OI: {expiry['max_oi']}")
print("Options:")
for option in expiry['options']:
print(f" Token: {option['token']}, Trading Symbol: {option['tradingsymbol']}, Last Price: {option['last_price']}, OI: {option['oi']}, IV: {option['iv']}")
else:
print("Failed to fetch live derivative prices")
API Reference
SensibullQuotes
The main class that provides access to Sensibull's API.
Methods:
fetch_derivatives_data(max_retries=3): Fetches the derivatives data from Sensibull's API.
get_tradingsymbol(instrument_token): Returns the trading symbol for a given instrument token.
get_live_derivative_prices(instrument_token): Fetches and processes live derivative prices for a given instrument token.
get_quotes(trading_symbols): Fetches quotes for one or more trading symbols.
trading_symbols: A string (for a single symbol) or a list of strings (for multiple symbols)
Returns a dictionary where keys are trading symbols and values are quote information
Quote Information
The get_quotes method returns a dictionary with the following information for each quote:
last_price: The last traded price
instrument_token: The unique identifier for the instrument
underlying_instrument: The underlying instrument (e.g., NIFTY for NIFTY options)
tradingsymbol: The trading symbol
segment: The market segment (e.g., NSE, NFO)
exchange: The exchange (e.g., NSE)
instrument_type: The type of instrument (e.g., EQ for equity, CE for call option)
last_updated_at: The timestamp of the last update
strike: The strike price (for options)
expiry: The expiry date (for derivatives)
oi: Open Interest
volume: Trading volume
Note that some fields may be None if not applicable or not available for a particular instrument.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License.
Disclaimer
This package is not officially associated with or endorsed by Sensibull. Use at your own risk.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sensibull_quotes-0.1.0.tar.gz.
File metadata
- Download URL: sensibull_quotes-0.1.0.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
baa84e1606dfc8aa2f3e965810c2968da88e3eb3452be7bccff01a1c5e8b1ea6
|
|
| MD5 |
bf2eef5748746515a54b4369e36967f1
|
|
| BLAKE2b-256 |
e06eb9ed3c357016fc0814616bba34dc4ef07af1fdb6e7d5a9d9829d1784c6cd
|
File details
Details for the file sensibull_quotes-0.1.0-py3-none-any.whl.
File metadata
- Download URL: sensibull_quotes-0.1.0-py3-none-any.whl
- Upload date:
- Size: 5.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a7887a03f36f9c88acab05886e17ffaab8d3a73b9e6132be7a32b7979a1b73eb
|
|
| MD5 |
e03d716b38f1b9c7828f29c9a5f38ed0
|
|
| BLAKE2b-256 |
af5983ef11c523e996d91267255637df22840d0d63782a5f5eb94610d0f06816
|