Trade (io.github.binance:binance-connector-java 3.2.0 API)

java.lang.Object
- com.binance.connector.client.impl.spot.Trade

```
public class Trade
extends Object
```
Trade Endpoints
All endpoints under the Spot Account/Trade Endpoint section of the API documentation will be implemented in this class.
Response will be returned in String format.

Constructor Summary

Constructors
Constructor and Description
`Trade(String baseUrl, String apiKey, com.binance.connector.client.utils.signaturegenerator.SignatureGenerator signatureGenerator, boolean showLimitUsage, com.binance.connector.client.utils.ProxyAuth proxy)`
`Trade(String baseUrl, String apiKey, String secretKey, boolean showLimitUsage, com.binance.connector.client.utils.ProxyAuth proxy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`account(Map<String,Object> parameters)` Get current account information.
`String`	`cancelOCO(Map<String,Object> parameters)` Cancel an entire Order List.
`String`	`cancelOpenOrders(Map<String,Object> parameters)` Cancels all active orders on a symbol.
`String`	`cancelOrder(Map<String,Object> parameters)` Cancel an active order.
`String`	`cancelReplace(Map<String,Object> parameters)` Cancels an existing order and places a new order on the same symbol. Filters are evaluated before the cancel order is placed. If the new order placement is successfully sent to the engine, the order count will increase by 1.
`String`	`commission(Map<String,Object> parameters)` Get current account commission rates.
`String`	`getOCOOrder(Map<String,Object> parameters)` Retrieves a specific OCO based on provided optional parameters GET /api/v3/orderList
`String`	`getOCOOrders(Map<String,Object> parameters)` Retrieves all OCO based on provided optional parameters GET /api/v3/allOrderList
`String`	`getOpenOCOOrders(Map<String,Object> parameters)` GET /api/v3/openOrderList
`String`	`getOpenOrders(Map<String,Object> parameters)` Get all open orders on a symbol.
`String`	`getOrder(Map<String,Object> parameters)` Check an order's status.
`String`	`getOrders(Map<String,Object> parameters)` Get all account orders; active, canceled, or filled.
`String`	`myTrades(Map<String,Object> parameters)` Get trades for a specific account and symbol.
`String`	`newOrder(Map<String,Object> parameters)` Send in a new order.
`String`	`ocoOrder(Map<String,Object> parameters)` Send in a new OCO.
`String`	`preventedMatches(Map<String,Object> parameters)` Displays the list of orders that were expired because of STP.
`String`	`rateLimitOrder(Map<String,Object> parameters)` Displays the user's current order count usage for all intervals.
`String`	`sorAllocations(Map<String,Object> parameters)` Retrieves allocations resulting from SOR order placement.
`String`	`sorOrder(Map<String,Object> parameters)` Places an order using smart order routing (SOR).
`String`	`testNewOrder(Map<String,Object> parameters)` Test new order creation and signature/recvWindow long.
`String`	`testSorOrder(Map<String,Object> 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
  - Trade
```
public Trade(String baseUrl,
             String apiKey,
             String secretKey,
             boolean showLimitUsage,
             com.binance.connector.client.utils.ProxyAuth proxy)
```
  - Trade
```
public Trade(String baseUrl,
             String apiKey,
             com.binance.connector.client.utils.signaturegenerator.SignatureGenerator signatureGenerator,
             boolean showLimitUsage,
             com.binance.connector.client.utils.ProxyAuth proxy)
```
- Method Detail
  - testNewOrder
```
public String testNewOrder(Map<String,Object> parameters)
```
    Test new order creation and signature/recvWindow long. Creates and validates a new order but does not send it into the matching engine.
    
    POST /api/v3/order/test
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    In addition to all parameters accepted by POST /api/v3/order, the following optional parameters are also accepted:
    computeCommissionRates -- optional/boolean -- Default: false
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#test-new-order-trade
  - newOrder
```
public String newOrder(Map<String,Object> parameters)
```
    Send in a new order.
    
    POST /api/v3/order
    
    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
    side -- mandatory/enum
    type -- mandatory/enum
    timeInForce -- optional/enum
    quantity -- optional/decimal
    quoteOrderQty -- optional/decimal
    price -- optional/decimal
    newClientOrderId -- optional/string -- A unique id among open orders. Automatically generated if not sent.
    strategyId -- optional/int
    strategyType -- optional/int -- The value cannot be less than 1000000.
    stopPrice -- optional/decimal -- Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
    trailingDelta -- optional/long -- Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
    icebergQty -- optional/decimal -- Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
    newOrderRespType -- optional/enum -- Set the response JSON. ACK, RESULT, or FULL; MARKET and LIMIT order types default to FULL, all other orders default to ACK.
    selfTradePrevention -- optional/enum -- The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
    s recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#new-order-trade
  - cancelOrder
```
public String cancelOrder(Map<String,Object> parameters)
```
    Cancel an active order.
    
    DELETE /api/v3/order
    
    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
    orderId -- optional/long
    origClientOrderId -- optional/string
    newClientOrderId -- optional/string
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#cancel-order-trade
  - cancelOpenOrders
```
public String cancelOpenOrders(Map<String,Object> parameters)
```
    Cancels all active orders on a symbol. This includes OCO orders.
    
    DELETE /api/v3/openOrders
    
    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
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#cancel-order-trade
  - getOrder
```
public String getOrder(Map<String,Object> parameters)
```
    Check an order's status.
    
    GET /api/v3/order
    
    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
    orderId -- optional/long
    origClientOrderId -- optional/string
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#query-order-user_data
  - cancelReplace
```
public String cancelReplace(Map<String,Object> parameters)
```
    Cancels an existing order and places a new order on the same symbol.
    Filters are evaluated before the cancel order is placed.
    If the new order placement is successfully sent to the engine, the order count will increase by 1.
    
    POST /api/v3/order/cancelReplace
    
    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
    side -- mandatory/enum
    type -- mandatory/enum
    cancelReplaceMode -- mandatory/enum -- The allowed values are: STOP_ON_FAILURE - If the cancel request fails, the new order placement will not be attempted. ALLOW_FAILURES - new order placement will be attempted even if cancel request fails.
    timeInForce -- optional/enum
    quantity -- optional/decimal
    quoteOrderQty -- optional/decimal
    price -- optional/decimal
    cancelNewClientOrderId -- optional/string
    cancelOrigClientOrderId -- optional/string -- Either the cancelOrigClientOrderId or cancelOrderId must be provided. If both are provided, cancelOrderId takes precedence.
    cancelOrderId -- optional/long -- Either the cancelOrigClientOrderId or cancelOrderId must be provided. If both are provided, cancelOrderId takes precedence.
    newClientOrderId -- optional/string -- Used to identify the new order.
    stopStrategyId -- optional/int
    stopStrategyType -- optional/int -- The value cannot be less than 1000000.
    stopPrice -- optional/decimal
    icebergQty -- optional/decimal
    trailingDelta -- optional/long
    newOrderRespType -- optional/enum -- Allowed values: ACK, RESULT, FULL. MARKET and LIMIT orders types default to FULL; all other orders default to ACK
    selfTradePreventionMode -- optional/enum -- 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/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#cancel-an-existing-order-and-send-a-new-order-trade
  - getOpenOrders
```
public String getOpenOrders(Map<String,Object> parameters)
```
    Get all open orders on a symbol. Careful when accessing this with no symbol.
    
    GET /api/v3/openOrders
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    symbol -- optional/string
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#current-open-orders-user_data
  - getOrders
```
public String getOrders(Map<String,Object> parameters)
```
    Get all account orders; active, canceled, or filled.
    
    GET /api/v3/allOrders
    
    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
    orderId -- optional/long
    startTime -- optional/long
    endTime -- optional/long
    limit -- optional/int
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#all-orders-user_data
  - ocoOrder
```
public String ocoOrder(Map<String,Object> parameters)
```
    Send in a new OCO.
    
    POST /api/v3/order/oco
    
    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
    listClientOrderId -- optional/string
    side -- mandatory/enum
    quantity -- mandatory/decimal
    limitClientOrderId -- optional/string
    limitStrategyId -- optional/int
    limitStrategyType -- optional/int
    price -- mandatory/decimal
    limitIcebergQty -- optional/decimal
    trailingDelta -- optional/long
    stopClientOrderId -- optional/string
    stopPrice -- mandatory/decimal
    stopStrategyId -- optional/int
    stopStrategyType -- optional/int -- The value cannot be less than 1000000.
    stopLimitPrice -- optional/decimal -- If provided, stopLimitTimeInForce is required.
    stopIcebergQty -- optional/decimal
    stopLimitTimeInForce -- optional/enum
    newOrderRespType -- optional/enum
    selfTradePreventionMode -- optional/enum -- 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/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#new-oco-trade
  - cancelOCO
```
public String cancelOCO(Map<String,Object> parameters)
```
    Cancel an entire Order List.
    
    DELETE /api/v3/orderList
    
    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
    orderListId -- optional/string
    listClientOrderId -- optional/string
    newClientOrderId -- optional/string
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#cancel-oco-trade
  - getOCOOrder
```
public String getOCOOrder(Map<String,Object> parameters)
```
    Retrieves a specific OCO based on provided optional parameters
    
    GET /api/v3/orderList
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    orderListId -- optional/string
    origClientOrderId -- optional/string
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#query-oco-user_data
  - getOCOOrders
```
public String getOCOOrders(Map<String,Object> parameters)
```
    Retrieves all OCO based on provided optional parameters
    
    GET /api/v3/allOrderList
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    fromId -- optional/long
    startTime -- optional/long
    endTime -- optional/long
    limit -- optional/int
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#query-oco-user_data
  - getOpenOCOOrders
```
public String getOpenOCOOrders(Map<String,Object> parameters)
```
    GET /api/v3/openOrderList
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#query-open-oco-user_data
  - account
```
public String account(Map<String,Object> parameters)
```
    Get current account information.
    
    GET /api/v3/account
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#account-information-user_data
  - myTrades
```
public String myTrades(Map<String,Object> parameters)
```
    Get trades for a specific account and symbol.
    
    GET /api/v3/myTrades
    
    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
    orderId -- optional/long
    startTime -- optional/long
    endTime -- optional/long
    fromId -- optional/long
    limit -- optional/int
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#account-trade-list-user_data
  - rateLimitOrder
```
public String rateLimitOrder(Map<String,Object> parameters)
```
    Displays the user's current order count usage for all intervals.
    
    GET /api/v3/rateLimit/order
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#query-current-order-count-usage-trade
  - preventedMatches
```
public String preventedMatches(Map<String,Object> parameters)
```
    Displays the list of orders that were expired because of STP. These are the combinations supported: * symbol + preventedMatchId * symbol + orderId * symbol + orderId + fromPreventedMatchId (limit will default to 500) * symbol + orderId + fromPreventedMatchId + limit
    
    GET /api/v3/myPreventedMatches
    
    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
    preventedMatchId -- optional/long
    orderId -- optional/long -- Order id
    fromPreventedMatchId -- optional/long
    limit -- optional/int -- Default 500; max 1000.
    recvWindow -- optional/long -- The value cannot be greater than 60000
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#query-prevented-matches-user_data
  - sorAllocations
```
public String sorAllocations(Map<String,Object> parameters)
```
    Retrieves allocations resulting from SOR order placement. Supported parameter combinations: Parameters Response symbol allocations from oldest to newest symbol + startTime oldest allocations since startTime symbol + endTime newest allocations until endTime symbol + startTime + endTime allocations within the time range symbol + fromAllocationId allocations by allocation ID symbol + orderId allocations related to an order starting with oldest symbol + orderId + fromAllocationId allocations related to an order by allocation ID Note: The time between startTime and endTime can't be longer than 24 hours.
    
    GET /api/v3/myAllocations
    
    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 -- Trading symbol, e.g. BNBUSDT
    startTime -- optional/long -- UTC timestamp in ms
    endTime -- optional/long -- UTC timestamp in ms
    fromAllocationId -- optional/int
    limit -- optional/int -- Default 500; max 1000.
    orderId -- optional/long -- Order id
    recvWindow -- optional/long -- The value cannot be greater than 60000
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#query-allocations-user_data
  - commission
```
public String commission(Map<String,Object> parameters)
```
    Get current account commission rates.
    
    GET /api/v3/account/commission
    
    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/#query-commission-rates-user_data
  - sorOrder
```
public String sorOrder(Map<String,Object> parameters)
```
    Places an order using smart order routing (SOR).
    
    POST /api/v3/sor/order
    
    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 -- Trading symbol, e.g. BNBUSDT
    side -- mandatory/enum
    type -- mandatory/enum -- only supports LIMIT and MARKET orders
    timeInForce -- optional/enum -- Order time in force
    quantity -- mandatory/decimal
    price -- optional/decimal
    newClientOrderId -- optional/string -- Used to uniquely identify this cancel. Automatically generated by default
    strategyId -- optional/int
    strategyType -- optional/int -- The value cannot be less than 1000000.
    icebergQty -- optional/decimal -- Used with LIMIT to create an iceberg order.
    newOrderRespType -- optional/enum -- Set the response JSON. MARKET and LIMIT order types default to FULL, all other orders default to ACK.
    selfTradePreventionMode -- optional/enum -- 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/long -- The value cannot be greater than 60000
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#new-order-using-sor-trade
  - testSorOrder
```
public String testSorOrder(Map<String,Object> 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.
    
    POST /api/v3/sor/order/test
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    In addition to all parameters accepted by POST /api/v3/sor/order, the following optional parameters are also accepted:
    computeCommissionRates -- optional/boolean -- Default: false
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#test-new-order-using-sor-trade

Class Trade

Trade Endpoints

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Trade

Trade

Method Detail

testNewOrder

newOrder

cancelOrder

cancelOpenOrders

getOrder

cancelReplace

getOpenOrders

getOrders

ocoOrder

cancelOCO

getOCOOrder

getOCOOrders

getOpenOCOOrders

account

myTrades

rateLimitOrder

preventedMatches

sorAllocations

commission

sorOrder

testSorOrder