query_dividends

---

function backtide.storage.query_dividends(symbol=None, provider=None, limit=None)

Return stored dividend events as a dataframe.

Each row represents a single dividend payment. The DataFrame columns are: symbol, provider, ex_date, and amount.

Returns

pd.DataFrame | pl.DataFrame Matching dividend events from the database.

See Also

delete_symbols

Delete bars (and orphaned dividends) from the database.

download_bars

Download OHLCV data for the instruments described in a list of profiles.

query_bars

Return stored OHLCV bars as a dataframe.

Example

>>> from backtide.storage import query_dividends

>>> df = query_dividends()
>>> print(df.head())

  symbol provider    ex_date    amount
0   AAPL    yahoo  547738200  0.000536
1   AAPL    yahoo  555600600  0.000536
2   AAPL    yahoo  564157800  0.000714
3   AAPL    yahoo  571674600  0.000714
4   AAPL    yahoo  579792600  0.000714