bayesline.api.equity.UniverseApi.get

abstract UniverseApi.get(*, start: str | date | datetime | None = None, end: str | date | datetime | None = None, id_type: Literal['bayesid', 'ticker', 'composite_figi', 'cik', 'cusip8', 'cusip9', 'isin', 'sedol6', 'sedol7', 'proxy', 'name'] | None = None, filter_tradedays: bool = False) → DataFrame

Parameters

start: DateLike, optional

The start date of the universe to return, inclusive.

end: DateLike, optional

The end date of the data to return, inclusive.

id_type: IdType, optional

The id type to return asset ids in, e.g. ticker. The given id type must be supported, i.e. in id_types.

filter_tradedays: bool, default=False

If True, filter down the data to trade dates only.

Raises

ValueError

If the given id type is not supported or date range is invalid.

Returns

pl.DataFrame

The data for the given date range.