quantlab.dataset.config.MassiveShortInterestConfig#

class quantlab.dataset.config.MassiveShortInterestConfig(*, zarr_file_path, start_date=None, end_date=None, symbols=None, kwargs=None, resample_freq=None, resample_how=None, name=None, raw_data_dir_path, market='us_equity', frequency='1d', vendor='massive', table='sep', permatickers=None, roster_universe=None, category_filter='default', massive_dir, ticker_map_path, release_lag_bars=8)[source]#

Bases: MassiveRestPanelConfig

Config of the Massive short interest panel on the permaticker axis (#355).

Massive’s short interest records (the REST raw tier under massive_dir) are placed on permatickers through the Ticker map at ticker_map_path, on SEP’s trading calendar. raw_data_dir_path is Sharadar’s raw tier: SEP’s dates are the calendar and SEP’s TICKERS rows the universe, whose fields work as for a price panel (the default is domestic common stock).

Examples

>>> cfg = MassiveShortInterestConfig(
...     zarr_file_path="/data/zarrs/massive_short_interest_1d.zarr",
...     raw_data_dir_path="/data/downloads/sharadar",
...     massive_dir="/data/downloads/massive",
...     ticker_map_path="/data/market/massive/massive_ticker_map/massive_ticker_map",
... )
>>> cfg.vendor, cfg.table, cfg.release_lag_bars
('massive', 'sep', 8)

release_lag_bars = 8#: Trading days after its settlement date a release becomes visible (FINRA publishes it about seven business days after settlement).