com.binance.connector.client.impl.websocketapi

Class WebSocketApiGeneral

java.lang.Object

com.binance.connector.client.impl.websocketapi.WebSocketApiGeneral

All Implemented Interfaces:

WebSocketApiModule

public class WebSocketApiGeneral
extends Object
implements WebSocketApiModule

General Requests

All requests under the General 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
WebSocketApiGeneral(com.binance.connector.client.utils.websocketapi.WebSocketApiRequestHandler handler)

Method Summary

Modifier and Type	Method and Description
void	exchangeInfo(org.json.JSONObject parameters) Query current exchange trading rules, rate limits, and symbol information. Notes: Without parameters, exchangeInfo displays all symbols with ["SPOT, "MARGIN", "LEVERAGED"] permissions. In order to list all active symbols on the exchange, you need to explicitly request all permissions. Available Permissions
void	ping(org.json.JSONObject parameters) Test connectivity to the WebSocket API. Note: You can use regular WebSocket ping frames to test connectivity as well, WebSocket API will respond with pong frames as soon as possible. ping request along with time is a safe way to test request-response handling in your application.
void	serverTime(org.json.JSONObject parameters) Test connectivity to the WebSocket API and get the current server time.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketApiGeneral

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

Method Detail

ping

public void ping(org.json.JSONObject parameters)

Test connectivity to the WebSocket API.
Note:
You can use regular WebSocket ping frames to test connectivity as well, WebSocket API will respond with pong frames as soon as possible.
ping request along with time is a safe way to test request-response handling in your application.

Parameters:

parameters - JSONObject composed by key-value pairs:

requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#test-connectivity

serverTime

public void serverTime(org.json.JSONObject parameters)

Test connectivity to the WebSocket API and get the current server time.

Parameters:

parameters - JSONObject composed by key-value pairs:

requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#check-server-time

exchangeInfo

public void exchangeInfo(org.json.JSONObject parameters)

Query current exchange trading rules, rate limits, and symbol information.
Notes:
Without parameters, exchangeInfo displays all symbols with ["SPOT, "MARGIN", "LEVERAGED"] permissions.
In order to list all active symbols on the exchange, you need to explicitly request all permissions.
Available Permissions

Parameters:

parameters - JSONObject composed by key-value pairs:

symbol -- optional/String
symbols -- optional/Array of String
permissions -- optional/Array of String
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#exchange-information