com.binance.connector.client.impl.websocketapi

Class WebSocketApiTrade

java.lang.Object

com.binance.connector.client.impl.websocketapi.WebSocketApiTrade

All Implemented Interfaces:

WebSocketApiModule

public class WebSocketApiTrade
extends Object
implements WebSocketApiModule

Trading Requests

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

Method Summary

Modifier and Type	Method and Description
void	cancelAllOpenOrders(String symbol, org.json.JSONObject parameters) Cancel all open orders on a symbol, including OCO orders.
void	cancelOcoOrder(String symbol, org.json.JSONObject parameters) Cancel an active OCO. If both orderListId and listClientOrderId parameters are specified, only orderListId is used and listClientOrderId is ignored. Canceling an individual leg with order.cancel will cancel the entire OCO as well.
void	cancelOrder(String symbol, org.json.JSONObject parameters) Cancel an active order. If both orderId and origClientOrderId parameters are specified, only orderId is used and origClientOrderId is ignored.
void	cancelReplaceOrder(String symbol, String cancelReplaceMode, String side, String type, org.json.JSONObject parameters) Cancel an existing order and immediately place a new order instead of the canceled one. Similar to the order.place request, additional mandatory parameters (*) are determined by the new order type. If both cancelOrderId and cancelOrigClientOrderId parameters are specified, only cancelOrderId is used and cancelOrigClientOrderId is ignored.
void	getOcoOrder(org.json.JSONObject parameters) Check execution status of an OCO.
void	getOpenOcoOrders(org.json.JSONObject parameters) Query execution status of all open OCOs. If both orderListId and listClientOrderId parameters are specified, only orderListId is used and listClientOrderId is ignored. Canceling an individual leg with order.cancel will cancel the entire OCO as well.
void	getOpenOrders(org.json.JSONObject parameters) Query execution status of all open orders.
void	getOrder(String symbol, org.json.JSONObject parameters) Check execution status of an order. If both orderId and origClientOrderId parameters are specified, only orderId is used and origClientOrderId is ignored.
void	newOcoOrder(String symbol, String side, double price, double quantity, org.json.JSONObject parameters) Send in a new one-cancels-the-other (OCO) pair: LIMIT_MAKER + STOP_LOSS/STOP_LOSS_LIMIT orders (called legs), where activation of one order immediately cancels the other.
void	newOrder(String symbol, String side, String type, org.json.JSONObject parameters) Send in a new order. Additional mandatory parameters (*) are determined by the new order type.
void	newSorOrder(String symbol, String side, String type, double quantity, org.json.JSONObject parameters) Places an order using smart order routing (SOR).
void	testNewOrder(String symbol, String side, String type, org.json.JSONObject parameters) Test order placement. Validates new order parameters and verifies your signature but does not send the order into the matching engine. Additional mandatory parameters (*) are determined by the new order type.
void	testNewSorOrder(String symbol, String side, String type, double quantity, org.json.JSONObject parameters) Test new order creation and signature/recvWindow using smart order routing (SOR).

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketApiTrade

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

Method Detail

newOrder

public void newOrder(String symbol,
                     String side,
                     String type,
                     org.json.JSONObject parameters)

Send in a new order.
Additional mandatory parameters (*) are determined by the new order type.

Parameters:

symbol - String

side - String -- BUY or SELL

type - String

parameters - JSONObject composed by key-value pairs:

timeInForce -- optional/String
price -- optional/double
quantity -- optional/double
quoteOrderQty -- optional/double
newClientOrderId -- optional/String -- Arbitrary unique ID among open orders. Automatically generated if not sent
newOrderRespType -- optional/String -- Select response format: ACK, RESULT, FULL. MARKET and LIMIT orders use FULL by default, other order types default to ACK.
stopPrice -- optional/double
trailingDelta -- optional/int -- see https://github.com/binance/binance-spot-api-docs/blob/master/faqs/trailing-stop-faq.md
icebergQty -- optional/double
strategyId -- optional/int -- Arbitrary numeric value identifying the order within an order strategy.
strategyType -- optional/int -- Arbitrary numeric value identifying the order strategy. Values smaller than 1000000 are reserved and cannot be used.
selfTradePreventionMode -- optional/String -- The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#place-new-order-trade

testNewOrder

public void testNewOrder(String symbol,
                         String side,
                         String type,
                         org.json.JSONObject parameters)

Test order placement.
Validates new order parameters and verifies your signature but does not send the order into the matching engine.
Additional mandatory parameters (*) are determined by the new order type.

Parameters:

symbol - String

side - String -- BUY or SELL

type - String

parameters - JSONObject composed by key-value pairs:

timeInForce -- optional/String
price -- optional/double
quantity -- optional/double
quoteOrderQty -- optional/double
newClientOrderId -- optional/String -- Arbitrary unique ID among open orders. Automatically generated if not sent
newOrderRespType -- optional/String -- Select response format: ACK, RESULT, FULL. MARKET and LIMIT orders use FULL by default, other order types default to ACK.
stopPrice -- optional/double
trailingDelta -- optional/int -- see https://github.com/binance/binance-spot-api-docs/blob/master/faqs/trailing-stop-faq.md
icebergQty -- optional/double
strategyId -- optional/int -- Arbitrary numeric value identifying the order within an order strategy.
strategyType -- optional/int -- Arbitrary numeric value identifying the order strategy. Values smaller than 1000000 are reserved and cannot be used.
selfTradePreventionMode -- optional/String -- The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
computeCommissionRates -- optional/boolean -- Default: false.
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#test-new-order-trade

getOrder

public void getOrder(String symbol,
                     org.json.JSONObject parameters)

Check execution status of an order.
If both orderId and origClientOrderId parameters are specified, only orderId is used and origClientOrderId is ignored.

Parameters:

symbol - String

parameters - JSONObject composed by key-value pairs:

orderId -- optional/int -- Lookup order by orderId
origClientOrderId -- optional/String -- Lookup order by clientOrderId
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#query-order-user_data

cancelOrder

public void cancelOrder(String symbol,
                        org.json.JSONObject parameters)

Cancel an active order.
If both orderId and origClientOrderId parameters are specified, only orderId is used and origClientOrderId is ignored.

Parameters:

symbol - String

parameters - JSONObject composed by key-value pairs:

orderId -- optional/int -- Cancel order by orderId
origClientOrderId -- optional/String -- Cancel order by clientOrderId
newClientOrderId -- optional/String -- New ID for the canceled order. Automatically generated if not sent
cancelRestrictions -- optional/enum -- Supported values: ONLY_NEW - Cancel will succeed if the order status is NEW. ONLY_PARTIALLY_FILLED - Cancel will succeed if order status is PARTIALLY_FILLED.
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#cancel-order-trade

cancelReplaceOrder

public void cancelReplaceOrder(String symbol,
                               String cancelReplaceMode,
                               String side,
                               String type,
                               org.json.JSONObject parameters)

Cancel an existing order and immediately place a new order instead of the canceled one.
Similar to the order.place request, additional mandatory parameters (*) are determined by the new order type.
If both cancelOrderId and cancelOrigClientOrderId parameters are specified, only cancelOrderId is used and cancelOrigClientOrderId is ignored.

Parameters:

symbol - String

cancelReplaceMode - String -- STOP_ON_FAILURE or ALLOW_FAILURE

side - String -- BUY or SELL

type - String

parameters - JSONObject composed by key-value pairs:

cancelOrderId -- optional/int -- Cancel order by orderId
cancelOrigClientOrderId -- optional/String -- Cancel order by clientOrderId
cancelNewClientOrderId -- optional/String -- New ID for the canceled order. Automatically generated if not sent
timeInForce -- optional/String
price -- optional/double
quantity -- optional/double
quoteOrderQty -- optional/double
newClientOrderId -- optional/String -- Arbitrary unique ID among open orders. Automatically generated if not sent
newOrderRespType -- optional/String -- Select response format: ACK, RESULT, FULL. MARKET and LIMIT orders use FULL by default, other order types default to ACK.
stopPrice -- optional/double
trailingDelta -- optional/int -- see https://github.com/binance/binance-spot-api-docs/blob/master/faqs/trailing-stop-faq.md
icebergQty -- optional/double
strategyId -- optional/int -- Arbitrary numeric value identifying the order within an order strategy.
strategyType -- optional/int -- Arbitrary numeric value identifying the order strategy. Values smaller than 1000000 are reserved and cannot be used.
selfTradePreventionMode -- optional/String -- The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
cancelRestrictions -- optional/enum -- Supported values: ONLY_NEW - Cancel will succeed if the order status is NEW. ONLY_PARTIALLY_FILLED - Cancel will succeed if order status is PARTIALLY_FILLED.
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#cancel-and-replace-order-trade

getOpenOrders

public void getOpenOrders(org.json.JSONObject parameters)

Query execution status of all open orders.

Parameters:

parameters - JSONObject composed by key-value pairs:

symbol -- optional/String -- If omitted, open orders for all symbols are returned
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#current-open-orders-user_data

cancelAllOpenOrders

public void cancelAllOpenOrders(String symbol,
                                org.json.JSONObject parameters)

Cancel all open orders on a symbol, including OCO orders.
Cancellation reports for orders and OCOs have the same format as in order.cancel.

Parameters:

symbol - String

parameters - JSONObject composed by key-value pairs:

recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#cancel-open-orders-trade

newOcoOrder

public void newOcoOrder(String symbol,
                        String side,
                        double price,
                        double quantity,
                        org.json.JSONObject parameters)

Send in a new one-cancels-the-other (OCO) pair: LIMIT_MAKER + STOP_LOSS/STOP_LOSS_LIMIT orders (called legs), where activation of one order immediately cancels the other.

Parameters:

symbol - String

side - String -- BUY or SELL

price - double -- Price for the limit order

quantity - double

parameters - JSONObject composed by key-value pairs:

listClientOrderId -- optional/String -- Arbitrary unique ID among open OCOs. Automatically generated if not sent.
limitClientOrderId -- optional/String -- Arbitrary unique ID among open orders for the limit order. Automatically generated if not sent.
limitIcebergQty -- optional/double
limitStrategyId -- optional/int -- Arbitrary numeric value identifying the limit order within an order strategy.
limitStrategyType -- optional/int -- Arbitrary numeric value identifying the limit order strategy. Values smaller than 1000000 are reserved and cannot be used.
stopPrice -- optional/double -- Either stopPrice or trailingDelta, or both must be specified
trailingDelta -- optional/int -- see https://github.com/binance/binance-spot-api-docs/blob/master/faqs/trailing-stop-faq.md
stopClientOrderId -- optional/String -- Arbitrary unique ID among open orders for the stop order. Automatically generated if not sent.
stopLimitPrice -- optional/double
stopLimitTimeInForce -- optional/String -- See order.place for available options
stopIcebergQty -- optional/double
stopStrategyId -- optional/int -- Arbitrary numeric value identifying the stop order within an order strategy.
stopStrategyType -- optional/int -- Arbitrary numeric value identifying the stop order strategy. Values smaller than 1000000 are reserved and cannot be used.
newOrderRespType -- optional/String -- Select response format: ACK, RESULT, FULL (default).
selfTradePreventionMode -- optional/String -- The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#place-new-oco-trade

getOcoOrder

public void getOcoOrder(org.json.JSONObject parameters)

Check execution status of an OCO.
If both origClientOrderId and orderListId parameters are specified, only origClientOrderId is used and orderListId is ignored.

Parameters:

parameters - JSONObject composed by key-value pairs:

origClientOrderId -- optional/String -- Query OCO by listClientOrderId
orderListId -- required/int -- Query OCO by orderListId
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#query-oco-user_data

cancelOcoOrder

public void cancelOcoOrder(String symbol,
                           org.json.JSONObject parameters)

Cancel an active OCO.
If both orderListId and listClientOrderId parameters are specified, only orderListId is used and listClientOrderId is ignored.
Canceling an individual leg with order.cancel will cancel the entire OCO as well.

Parameters:

symbol - String

parameters - JSONObject composed by key-value pairs:

listClientOrderId -- optional/String -- Cancel OCO by listClientOrderId
orderListId -- required/int -- Cancel OCO by orderListId
newClientOrderId -- optional/String -- New ID for the canceled OCO. Automatically generated if not sent.
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#cancel-oco-trade

getOpenOcoOrders

public void getOpenOcoOrders(org.json.JSONObject parameters)

Query execution status of all open OCOs.
If both orderListId and listClientOrderId parameters are specified, only orderListId is used and listClientOrderId is ignored.
Canceling an individual leg with order.cancel will cancel the entire OCO as well.

Parameters:

parameters - JSONObject composed by key-value pairs:

recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#current-open-ocos-user_data

newSorOrder

public void newSorOrder(String symbol,
                        String side,
                        String type,
                        double quantity,
                        org.json.JSONObject parameters)

Places an order using smart order routing (SOR).

Parameters:

symbol - String

side - String -- BUY or SELL

type - String

quantity - double

parameters - JSONObject composed by key-value pairs:

timeInForce -- optional/String -- Applicable only to LIMIT order type.
price -- optional/double -- Applicable only to LIMIT order type.
newClientOrderId -- optional/String -- Arbitrary unique ID among open orders. Automatically generated if not sent
newOrderRespType -- optional/String -- Select response format: ACK, RESULT, FULL. MARKET and LIMIT orders use FULL by default, other order types default to ACK.
stopPrice -- optional/double
icebergQty -- optional/double
strategyId -- optional/int -- Arbitrary numeric value identifying the order within an order strategy.
strategyType -- optional/int -- Arbitrary numeric value identifying the order strategy. Values smaller than 1000000 are reserved and cannot be used.
selfTradePreventionMode -- optional/String -- The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#place-new-order-using-sor-trade

testNewSorOrder

public void testNewSorOrder(String symbol,
                            String side,
                            String type,
                            double quantity,
                            org.json.JSONObject parameters)

Test new order creation and signature/recvWindow using smart order routing (SOR). Creates and validates a new order but does not send it into the matching engine.

Parameters:

symbol - String

side - String -- BUY or SELL

type - String

quantity - double

parameters - JSONObject composed by key-value pairs:

timeInForce -- optional/String -- Applicable only to LIMIT order type.
price -- optional/double -- Applicable only to LIMIT order type.
newClientOrderId -- optional/String -- Arbitrary unique ID among open orders. Automatically generated if not sent
newOrderRespType -- optional/String -- Select response format: ACK, RESULT, FULL. MARKET and LIMIT orders use FULL by default, other order types default to ACK.
stopPrice -- optional/double
icebergQty -- optional/double
strategyId -- optional/int -- Arbitrary numeric value identifying the order within an order strategy.
strategyType -- optional/int -- Arbitrary numeric value identifying the order strategy. Values smaller than 1000000 are reserved and cannot be used.
selfTradePreventionMode -- optional/String -- The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
computeCommissionRates -- optional/boolean -- Default: false.
recvWindow -- optional/int -- The value cannot be greater than 60000
requestId -- optional/String or int

See Also:

https://binance-docs.github.io/apidocs/websocket_api/en/#test-new-order-using-sor-trade