Package markets.alpaca.client.ws

Class StockSubscription

java.lang.Object

markets.alpaca.client.ws.StockSubscription

public final class StockSubscription
extends Object

Describes which stock data channels and symbols to subscribe to (or unsubscribe from).

Use builder() to construct an instance. Each field is a set of symbols; an empty set means "no change for this channel". Use "*" to subscribe to all available symbols. Subscribing to trades automatically subscribes to corrections and cancel-errors for the same symbols.

 var sub = StockSubscription.builder()
     .trades("AAPL", "TSLA")
     .quotes("AAPL")
     .bars("*")
     .build();
 stream.subscribe(sub);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StockSubscription.Builder

Method Summary

Modifier and Type	Method	Description
Set<String>	bars()
static StockSubscription.Builder	builder()
Set<String>	dailyBars()
boolean	isEmpty()	Returns true if this subscription contains at least one symbol in any channel.
Set<String>	lulds()
Set<String>	quotes()
Set<String>	statuses()
Set<String>	trades()
Set<String>	updatedBars()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

trades

public Set<String> trades()

quotes

public Set<String> quotes()

bars

public Set<String> bars()

dailyBars

public Set<String> dailyBars()

updatedBars

public Set<String> updatedBars()

statuses

public Set<String> statuses()

lulds

public Set<String> lulds()

isEmpty

public boolean isEmpty()

Returns true if this subscription contains at least one symbol in any channel.

builder

public static StockSubscription.Builder builder()