khushalps
a1c1853ca5
git-subtree-dir: utils_v2 git-subtree-split: 88e444ac57ca6c090736645616d8a8a2d2af367b
242 lines
9.3 KiB
Python
242 lines
9.3 KiB
Python
"""
|
|
|
|
AUTHOR:
|
|
|
|
Khushal P Soonderji
|
|
|
|
DATE:
|
|
|
|
Thu, 5th May, 2025
|
|
|
|
OBJECTIVE:
|
|
|
|
To provide a way to retrieve additional details of any kind of IPO.
|
|
|
|
NOTE: This method involves web scraping. It is good for proof-of-concept development, but it is recommended that
|
|
more professional data-sources be used when the product starts becoming mature.
|
|
|
|
REFERENCES:
|
|
|
|
N/A
|
|
|
|
DOWNLOADS:
|
|
|
|
N/A
|
|
|
|
"""
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** IMPORT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# To make sibling directories accessible for imports:
|
|
import sys
|
|
sys.path.append(".")
|
|
sys.path.append("..")
|
|
|
|
# System-level activities:
|
|
import io
|
|
|
|
# My utils:
|
|
from utils_v2.string import json
|
|
from utils_v2.date_time import date_time
|
|
|
|
# NSE-related utils:
|
|
from utils_v2.nse.controllers.base import AsyncNSEBase
|
|
from utils_v2.nse.models.api_call import NSEApiResponse
|
|
|
|
# Data models:
|
|
from utils_v2.nse.models.ipo import NSEIPOIssueData
|
|
|
|
# To make REST-ful API calls:
|
|
import httpx
|
|
|
|
# To work with date and time:
|
|
import datetime
|
|
|
|
# To work with datatypes:
|
|
from typing import Any, List
|
|
|
|
# For asynchronous activities:
|
|
import asyncio
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MACROS / ONE-TIME INIT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** VARIABLES ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** FUNCTIONS ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
class NSEIPOIssueInformation(AsyncNSEBase):
|
|
|
|
def __init__(
|
|
self,
|
|
http_client: httpx.AsyncClient = None,
|
|
cookies_refresh_interval: int | float = 300,
|
|
debug = True,
|
|
debug_prefix = "NSE (IPO Issue Info.) | ",
|
|
debug_only_errors = True
|
|
):
|
|
|
|
# Pass on the initialization to the parent:
|
|
super().__init__(
|
|
base_url = r"https://www.nseindia.com/market-data/issue-information",
|
|
data_url = r"https://www.nseindia.com/api/ipo-detail",
|
|
http_client = http_client,
|
|
cookies_refresh_interval = cookies_refresh_interval,
|
|
debug = debug,
|
|
debug_prefix = debug_prefix,
|
|
debug_only_errors = debug_only_errors
|
|
)
|
|
|
|
async def get_data(
|
|
self,
|
|
symbol: str,
|
|
kind: str,
|
|
return_raw: bool = False,
|
|
refresh_cookies: bool = True,
|
|
force_refresh_cookies: bool = False,
|
|
retry_count: int = 1,
|
|
backoff_seconds: int | float = 0.5,
|
|
backoff_multiplier: float = 1.1,
|
|
**kwargs
|
|
) -> NSEApiResponse:
|
|
|
|
"""
|
|
To get the issue information of an IPO.
|
|
:param symbol: The listing symbol of the stock.
|
|
:param kind: The series code of the stock. Something like "EQ", "SME", etc.
|
|
:param return_raw: Whether you want the raw JSON from NSE or you want it formatted.
|
|
:param refresh_cookies: Whether, or not, you would like to refresh the cookies.
|
|
:param force_refresh_cookies: If set to True, cookies will be refreshed even if not timed out. If set to False,
|
|
cookies will be refreshed only when the interval passed to the constructor has elapsed since the last
|
|
successful refresh.
|
|
:param retry_count: The no. of times to try to get the data from the API.
|
|
:param backoff_seconds: The delay between unsuccessful API calls.
|
|
:param backoff_multiplier: The multiplier to add to the delay to change delay.
|
|
:return: The raw or formatted event calendar data in the 'data' field of the response model.
|
|
"""
|
|
|
|
# Make the API call:
|
|
api_response = await self.get(
|
|
url = f"https://www.nseindia.com/api/ipo-detail?symbol={symbol}&series={kind}",
|
|
# params = {"symbol": symbol, "series": kind},
|
|
refresh_cookies = refresh_cookies,
|
|
force_refresh_cookies = force_refresh_cookies,
|
|
retry_count = retry_count,
|
|
backoff_seconds = backoff_seconds,
|
|
backoff_multiplier = backoff_multiplier
|
|
)
|
|
|
|
# If the API call was successful:
|
|
if api_response.httpCode in [200]:
|
|
raw_json = await api_response.get_json()
|
|
raw_json = raw_json.get("issueInfo", {}).get("dataList", [])
|
|
api_response.success = True
|
|
if return_raw: api_response.data = raw_json
|
|
else:
|
|
try: api_response.data = self.format_data(
|
|
raw_json = raw_json,
|
|
timestamp = date_time.get_current_utc_date_time(as_string = False),
|
|
raise_exception = True
|
|
)
|
|
except Exception as exception:
|
|
api_response.exception = exception
|
|
api_response.success = False
|
|
|
|
# Done here:
|
|
return api_response
|
|
|
|
def format_data(
|
|
self,
|
|
raw_json: List[dict],
|
|
timestamp: datetime.datetime = None,
|
|
raise_exception: bool = False
|
|
) -> List[NSEIPOIssueData] | None:
|
|
|
|
"""
|
|
We format the data here to be able to retrieve it properly later.
|
|
:param raw_json: The raw data as scraped from NSE.
|
|
:param timestamp: The timestamp at which the data was scraped. This shall be useful for data retrieval from the
|
|
database, later.
|
|
:param raise_exception: If set to True, any exception will be propagated. If set to False, any exception will be
|
|
suppressed internally.
|
|
:return: The formatted data if successful, else None.
|
|
"""
|
|
|
|
# Can't do anything if the chain itself is null:
|
|
if raw_json is None: return raw_json
|
|
|
|
# Start by assuming failure:
|
|
formatted_data = None
|
|
|
|
# Ensure that we've got a proper timestamp:
|
|
if timestamp is None: timestamp = date_time.get_current_utc_date_time(as_string = False)
|
|
|
|
try:
|
|
|
|
# Format the data:
|
|
formatted_data = [NSEIPOIssueData(**detail) for detail in raw_json]
|
|
|
|
# If something goes wrong:
|
|
except Exception as exception:
|
|
formatted_data = None
|
|
if raise_exception: raise
|
|
|
|
# Done here:
|
|
return formatted_data
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MAIN PROGRAM ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
async def main():
|
|
|
|
# Create an instance of the scraper:
|
|
my_nse = NSEIPOIssueInformation(debug_only_errors = False)
|
|
|
|
# Get and show the data:
|
|
api_response = await my_nse.get_data(
|
|
symbol = "ATHERENERG",
|
|
kind = "EQ",
|
|
return_raw = False,
|
|
retry_count = 3,
|
|
refresh_cookies = True
|
|
)
|
|
print("SUMMARY:", api_response.to_markdown(), "\n---\n\n")
|
|
if api_response.success: print("IPO ISSUE INFO:", json.to_string(api_response.data, default = str))
|
|
print("COOKIES:", my_nse.cookies)
|
|
|
|
asyncio.run(main())
|