py_alpaca_api.models.asset_model

Attributes

KEY_PROCESSORS

Classes

AssetModel

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.

asset_class_from_dict(→ AssetModel)

Create AssetModel from dictionary data.

Module Contents

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

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.asset_model.AssetModel[source]
id: str[source]
asset_class: str[source]
easy_to_borrow: bool[source]
exchange: str[source]
fractionable: bool[source]
maintenance_margin_requirement: float[source]
marginable: bool[source]
name: str[source]
shortable: bool[source]
status: str[source]
symbol: str[source]
tradable: bool[source]
py_alpaca_api.models.asset_model.asset_class_from_dict(data_dict: dict) → AssetModel[source]

Create AssetModel from dictionary data.

Parameters:

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

Returns:

An instance of the AssetModel class.

Raises:

None –