Source code for py_alpaca_api.models.asset_model

from dataclasses import dataclass

from py_alpaca_api.models.model_utils import KEY_PROCESSORS, extract_class_data


@dataclass

[docs]
class AssetModel:

[docs]
    id: str


[docs]
    asset_class: str


[docs]
    easy_to_borrow: bool


[docs]
    exchange: str


[docs]
    fractionable: bool


[docs]
    maintenance_margin_requirement: float


[docs]
    marginable: bool


[docs]
    name: str


[docs]
    shortable: bool


[docs]
    status: str


[docs]
    symbol: str


[docs]
    tradable: bool




############################################
# Data Class Asset Conversion Functions
############################################

[docs]
def asset_class_from_dict(data_dict: dict) -> AssetModel:
    """Create AssetModel from dictionary data.

    Args:
        data_dict: A dictionary containing the data for creating an instance of
            AssetModel.

    Returns:
        An instance of the AssetModel class.

    Raises:
        None
    """
    asset_data = extract_class_data(data_dict, KEY_PROCESSORS, AssetModel)
    return AssetModel(**asset_data)