Package markets.alpaca.client.ws

Record Class TradingSubscription

java.lang.Object
java.lang.Record
markets.alpaca.client.ws.TradingSubscription
public record TradingSubscription(Set<String> streams) extends Record
The complete set of trading streams to subscribe to.

The streams list is authoritative — sending a new listen request replaces the current subscription entirely. To add a stream, include all currently active streams plus the new one.

Currently the only supported stream is trade_updates.

  • Field Details

    • TRADE_UPDATES

      public static final TradingSubscription TRADE_UPDATES
      Pre-built subscription for trade updates only (the most common case).

  • Constructor Details

    • TradingSubscription

      public TradingSubscription(Set<String> streams)
      Creates an instance of a TradingSubscription record class.
      Parameters:
      streams - the value for the streams record component

    • TradingSubscription

      public TradingSubscription(List<String> streams)

  • Method Details

    • streams

      public Set<String> streams()
      The set of stream names to subscribe to (e.g. "trade_updates").

    • isEmpty

      public boolean isEmpty()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.