py_alpaca_api.models.trade_model

Classes

TradeModel

Model for individual stock trade data.

LatestTradeModel

Model for latest trade data with symbol.

TradesResponse

Response model for trades endpoint with pagination.

Functions

trade_class_from_dict(→ TradeModel)

Create TradeModel from API response dictionary.

extract_trades_data(→ dict[str, Any])

Extract and transform trades data from API response.

Module Contents

class py_alpaca_api.models.trade_model.TradeModel[source]

Model for individual stock trade data.

timestamp: str[source]
symbol: str[source]
exchange: str[source]
price: float[source]
size: int[source]
conditions: list[str] | None[source]
id: int[source]
tape: str[source]
py_alpaca_api.models.trade_model.trade_class_from_dict(data: dict[str, Any], symbol: str | None = None) TradeModel[source]

Create TradeModel from API response dictionary.

Parameters:
  • data – Dictionary containing trade data from API

  • symbol – Optional symbol to use if not in data

Returns:

TradeModel instance

class py_alpaca_api.models.trade_model.LatestTradeModel[source]

Model for latest trade data with symbol.

trade: TradeModel[source]
symbol: str[source]
class py_alpaca_api.models.trade_model.TradesResponse[source]

Response model for trades endpoint with pagination.

trades: list[TradeModel][source]
symbol: str[source]
next_page_token: str | None = None[source]
py_alpaca_api.models.trade_model.extract_trades_data(data: dict[str, Any]) dict[str, Any][source]

Extract and transform trades data from API response.

Parameters:

data – Raw API response data

Returns:

Transformed dictionary ready for model creation