Spot Algo

Endpoint

Cancel Spot Algo Order (TRADE)

Cancel an open TWAP order

DELETE

/sapi/v1/algo/spot/order

https://api.binance.com

Cancel Spot Algo Order (TRADE) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Cancel Spot Algo Order (TRADE) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Cancel Spot Algo Order (TRADE) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Cancel Spot Algo Order (TRADE) › Query Parameters

algoId

integer · int64 · required

Example: 14511

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Cancel Spot Algo Order (TRADE) › Responses

200

Cancel Algo Order

algoId

integer · int64

Example: 14511

success

boolean

Example: true

code

integer · int64

Example: 0

msg

string

Example: OK

Query Current Spot Algo Open Orders (USER_DATA)

Get all open SPOT TWAP orders

GET

/sapi/v1/algo/spot/openOrders

https://api.binance.com

Query Current Spot Algo Open Orders (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Query Current Spot Algo Open Orders (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Query Current Spot Algo Open Orders (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Query Current Spot Algo Open Orders (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Query Current Spot Algo Open Orders (USER_DATA) › Responses

200

Current Algo Open Orders

total

integer · int64

Example: 1

object[]

algoId

integer · int64

Algo order ID

Example: 14517

symbol

string

Trading symbol

Example: ETHUSDT

side

string

Trading side

Example: SELL

totalQty

string

Total order quantity

Example: 5.000

executedQty

string

Executed quantity

Example: 0.000

executedAmt

string

Executed amount

Example: 0.00000000

avgPrice

string

Average execution price

Example: 0.00

clientAlgoId

string

Client-defined algo order ID

Example: d7096549481642f8a0bb69e9e2e31f2e

bookTime

integer · int64

Order creation time

Example: 1649756817004

endTime

integer · int64

End time

Example: 0

algoStatus

string

Algo order status

Example: WORKING

algoType

string

Algo order type

Example: VP

urgency

string

Execution urgency

Example: LOW

Query Historical Spot Algo Orders (USER_DATA)

Get all historical SPOT TWAP orders

GET

/sapi/v1/algo/spot/historicalOrders

https://api.binance.com

Query Historical Spot Algo Orders (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Query Historical Spot Algo Orders (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Query Historical Spot Algo Orders (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Query Historical Spot Algo Orders (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

symbol

string

Trading symbol

Example: BTCUSDT

side

string · enum

Enum values:

BUY

SELL

Example: BUY

startTime

integer · int64

in milliseconds eg.1641522717552

Example: 1623319461670

endTime

integer · int64

in milliseconds eg.1641522526562

Example: 1641782889000

page

integer · int64

Page number

Example: 1

Default: 1

pageSize

integer · int64 · min: 1 · max: 100

Records per page

Example: 10

Default: 100

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Query Historical Spot Algo Orders (USER_DATA) › Responses

200

Historical Algo Orders

total

integer · int64

Example: 1

object[]

algoId

integer · int64

Algo order ID

Example: 14518

symbol

string

Trading symbol

Example: BNBUSDT

side

string

Trading side

Example: BUY

totalQty

string

Total order quantity

Example: 100.00

executedQty

string

Executed quantity

Example: 0.00

executedAmt

string

Executed amount

Example: 0.00000000

avgPrice

string

Average execution price

Example: 0.000

clientAlgoId

string

Client-defined algo order ID

Example: acacab56b3c44bef9f6a8f8ebd2a8408

bookTime

integer · int64

Order creation time

Example: 1649757019503

endTime

integer · int64

End time

Example: 1649757088101

algoStatus

string

Algo order status

Example: CANCELLED

algoType

string

Algo order type

Example: VP

urgency

string

Execution urgency

Example: LOW

Query Spot Sub Orders (USER_DATA)

Get respective sub orders for a specified algoId

GET

/sapi/v1/algo/spot/subOrders

https://api.binance.com

Query Spot Sub Orders (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Query Spot Sub Orders (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Query Spot Sub Orders (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Query Spot Sub Orders (USER_DATA) › Query Parameters

algoId

integer · int64 · required

eg. 14511

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

page

integer · int64

Page number

Example: 1

Default: 1

pageSize

integer · int64 · min: 1 · max: 100

Records per page

Example: 10

Default: 100

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Query Spot Sub Orders (USER_DATA) › Responses

200

Sub Orders

total

integer · int64

Example: 1

executedQty

string

Example: 1.000

executedAmt

string

Example: 3229.44000000

object[]

algoId

integer · int64

Algo order ID

Example: 13723

orderId

integer · int64

Sub-order ID

Example: 8389765519993909000

orderStatus

string

Sub-order status

Example: FILLED

executedQty

string

Executed quantity

Example: 1.000

executedAmt

string

Executed amount

Example: 3229.44000000

feeAmt

string

Fee amount

Example: -1.61471999

feeAsset

string

Fee asset

Example: USDT

bookTime

integer · int64

Order creation time

Example: 1649319001964

avgPrice

string

Average execution price

Example: 3229.44

side

string

Trading side

Example: SELL

symbol

string

Trading symbol

Example: ETHUSDT

subId

integer · int64

Sub-order execution sequence ID

Example: 1

timeInForce

string

Time in force

Example: IMMEDIATE_OR_CANCEL

origQty

string

Original order quantity

Example: 1.000

Time-Weighted Spot Average Price(Twap) New Order (TRADE)

Place a new spot TWAP order with Algo service.

POST

/sapi/v1/algo/spot/newOrderTwap

https://api.binance.com

Time-Weighted Spot Average Price(Twap) New Order (TRADE) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Time-Weighted Spot Average Price(Twap) New Order (TRADE) › Request Weight

This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.

Learn more in the Rate limits section.

Account Weight3000

Time-Weighted Spot Average Price(Twap) New Order (TRADE) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Time-Weighted Spot Average Price(Twap) New Order (TRADE) › Request Body

symbol

string · required

Trading symbol eg. BTCUSDT

Example: BTCUSDT

side

string · enum · required

Trading side ( BUY or SELL )

Enum values:

BUY

SELL

Example: BUY

quantity

number · float · required

Quantity of base asset; Maximum notional per order is 200k, 2mm or 10mm, depending on symbol. Please reduce your size if you order is above the maximum notional per order.

Example: 1

duration

integer · int64 · min: 300 · max: 86400 · required

Duration for TWAP orders in seconds

Example: 5000

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

clientAlgoId

string · minLength: 32 · maxLength: 32

A unique id among Algo orders (length should be 32 characters)， If it is not sent, we will give default value

Example: 1

limitPrice

number · float

Limit price of the order; If it is not sent, will place order by market price by default

Example: 1

Time-Weighted Spot Average Price(Twap) New Order (TRADE) › Responses

200

Time-Weighted Average Price

clientAlgoId

string

Example: 65ce1630101a480b85915d7e11fd5078

success

boolean

Example: true

code

integer · int64

Example: 0

msg

string

Example: OK

Spot Algo

Endpoint

Download schema

Cancel Spot Algo Order (TRADE)

Cancel an open TWAP order

DELETE

/sapi/v1/algo/spot/order

https://api.binance.com

Cancel Spot Algo Order (TRADE) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Cancel Spot Algo Order (TRADE) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Cancel Spot Algo Order (TRADE) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Cancel Spot Algo Order (TRADE) › Query Parameters

algoId

integer · int64 · required

Example: 14511

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Cancel Spot Algo Order (TRADE) › Responses

200

Cancel Algo Order

algoId

integer · int64

Example: 14511

success

boolean

Example: true

code

integer · int64

Example: 0

msg

string

Example: OK

Query Current Spot Algo Open Orders (USER_DATA)

Get all open SPOT TWAP orders

GET

/sapi/v1/algo/spot/openOrders

https://api.binance.com

Query Current Spot Algo Open Orders (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Query Current Spot Algo Open Orders (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Query Current Spot Algo Open Orders (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Query Current Spot Algo Open Orders (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Query Current Spot Algo Open Orders (USER_DATA) › Responses

200

Current Algo Open Orders

total

integer · int64

Example: 1

object[]

algoId

integer · int64

Algo order ID

Example: 14517

symbol

string

Trading symbol

Example: ETHUSDT

side

string

Trading side

Example: SELL

totalQty

string

Total order quantity

Example: 5.000

executedQty

string

Executed quantity

Example: 0.000

executedAmt

string

Executed amount

Example: 0.00000000

avgPrice

string

Average execution price

Example: 0.00

clientAlgoId

string

Client-defined algo order ID

Example: d7096549481642f8a0bb69e9e2e31f2e

bookTime

integer · int64

Order creation time

Example: 1649756817004

endTime

integer · int64

End time

Example: 0

algoStatus

string

Algo order status

Example: WORKING

algoType

string

Algo order type

Example: VP

urgency

string

Execution urgency

Example: LOW

Query Historical Spot Algo Orders (USER_DATA)

Get all historical SPOT TWAP orders

GET

/sapi/v1/algo/spot/historicalOrders

https://api.binance.com

Query Historical Spot Algo Orders (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Query Historical Spot Algo Orders (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Query Historical Spot Algo Orders (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Query Historical Spot Algo Orders (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

symbol

string

Trading symbol

Example: BTCUSDT

side

string · enum

Enum values:

BUY

SELL

Example: BUY

startTime

integer · int64

in milliseconds eg.1641522717552

Example: 1623319461670

endTime

integer · int64

in milliseconds eg.1641522526562

Example: 1641782889000

page

integer · int64

Page number

Example: 1

Default: 1

pageSize

integer · int64 · min: 1 · max: 100

Records per page

Example: 10

Default: 100

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Query Historical Spot Algo Orders (USER_DATA) › Responses

200

Historical Algo Orders

total

integer · int64

Example: 1

object[]

algoId

integer · int64

Algo order ID

Example: 14518

symbol

string

Trading symbol

Example: BNBUSDT

side

string

Trading side

Example: BUY

totalQty

string

Total order quantity

Example: 100.00

executedQty

string

Executed quantity

Example: 0.00

executedAmt

string

Executed amount

Example: 0.00000000

avgPrice

string

Average execution price

Example: 0.000

clientAlgoId

string

Client-defined algo order ID

Example: acacab56b3c44bef9f6a8f8ebd2a8408

bookTime

integer · int64

Order creation time

Example: 1649757019503

endTime

integer · int64

End time

Example: 1649757088101

algoStatus

string

Algo order status

Example: CANCELLED

algoType

string

Algo order type

Example: VP

urgency

string

Execution urgency

Example: LOW

Query Spot Sub Orders (USER_DATA)

Get respective sub orders for a specified algoId

GET

/sapi/v1/algo/spot/subOrders

https://api.binance.com

Query Spot Sub Orders (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Query Spot Sub Orders (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Query Spot Sub Orders (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Query Spot Sub Orders (USER_DATA) › Query Parameters

algoId

integer · int64 · required

eg. 14511

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

page

integer · int64

Page number

Example: 1

Default: 1

pageSize

integer · int64 · min: 1 · max: 100

Records per page

Example: 10

Default: 100

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds

Example: 5000

Query Spot Sub Orders (USER_DATA) › Responses

200

Sub Orders

total

integer · int64

Example: 1

executedQty

string

Example: 1.000

executedAmt

string

Example: 3229.44000000

object[]

algoId

integer · int64

Algo order ID

Example: 13723

orderId

integer · int64

Sub-order ID

Example: 8389765519993909000

orderStatus

string

Sub-order status

Example: FILLED

executedQty

string

Executed quantity

Example: 1.000

executedAmt

string

Executed amount

Example: 3229.44000000

feeAmt

string

Fee amount

Example: -1.61471999

feeAsset

string

Fee asset

Example: USDT

bookTime

integer · int64

Order creation time

Example: 1649319001964

avgPrice

string

Average execution price

Example: 3229.44

side

string

Trading side

Example: SELL

symbol

string

Trading symbol

Example: ETHUSDT

subId

integer · int64

Sub-order execution sequence ID

Example: 1

timeInForce

string

Time in force

Example: IMMEDIATE_OR_CANCEL

origQty

string

Original order quantity

Example: 1.000

Time-Weighted Spot Average Price(Twap) New Order (TRADE)

Place a new spot TWAP order with Algo service.

POST

/sapi/v1/algo/spot/newOrderTwap

https://api.binance.com

Time-Weighted Spot Average Price(Twap) New Order (TRADE) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Time-Weighted Spot Average Price(Twap) New Order (TRADE) › Request Weight

This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.

Learn more in the Rate limits section.

Account Weight3000

Time-Weighted Spot Average Price(Twap) New Order (TRADE) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Time-Weighted Spot Average Price(Twap) New Order (TRADE) › Request Body

symbol

string · required

Trading symbol eg. BTCUSDT

Example: BTCUSDT

side

string · enum · required

Trading side ( BUY or SELL )

Enum values:

BUY

SELL

Example: BUY

quantity

number · float · required

Quantity of base asset; Maximum notional per order is 200k, 2mm or 10mm, depending on symbol. Please reduce your size if you order is above the maximum notional per order.

Example: 1

duration

integer · int64 · min: 300 · max: 86400 · required

Duration for TWAP orders in seconds

Example: 5000

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

clientAlgoId

string · minLength: 32 · maxLength: 32

A unique id among Algo orders (length should be 32 characters)， If it is not sent, we will give default value

Example: 1

limitPrice

number · float

Limit price of the order; If it is not sent, will place order by market price by default

Example: 1

Time-Weighted Spot Average Price(Twap) New Order (TRADE) › Responses

200

Time-Weighted Average Price

clientAlgoId

string

Example: 65ce1630101a480b85915d7e11fd5078

success

boolean

Example: true

code

integer · int64

Example: 0

msg

string

Example: OK