Module: Trade

API trade endpoints

Source: restful/trade.js, line 5

Methods

account(optionsopt)

Account Information (USER_DATA)

GET /api/v3/account

https://binance-docs.github.io/apidocs/spot/en/#account-information-user_data

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 394

allOrders(symbol, optionsopt)

All Orders (USER_DATA)

GET /api/v3/allOrders

https://binance-docs.github.io/apidocs/spot/en/#all-orders-user_data

Parameters:

Name Type Attributes Description

symbol string

options

object

Properties

Name	Type	Attributes	Description
`orderId`	number	<optional>
`startTime`	number	<optional>
`endTime`	number	<optional>
`limit`	number	<optional>
`recvWindow`	string	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 243

cancelAndReplace(symbol, side, type, cancelReplaceMode, optionsopt)

Cancel an Existing Order and Send a New Order (TRADE)

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

https://binance-docs.github.io/apidocs/spot/en/#cancel-an-existing-order-and-send-a-new-order-trade

Parameters:

Name Type Attributes Description

symbol string

side string

type string

cancelReplaceMode string

options

object

Properties

Name	Type	Attributes	Description
`timeInForce`	string	<optional>
`quantity`	number	<optional>
`quoteOrderQty`	number	<optional>
`price`	number	<optional>
`cancelNewClientOrderId`	string	<optional>
`cancelOrigClientOrderId`	string	<optional>
`cancelOrderId`	number	<optional>
`newClientOrderId`	string	<optional>
`strategyId`	number	<optional>
`strategytype`	number	<optional>	The value cannot be less than 1000000.
`stopPrice`	number	<optional>
`trailingDelta`	number	<optional>
`icebergQty`	number	<optional>
`newOrderRespType`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 194

cancelOCOOrder(symbol, optionsopt)

Cancel OCO (TRADE)

DELETE /api/v3/orderList

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

Parameters:

Name Type Attributes Description

symbol string

options

object

Properties

Name	Type	Attributes	Description
`orderListId`	number	<optional>
`listClientOrderId`	string	<optional>
`newClientOrderId`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 312

cancelOpenOrders(symbol, optionsopt)

Cancel all Open Orders on a Symbol (TRADE)

DELETE /api/v3/openOrders

https://binance-docs.github.io/apidocs/spot/en/#cancel-all-open-orders-on-a-symbol-trade

Parameters:

Name Type Attributes Description

symbol string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 124

cancelOrder(symbol, optionsopt)

Cancel Order (TRADE)

DELETE /api/v3/order

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

Parameters:

Name Type Attributes Description

symbol string

options

object

Properties

Name	Type	Attributes	Description
`orderId`	number	<optional>
`origClientOrderId`	string	<optional>
`newClientOrderId`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 102

getOCOOrder(optionsopt)

Query OCO (USER_DATA)

GET /api/v3/orderList

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

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`orderListId`	number	<optional>
`origClientOrderId`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 336

getOCOOrders(optionsopt)

Query all OCO (USER_DATA)

GET /api/v3/allOrderList

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

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`fromId`	number	<optional>
`startTime`	number	<optional>
`endTime`	number	<optional>
`limit`	number	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 358

getOpenOCOOrders(optionsopt)

Query Open OCO (USER_DATA)

GET /api/v3/openOrderList

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

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 376

getOrder(symbol, optionsopt)

Query Order (USER_DATA)

GET /api/v3/order

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

Parameters:

Name Type Attributes Description

symbol string

options

object

Properties

Name	Type	Attributes	Description
`orderId`	number	<optional>
`origClientOrderId`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 149

myTrades(symbol, optionsopt)

Account Trade List (USER_DATA)

GET /api/v3/myTrades

https://binance-docs.github.io/apidocs/spot/en/#account-trade-list-user_data

Parameters:

Name Type Attributes Description

symbol string

options

object

Properties

Name	Type	Attributes	Description
`orderId`	number	<optional>	This can only be used in combination with symbol.
`startTime`	number	<optional>
`endTime`	number	<optional>
`fromId`	number	<optional>
`limit`	number	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 418

newOCOOrder(symbol, side, quantity, price, stopPrice, optionsopt)

New OCO (TRADE)

POST /api/v3/order/oco

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

Parameters:

Name Type Attributes Description

symbol string

side string

quantity number

price number

stopPrice number

options

object

Properties

Name	Type	Attributes	Description
`listClientOrderId`	string	<optional>
`limitClientOrderId`	string	<optional>
`limitStrategyId`	number	<optional>
`limitStrategytype`	number	<optional>	The value cannot be less than 1000000.
`limitIcebergQty`	number	<optional>
`trailingDelta`	number	<optional>
`stopClientOrderId`	string	<optional>
`stopStrategyId`	number	<optional>
`stopStrategytype`	number	<optional>	The value cannot be less than 1000000.
`stopLimitPrice`	number	<optional>
`stopIcebergQty`	number	<optional>
`stopLimitTimeInForce`	string	<optional>
`newOrderRespType`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 282

newOrder(symbol, side, type, optionsopt)

New Order (TRADE)

POST /api/v3/order

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

Parameters:

Name Type Attributes Description

symbol string

side string

type string

options

object

Properties

Name	Type	Attributes	Description
`timeInForce`	string	<optional>
`quantity`	number	<optional>
`quoteOrderQty`	number	<optional>
`price`	number	<optional>
`newClientOrderId`	string	<optional>
`strategyId`	number	<optional>
`strategytype`	number	<optional>	The value cannot be less than 1000000.
`stopPrice`	number	<optional>
`trailingDelta`	number	<optional>
`icebergQty`	number	<optional>
`newOrderRespType`	string	<optional>
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/trade.js, line 74

newOrderTest(symbol, side, type, optionsopt)

Test New Order (TRADE)

POST /api/v3/order/test

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

Parameters:

Name Type Attributes Description

symbol string

side string

type string

options

object

Properties

Name	Type	Attributes	Description
`timeInForce`	string	<optional>
`quantity`	number	<optional>
`quoteOrderQty`	number	<optional>
`price`	number	<optional>
`newClientOrderId`	string	<optional>	A unique id among open orders. Automatically generated if not sent.
`strategyId`	number	<optional>
`strategytype`	number	<optional>	The value cannot be less than 1000000.
`stopPrice`	number	<optional>	Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
`trailingDelta`	number	<optional>	Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
`icebergQty`	number	<optional>	Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
`newOrderRespType`	string	<optional>	Set the response JSON. ACK, RESULT, or FULL; MARKET and LIMIT order types default to FULL, all other orders default to ACK.
`recvWindow`	number	<optional>	The value cannot be greater than 60000