Package markets.alpaca.client.ws.model

Record Class StockTradingStatus

java.lang.Object
java.lang.Record
markets.alpaca.client.ws.model.StockTradingStatus
Record Components:
symbol - ticker symbol
statusCode - status code (tape-dependent; see above)
statusMessage - human-readable status description
reasonCode - halt/resume reason code (may be null)
reasonMessage - human-readable reason (may be null)
timestamp - RFC-3339 timestamp
tape - consolidated tape identifier
public record StockTradingStatus(String symbol, String statusCode, String statusMessage, String reasonCode, String reasonMessage, String timestamp, String tape) extends Record
A trading status update for a security (T: "s").

Available from any {source} regardless of subscription plan.

Status codes by tape:

  • Tape A & B (CTA): 2 Halt, 3 Resume, 5 Price Indication, 6 Range Indication, 7 Market Imbalance Buy, 8 Market Imbalance Sell, E Short Sale Restriction, F LULD, etc.
  • Tape C & O (UTP): H Halt, Q Quotation Resumption, T Trading Resumption, P Volatility Trading Pause.

  • Constructor Details

    • StockTradingStatus

      public StockTradingStatus(String symbol, String statusCode, String statusMessage, String reasonCode, String reasonMessage, String timestamp, String tape)
      Creates an instance of a StockTradingStatus record class.
      Parameters:
      symbol - the value for the symbol record component
      statusCode - the value for the statusCode record component
      statusMessage - the value for the statusMessage record component
      reasonCode - the value for the reasonCode record component
      reasonMessage - the value for the reasonMessage record component
      timestamp - the value for the timestamp record component
      tape - the value for the tape record component

  • Method Details

    • 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.

    • symbol

      @SerializedName("S") public String symbol()
      Returns the value of the symbol record component.
      Returns:
      the value of the symbol record component

    • statusCode

      @SerializedName("sc") public String statusCode()
      Returns the value of the statusCode record component.
      Returns:
      the value of the statusCode record component

    • statusMessage

      @SerializedName("sm") public String statusMessage()
      Returns the value of the statusMessage record component.
      Returns:
      the value of the statusMessage record component

    • reasonCode

      @SerializedName("rc") public String reasonCode()
      Returns the value of the reasonCode record component.
      Returns:
      the value of the reasonCode record component

    • reasonMessage

      @SerializedName("rm") public String reasonMessage()
      Returns the value of the reasonMessage record component.
      Returns:
      the value of the reasonMessage record component

    • timestamp

      @SerializedName("t") public String timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component

    • tape

      @SerializedName("z") public String tape()
      Returns the value of the tape record component.
      Returns:
      the value of the tape record component