Source code for py_alpaca_api.models.position_model

from dataclasses import dataclass

from py_alpaca_api.models.model_utils import KEY_PROCESSORS, extract_class_data


@dataclass

[docs]
class PositionModel:

[docs]
    asset_id: str


[docs]
    symbol: str


[docs]
    exchange: str


[docs]
    asset_class: str


[docs]
    avg_entry_price: float


[docs]
    qty: float


[docs]
    qty_available: float


[docs]
    side: str


[docs]
    market_value: float


[docs]
    cost_basis: float


[docs]
    profit_dol: float


[docs]
    profit_pct: float


[docs]
    intraday_profit_dol: float


[docs]
    intraday_profit_pct: float


[docs]
    portfolio_pct: float


[docs]
    current_price: float


[docs]
    lastday_price: float


[docs]
    change_today: float


[docs]
    asset_marginable: bool




############################################
# Data Class Position Conversion Functions
############################################

[docs]
def position_class_from_dict(data_dict: dict) -> PositionModel:
    """Returns a PositionModel object created from a given data dictionary.

    Args:
        data_dict: A dictionary containing the data for creating a PositionModel object.

    Returns:
        PositionModel: A PositionModel object created using the data from the dictionary.
    """
    position_data = extract_class_data(data_dict, KEY_PROCESSORS, PositionModel)
    return PositionModel(**position_data)