Update websocket CryptoOrderBookMessage to add r boolean

Petersoj · Mar 12, 2024 · ab2225f · ab2225f
1 parent 5d205a7
commit ab2225f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git 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/...alpaca/websocket/marketdata/streams/crypto/model/orderbook/crypto_order_book_message.json b/...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 <code>true</code> for the first message and <code>false</code> for subsequent messages."
     }
   }
 }