com.binance.connector.client.impl.spot

Class UserData

java.lang.Object

com.binance.connector.client.impl.spot.UserData

public class UserData
extends Object

User Data Streams Endpoints

All endpoints under the User Data Streams section of the API documentation will be implemented in this class.
Response will be returned in String format.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	closeIsolatedMarginListenKey(Map<String,Object> parameters) DELETE /sapi/v1/userDataStream/isolated
String	closeListenKey(Map<String,Object> parameters) Close out a user data stream.
String	closeMarginListenKey(Map<String,Object> parameters) DELETE /sapi/v1/userDataStream
String	createIsolatedMarginListenKey(Map<String,Object> parameters) POST /sapi/v1/userDataStream/isolated
String	createListenKey() Start a new user data stream.
String	createMarginListenKey() POST /sapi/v1/userDataStream
String	extendIsolatedMarginListenKey(Map<String,Object> parameters) PUT /sapi/v1/userDataStream/isolated
String	extendListenKey(Map<String,Object> parameters) Keepalive a user data stream to prevent a time out.
String	extendMarginListenKey(Map<String,Object> parameters) PUT /sapi/v1/userDataStream

Methods inherited from class java.lang.Object

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

Constructor Detail

UserData

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

Method Detail

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 /api/v3/userDataStream

Returns:

String

See Also:

https://binance-docs.github.io/apidocs/spot/en/#listen-key-spot

extendListenKey

public String extendListenKey(Map<String,Object> parameters)

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 30 minutes.

PUT /api/v3/userDataStream

Parameters:

parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter

listenKey -- mandatory/string

Returns:

String

See Also:

https://binance-docs.github.io/apidocs/spot/en/#listen-key-spot

closeListenKey

public String closeListenKey(Map<String,Object> parameters)

Close out a user data stream.

DELETE /api/v3/userDataStream

Parameters:

parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter

listenKey -- mandatory/string

Returns:

String

See Also:

https://binance-docs.github.io/apidocs/spot/en/#listen-key-spot

createMarginListenKey

public String createMarginListenKey()

POST /sapi/v1/userDataStream

Returns:

String

See Also:

https://binance-docs.github.io/apidocs/spot/en/#listen-key-margin

extendMarginListenKey

public String extendMarginListenKey(Map<String,Object> parameters)

PUT /sapi/v1/userDataStream

Parameters:

parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter

listenKey -- mandatory/string

Returns:

String

See Also:

https://binance-docs.github.io/apidocs/spot/en/#listen-key-margin

closeMarginListenKey

public String closeMarginListenKey(Map<String,Object> parameters)

DELETE /sapi/v1/userDataStream

Parameters:

parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter

listenKey -- mandatory/string

Returns:

String

See Also:

https://binance-docs.github.io/apidocs/spot/en/#listen-key-margin

createIsolatedMarginListenKey

public String createIsolatedMarginListenKey(Map<String,Object> parameters)

POST /sapi/v1/userDataStream/isolated

Parameters:

parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter

symbol -- mandatory/string

Returns:

String

See Also:

https://binance-docs.github.io/apidocs/spot/en/#listen-key-isolated-margin

extendIsolatedMarginListenKey

public String extendIsolatedMarginListenKey(Map<String,Object> parameters)

PUT /sapi/v1/userDataStream/isolated

Parameters:

parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter

symbol -- mandatory/string
listenKey -- mandatory/string

Returns:

String

See Also:

https://binance-docs.github.io/apidocs/spot/en/#listen-key-isolated-margin

closeIsolatedMarginListenKey

public String closeIsolatedMarginListenKey(Map<String,Object> parameters)

DELETE /sapi/v1/userDataStream/isolated

Parameters:

parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter

symbol -- mandatory/string
listenKey -- mandatory/string

Returns:

String

See Also:

https://binance-docs.github.io/apidocs/spot/en/#listen-key-isolated-margin