Skip to content

Commit 2f23111

Browse files
committed
docs: subscribeToCandles and subscribeToConvertedCandles period is not optional
1 parent 24c20e0 commit 2f23111

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/main/java/com/cryptomarket/sdk/websocket/CryptomarketWSMarketDataClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public void subscribeToTrades(
7373
* @param notificationBiConsumer recieves a feed of candles as a map of them,
7474
* indexed by symbol id, and the
7575
* type of notification, either SNAPSHOT or UPDATE
76-
* @param period Optional. A valid tick interval. 'M1' (one
76+
* @param period A valid tick interval. 'M1' (one
7777
* minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one
7878
* hour), 'H4', 'D1' (one day), 'D7', '1M' (one
7979
* month).
@@ -103,15 +103,15 @@ public void subscribeToCandles(
103103
* <p>
104104
* Conversion from the symbol quote currency to the target currency is the mean
105105
* of "best" bid price and "best" ask price in the order book. If there is no
106-
* "best" bid of ask price, the last price is returned.
106+
* "best" bid or ask price, the last price is returned.
107107
* <p>
108108
* https://api.exchange.cryptomkt.com/#subscribe-to-candles
109109
*
110110
* @param notificationBiConsumer recieves a feed of candles as a map of them,
111111
* indexed by symbol id, and the
112112
* type of notification, either SNAPSHOT or UPDATE
113113
* @param symbols A list of symbol ids to subscribe
114-
* @param period Optional. A valid tick interval. 'M1' (one
114+
* @param period A valid tick interval. 'M1' (one
115115
* minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one
116116
* hour), 'H4', 'D1' (one day), 'D7', '1M' (one
117117
* month).

0 commit comments

Comments
 (0)