com.binance.connector.client.impl.websocketapi

Class WebSocketApiUserDataStream

java.lang.Object

com.binance.connector.client.impl.websocketapi.WebSocketApiUserDataStream

All Implemented Interfaces:

WebSocketApiModule

public class WebSocketApiUserDataStream
extends Object
implements WebSocketApiModule

User Data Stream Requests

All requests under the User Data Stream requests section of the WebSocket API documentation will be implemented in this class.
Response will be returned as callback.

Constructor Summary

Constructors

Constructor and Description
WebSocketApiUserDataStream(com.binance.connector.client.utils.websocketapi.WebSocketApiRequestHandler handler)

Method Summary

Modifier and Type	Method and Description
void	userDataStreamPing(String listenKey, org.json.JSONObject parameters) Ping a user data stream to keep it alive. User data streams close automatically after 60 minutes, even if you're listening to them on WebSocket Streams. In order to keep the stream open, you have to regularly send pings using the userDataStream.ping request. It is recommended to send a ping once every 30 minutes. Note: the stream will close in 60 minutes unless userDataStream.ping requests are sent regularly.
void	userDataStreamStart(org.json.JSONObject parameters) Start a new user data stream. The response will output a listen key that can be subscribed through on the WebSocket stream afterwards. Note: the stream will close in 60 minutes unless userDataStream.ping requests are sent regularly.
void	userDataStreamStop(String listenKey, org.json.JSONObject parameters) Explicitly stop and close the user data stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketApiUserDataStream

public WebSocketApiUserDataStream(com.binance.connector.client.utils.websocketapi.WebSocketApiRequestHandler handler)

Method Detail

userDataStreamStart

public void userDataStreamStart(org.json.JSONObject parameters)

Start a new user data stream.
The response will output a listen key that can be subscribed through on the WebSocket stream afterwards.
Note: the stream will close in 60 minutes unless userDataStream.ping requests are sent regularly.

Parameters:

parameters - JSONObject composed by key-value pairs:

requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#start-user-data-stream-user_stream

userDataStreamPing

public void userDataStreamPing(String listenKey,
                               org.json.JSONObject parameters)

Ping a user data stream to keep it alive.
User data streams close automatically after 60 minutes, even if you're listening to them on WebSocket Streams.
In order to keep the stream open, you have to regularly send pings using the userDataStream.ping request.
It is recommended to send a ping once every 30 minutes.
Note: the stream will close in 60 minutes unless userDataStream.ping requests are sent regularly.

Parameters:

listenKey - -- required/String

parameters - JSONObject composed by key-value pairs:

requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#ping-user-data-stream-user_stream

userDataStreamStop

public void userDataStreamStop(String listenKey,
                               org.json.JSONObject parameters)

Explicitly stop and close the user data stream.

Parameters:

listenKey - -- required/String

parameters - JSONObject composed by key-value pairs:

requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#stop-user-data-stream-user_stream