quantlab.dataset.sharadar.tables.permaticker_mapping#

quantlab.dataset.sharadar.tables.permaticker_mapping(vendor_root, code)[source]#

Return the (ticker, permaticker) pairs TICKERS gives one table’s rows.

Only the TICKERS rows labelled with the table (SEP or stocks for sep) count: the same ticker under another table can be another security.

Parameters:
vendor_rootstr or Path

<download-dir>/sharadar.

codestr

The code of the table whose tickers are mapped.

Returns:
pl.DataFrame

Distinct ticker/permaticker pairs.

Examples

>>> permaticker_mapping("/data/downloads/sharadar", "sep").columns
['ticker', 'permaticker']