Package markets.alpaca.client.ws.model

package markets.alpaca.client.ws.model
Immutable payload models for Alpaca WebSocket stream events.

These records are deserialized from stream messages delivered by the handwritten WebSocket clients. Price, size, and quantity fields that can require decimal precision use BigDecimal rather than floating-point types.

  • Record Classes
    Class
    Description
    CryptoBar
    An aggregated crypto price bar (minute, daily, or updated).
    CryptoOrderbook
    A full or incremental order book snapshot for a crypto pair (T: "o").
    CryptoOrderbookLevel
    A single price level in a crypto order book.
    CryptoQuote
    A top-of-book quote from the Alpaca crypto exchange order book (T: "q").
    CryptoTrade
    A cryptocurrency trade executed on the Alpaca exchange (T: "t").
    LuldBand
    A Limit Up – Limit Down (LULD) price band update (T: "l").
    NewsArticle
    A real-time news article event (T: "n").
    Order
    An order entity as returned within trade update events.
    StockBar
    An aggregated stock price bar (minute, daily, or updated).
    StockQuote
    A National Best Bid and Offer (NBBO) quote update (T: "q").
    StockTrade
    A stock trade execution event (T: "t").
    StockTradingStatus
    A trading status update for a security (T: "s").
    TradeCancelError
    A trade cancellation or error event (T: "x").
    TradeCorrection
    A trade correction event (T: "c").
    TradeUpdate
    An order lifecycle event for the authenticated account.