com.binance.connector.futures.client.impl.futures

Class UserData

java.lang.Object

com.binance.connector.futures.client.impl.futures.UserData

Direct Known Subclasses:

CMUserData, UMUserData

public abstract class UserData
extends Object

User Data Streams Endpoints

Response will be returned in String format.

Constructor Summary

Constructors

Constructor and Description
UserData(String productUrl, String apiKey, boolean showLimitUsage, com.binance.connector.futures.client.utils.ProxyAuth proxy)

Method Summary

Modifier and Type	Method and Description
String	closeListenKey() Close out a user data stream.
String	createListenKey() Start a new user data stream.
String	extendListenKey() Keepalive a user data stream to prevent a time out.
String	getProductUrl()
com.binance.connector.futures.client.utils.RequestHandler	getRequestHandler()
boolean	getShowLimitUsage()
void	setProductUrl(String productUrl)
void	setRequestHandler(String apiKey, com.binance.connector.futures.client.utils.ProxyAuth proxy)
void	setShowLimitUsage(boolean showLimitUsage)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserData

public UserData(String productUrl,
                String apiKey,
                boolean showLimitUsage,
                com.binance.connector.futures.client.utils.ProxyAuth proxy)

Method Detail

getProductUrl

public String getProductUrl()

getRequestHandler

public com.binance.connector.futures.client.utils.RequestHandler getRequestHandler()

getShowLimitUsage

public boolean getShowLimitUsage()

setProductUrl

public void setProductUrl(String productUrl)

setRequestHandler

public void setRequestHandler(String apiKey,
                              com.binance.connector.futures.client.utils.ProxyAuth proxy)

setShowLimitUsage

public void setShowLimitUsage(boolean showLimitUsage)

createListenKey

public String createListenKey()

Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. If the account has an active listenKey, that listenKey will be returned and its validity will be extended for 60 minutes.

POST /v1/listenKey

Returns:

String

See Also:

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

extendListenKey

public String extendListenKey()

Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 60 minutes.

PUT /v1/listenKey

Returns:

String

See Also:

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

closeListenKey

public String closeListenKey()

Close out a user data stream.

DELETE /v1/listenKey

Returns:

String

See Also:

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