Package markets.alpaca.client.ws

Class CryptoSubscription

java.lang.Object

markets.alpaca.client.ws.CryptoSubscription

public final class CryptoSubscription
extends Object

Describes which crypto data channels and pairs to subscribe to (or unsubscribe from).

Use builder() to construct an instance. Use "*" to subscribe to all available pairs. The free plan is limited to 10 symbols for orderbooks.

 var sub = CryptoSubscription.builder()
     .trades("BTC/USD")
     .quotes("BTC/USD", "ETH/USD")
     .bars("*")
     .build();
 stream.subscribe(sub);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CryptoSubscription.Builder

Method Summary

Modifier and Type	Method	Description
Set<String>	bars()
static CryptoSubscription.Builder	builder()
Set<String>	dailyBars()
boolean	isEmpty()
Set<String>	orderbooks()
Set<String>	quotes()
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()

orderbooks

public Set<String> orderbooks()

isEmpty

public boolean isEmpty()

builder

public static CryptoSubscription.Builder builder()