Market Client

nepse.MarketClient

class nepse.market.core.MarketClient(client_wrapper: nepse.utils._ClientWrapperHTTPX)

Bases: object

async market_is_open() bool

Checks if the market is open

Returns

Returns True if market is open and vice-versa

Return type

bool

async check_IPO(scrip: str, BOID: int) bool

Checks if the given user got the IPO

Parameters
  • scrip (str) – The Scrip of the company

  • boid (int) – The user’s BOID

Returns

Returns if the user got alloted in the IPO

Return type

bool

async get_market_caps() List[nepse.market.types.MarketCap]

Returns the market caps which are sorted by date

Returns

Market Caps sorted by date

Return type

List[MarketCap]

async get_floorsheets(sleep_time: Optional[int] = 0.4) List[nepse.market.types.FloorSheet]

Returns the floorsheet data for the current date

Note

Using this method may take upto 200 seconds, and may take upto 350 MB of memory. Use get_floorsheets_raw rather than this if you are planning to dumb the data.

Parameters

sleep_time (int) – The sleep time after each request so that we don’t get rate limited. Increase this if you are getting ServerDisconnected

Returns

List of floorsheet data in form of FloorSheet

Return type

List[FloorSheet]

async get_floorsheets_raw(sleep_time: Optional[int] = 0.4) List[dict]

Returns raw floorsheet data which is faster than nepse.MarketClient.get_floorsheets

Note

Using this method may take upto 170 seconds, and may take upto 300 MB of memory. So only use it when necessary.

Parameters

sleep_time (int) – The sleep time after each request so that we don’t get rate limited. Increase this if you are getting ServerDisconnected

Returns

List of raw floorsheet objects

Return type

List[dict]

async get_sectorwise_summary(business_date: Optional[datetime.date] = None) List[nepse.market.types.SectorwiseSummary]

Get the sectorwise summary

Parameters

business_date (Optional[datetime.date]) – The date for which to fetch the data

Returns

The list containing data related to sector wise summary

Return type

List[SectorwiseSummary]

async get_market_summaries() List[nepse.market.types.MarketSummary]

Get the market summaries

Returns

The list of Objects containing related to Market Summary

Return type

List[MarketSummary]

async get_market_summary(date: Optional[datetime.date] = None) nepse.market.types.MarketSummary

Get the market summary for a specific date

Parameters

date (Optional[datetime.date]) – Date to filter the market summary. Defaults to today

Returns

[description]

Return type

MarketSummary

nepse.MarketClient.types

class nepse.market.types.MarketCap(business_date: datetime.date, mar_cap: float, sen_mar_cap: float, float_mar_cap: float, sen_float_mar_cap: float)

Bases: object

business_date: datetime.date
mar_cap: float
sen_mar_cap: float
float_mar_cap: float
sen_float_mar_cap: float
class nepse.market.types.FloorSheet(id: int, contract_id: int, contract_type: Any, stock_symbol: str, buyer_member_id: str, seller_member_id: str, contract_quantity: int, contract_rate: int, contract_amount: int, business_date: datetime.date, trade_book_id: int, stock_id: int, buyer_broker_name: str, seller_broker_name: str, trade_time: datetime.datetime, security_name: str)

Bases: object

id: int
contract_id: int
contract_type: Any
stock_symbol: str
buyer_member_id: str
seller_member_id: str
contract_quantity: int
contract_rate: int
contract_amount: int
business_date: datetime.date
trade_book_id: int
stock_id: int
buyer_broker_name: str
seller_broker_name: str
trade_time: datetime.datetime
security_name: str
class nepse.market.types.SectorwiseSummary(business_date: datetime.date, sector_name: str, turn_over_values: int, turn_over_volume: int, total_transaction: int)

Bases: object

business_date: datetime.date
sector_name: str
turn_over_values: int
turn_over_volume: int
total_transaction: int
class nepse.market.types.MarketSummary(business_date: datetime.date, total_turnover: float, total_traded_shares: int, total_transactions: int, traded_scrips: int)

Bases: object

business_date: datetime.date
total_turnover: float
total_traded_shares: int
total_transactions: int
traded_scrips: int