quantpylib.datapoller.equities

Equities

Bases: BasePoller

get_ticker_dividends(ticker, **kwargs)

Retrieve ticker dividends. @poller

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

get_ticker_earnings_history(ticker, **kwargs)

Retrieve ticker earnings history. @poller

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

get_ticker_earnings_trend(ticker, **kwargs)

Retrieve ticker earnings trend. @poller

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

get_ticker_financials(ticker, **kwargs)

Retrieve ticker financials. @poller

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

get_ticker_fundamentals(ticker, **kwargs)

Retrieve ticker fundamentals. @poller

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

Examples:

>>> f1=datapoller.equities.get_ticker_fundamentals(ticker="GS",src="eodhd")

get_ticker_historical_mcap(ticker, **kwargs)

Retrieve ticker historical market cap. @ts_poller(assert_span=False, automap_span=False)

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

get_ticker_insider_txn(ticker, **kwargs)

Retrieve ticker insider transactions. @poller

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

get_ticker_metadata(ticker, **kwargs)

Retrieve ticker metadata. @poller

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

get_ticker_shares_stats(ticker, **kwargs)

Retrieve ticker shares statistics. @poller

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

get_ticker_splits(ticker, **kwargs)

Retrieve ticker splits. @poller

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

get_ticker_stat_snapshot(ticker, **kwargs)

Retrieve ticker statistical snapshot. @poller

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

get_trade_bars(**kwargs) async

Retrieve OHLC(V) trade bars data. @ts_poller

Parameters:

Name	Type	Description	Default
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

Examples:

>>> df = datapoller.equities.get_trade_bars(ticker="AAPL",start=datetime(2020,1,1),periods=365,src="yfinance")

get_trade_ticks(start, end, **kwargs)

Retrieve ticker ticks data. @ts_poller(automap_span=False)

Parameters:

Name	Type	Description	Default
start	datetime	Start datetime.	required
end	datetime	End datetime.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

Examples:

>>> ticks=datapoller.equities.get_trade_ticks(ticker="META",start=datetime(2023,4,3,0,0,0), end=datetime(2023,4,3,12,0,0))

l1_book_subscribe(ticker, handler, **kwargs) async

Stream L2 order book data. @poller(tag="stream")

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
handler	coroutine	A coroutine handler for the message received.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

l1_book_unsubscribe(ticker, **kwargs) async

Terminate stream for ticker data. @poller(tag="stream")

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

l2_book_subscribe(ticker, handler, **kwargs) async

Stream L2 order book data. @poller(tag="stream")

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
handler	coroutine	A coroutine handler for the message received.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}

l2_book_unsubscribe(ticker, **kwargs) async

Terminate stream for ticker data. @poller(tag="stream")

Parameters:

Name	Type	Description	Default
ticker	str	Ticker symbol.	required
**kwargs		Data-source specific keyword arguments for endpoint specification.	{}