py_alpaca_api.models.position_model

Attributes

KEY_PROCESSORS

Classes

PositionModel

Functions

extract_class_data(data_dict, field_processors, data_class)	Extracts and processes data from a dictionary based on a given data class and field processors.
position_class_from_dict(→ PositionModel)	Returns a PositionModel object created from a given data dictionary.

Module Contents

py_alpaca_api.models.position_model.KEY_PROCESSORS

py_alpaca_api.models.position_model.extract_class_data(data_dict: dict, field_processors: dict, data_class: type[Any])

Extracts and processes data from a dictionary based on a given data class and field processors.

Parameters:

• data_dict (dict) – The dictionary containing the data to be processed.

• field_processors (Dict) – A dictionary of field processors.

• data_class (type[Any]) – The data class used to define the fields and types.

Returns:

A dictionary containing processed data, with keys corresponding to the fields of the data class.

Return type:

dict

Raises:

KeyError – When a field processor is not found for a specific data type.

class py_alpaca_api.models.position_model.PositionModel

asset_id: str

symbol: str

exchange: str

asset_class: str

avg_entry_price: float

qty: float

qty_available: float

side: str

market_value: float

cost_basis: float

profit_dol: float

profit_pct: float

intraday_profit_dol: float

intraday_profit_pct: float

portfolio_pct: float

current_price: float

lastday_price: float

change_today: float

asset_marginable: bool

py_alpaca_api.models.position_model.position_class_from_dict(data_dict: dict) → PositionModel

Returns a PositionModel object created from a given data dictionary.

Parameters:

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

Returns:

A PositionModel object created using the data from the dictionary.

Return type:

PositionModel