From ab2225f88f224cad8a95e39326b97e7f246bddd5 Mon Sep 17 00:00:00 2001
From: Jacob Peterson <14127217+Petersoj@users.noreply.github.com>
Date: Tue, 12 Mar 2024 12:10:38 -0700
Subject: [PATCH] Update websocket `CryptoOrderBookMessage` to add `r` boolean
---
README.md | 2 +-
.../crypto/model/orderbook/crypto_order_book_message.json | 5 +++++
2 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index c7f1cef..6f85535 100644
--- a/README.md
+++ b/README.md
@@ -110,7 +110,7 @@ System.out.println("PnL from Apple trade: " +
```
## [`Market Data API`](src/main/java/net/jacobpeterson/alpaca/rest/marketdata/AlpacaMarketDataAPI.java)
-The [`Market Data API`](src/main/java/net/jacobpeterson/alpaca/rest/marketdata/AlpacaMarketDataAPI.java) is used getting market data for stocks, cryptocurrencies, options, and more. Refer to the [Javadoc](https://javadoc.io/doc/net.jacobpeterson.alpaca/alpaca-java/latest/net/jacobpeterson/alpaca/rest/marketdata/AlpacaMarketDataAPI.html) for a list of all available method signatures.
+The [`Market Data API`](src/main/java/net/jacobpeterson/alpaca/rest/marketdata/AlpacaMarketDataAPI.java) is used for getting market data for stocks, cryptocurrencies, options, and more. Refer to the [Javadoc](https://javadoc.io/doc/net.jacobpeterson.alpaca/alpaca-java/latest/net/jacobpeterson/alpaca/rest/marketdata/AlpacaMarketDataAPI.html) for a list of all available method signatures.
Example usage:
```java
diff --git a/src/main/java/net/jacobpeterson/alpaca/websocket/marketdata/streams/crypto/model/orderbook/crypto_order_book_message.json b/src/main/java/net/jacobpeterson/alpaca/websocket/marketdata/streams/crypto/model/orderbook/crypto_order_book_message.json
index 76c632f..79814a8 100644
--- a/src/main/java/net/jacobpeterson/alpaca/websocket/marketdata/streams/crypto/model/orderbook/crypto_order_book_message.json
+++ b/src/main/java/net/jacobpeterson/alpaca/websocket/marketdata/streams/crypto/model/orderbook/crypto_order_book_message.json
@@ -23,6 +23,11 @@
"existingJavaType": "java.time.OffsetDateTime",
"javaName": "timestamp",
"title": "The timestamp with nanosecond precision."
+ },
+ "r": {
+ "existingJavaType": "java.lang.Boolean",
+ "javaName": "reset",
+ "title": "Whether this particular {@link net.jacobpeterson.alpaca.model.websocket.marketdata.streams.crypto.model.orderbook.CryptoOrderBookMessage} contains the whole order book and not just an update. Typically true
for the first message and false
for subsequent messages."
}
}
}