sf_quant.data.get_assets_columns

sf_quant.data.get_assets_columns() → str

Return the available columns in the assets dataset.

This function provides a schema of all asset-level fields that can be retrieved with load_assets(). The output is a table listing each column name along with its corresponding data type.

Returns

str

A string representation of a polars data frame containing the column names and types for the assets table.

Examples

>>> import sf_quant.data as sfd
>>> sfd.get_assets_columns()
shape: (30, 2)
┌──────────────────────┬─────────┐
│ column               ┆ dtype   │
│ ---                  ┆ ---     │
│ str                  ┆ str     │
╞══════════════════════╪═════════╡
│ date                 ┆ Date    │
│ rootid               ┆ String  │
│ barrid               ┆ String  │
│ issuerid             ┆ String  │
│ instrument           ┆ String  │
│ ...                  ┆ ...     │
└──────────────────────┴─────────┘