Trade

Endpoint

Change Multi-Assets Mode (TRADE)

Change user's Multi-Assets mode (Multi-Assets Mode or Single-Asset Mode) on Every symbol

POST

/fapi/v1/multiAssetsMargin

https://fapi.binance.com

Change Multi-Assets Mode (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

Change Multi-Assets Mode (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

Change Multi-Assets Mode (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

Change Multi-Assets Mode (TRADE) › Request Body

multiAssetsMargin

string · required

"true": Multi-Assets Mode; "false": Single-Asset Mode

Example: true

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

Example: 5000

Change Multi-Assets Mode (TRADE) › Responses

200

Change Multi-Assets Mode

code

integer · int64

Example: 200

msg

string

Example: success

POST/fapi/v1/multiAssetsMargin

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/multiAssetsMargin \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data multiAssetsMargin=true \
  --data timestamp=1770736694138

Example Request Body

{
  "multiAssetsMargin": "true",
  "timestamp": 1770736694138
}

Example Responses

{
  "code": 200,
  "msg": "success"
}

application/json

Change Position Mode (TRADE)

Change user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol.

After CM migration, UM and CM share the same dualSidePosition setting. Calling this endpoint flips both UM and CM at once. If either side has any open order or open position, the change is rejected:

-4067 (open orders exist)
-4068 (open position exists)

POST

/fapi/v1/positionSide/dual

https://fapi.binance.com

Change Position Mode (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

Change Position Mode (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

Change Position Mode (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

Change Position Mode (TRADE) › Request Body

dualSidePosition

string · required

"true": Hedge Mode; "false": One-way Mode

Example: true

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

Example: 5000

Change Position Mode (TRADE) › Responses

200

Change Position Mode

code

integer · int64

Example: 200

msg

string

Example: success

POST/fapi/v1/positionSide/dual

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/positionSide/dual \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data dualSidePosition=true \
  --data timestamp=1770736694138

Example Request Body

{
  "dualSidePosition": "true",
  "timestamp": 1770736694138
}

Example Responses

{
  "code": 200,
  "msg": "success"
}

application/json

Account Trade List (USER_DATA)

Get trades for a specific account and symbol.

GET

/fapi/v1/userTrades

https://fapi.binance.com

Account Trade List (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

Account Trade List (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 Weight5

Account Trade List (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

Account Trade List (USER_DATA) › Query Parameters

symbol

string · required

Example: BTCUSDT

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

orderId

integer · int64

Must be used together with parameter symbol.

Example: 25851813

startTime

integer · int64

Start time

Example: 1623319461670

endTime

integer · int64

End time

Example: 1641782889000

fromId

integer · int64

Trade id to fetch from. Default gets most recent trades.

Example: 1

limit

integer · int64 · max: 1000

Example: 50

Default: 500

recvWindow

integer · int64 · max: 60000

Example: 5000

Account Trade List (USER_DATA) › Responses

200

Account Trade List

object

buyer

boolean

Buyer.

Example: false

commission

string

Commission.

Example: 0.07819010

commissionAsset

string

Commission Asset.

Example: USDT

id

integer · int64

Id.

Example: 698759

maker

boolean

Maker.

Example: false

orderId

integer · int64

Order Id.

Example: 25851813

price

string

Price.

Example: 7819.01

qty

string

Qty.

Example: 0.002

quoteQty

string

Quote Qty.

Example: 15.63802

realizedPnl

string

Realized Pnl.

Example: -0.91539999

side

string

Side.

Example: SELL

positionSide

string

Position Side.

Example: SHORT

symbol

string

Symbol.

Example: BTCUSDT

time

integer · int64

Time.

Example: 1569514978020

GET/fapi/v1/userTrades

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/userTrades?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "buyer": false,
    "commission": "0.07819010",
    "commissionAsset": "USDT",
    "id": 698759,
    "maker": false,
    "orderId": 25851813,
    "price": "7819.01",
    "qty": "0.002",
    "quoteQty": "15.63802",
    "realizedPnl": "-0.91539999",
    "side": "SELL",
    "positionSide": "SHORT",
    "symbol": "BTCUSDT",
    "time": 1569514978020
  }
]

application/json

All Orders (USER_DATA)

Get all account orders; active, canceled, or filled.

These orders will not be found:
- order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time
- order create time + 90 days < current time

GET

/fapi/v1/allOrders

https://fapi.binance.com

All 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

All 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 Weight5

All 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

All Orders (USER_DATA) › Query Parameters

symbol

string · required

Example: BTCUSDT

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

orderId

integer · int64

Example: 1917641

startTime

integer · int64

Start time

Example: 1623319461670

endTime

integer · int64

End time

Example: 1641782889000

limit

integer · int64 · max: 1000

Example: 50

Default: 500

recvWindow

integer · int64 · max: 60000

Example: 5000

All Orders (USER_DATA) › Responses

200

All Orders

object

avgPrice

string

Avg Price.

Example: 0.00000

clientOrderId

string

Client Order Id.

Example: abc

cumQuote

string

Cum Quote.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Order Id.

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: TRAILING_STOP_MARKET

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

Position Side.

Example: SHORT

status

string

Status.

Example: NEW

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

closePosition

boolean

if Close-All

Example: false

symbol

string

Symbol.

Example: BTCUSDT

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Type.

Example: TRAILING_STOP_MARKET

activatePrice

string

activation price, only return with TRAILING_STOP_MARKET order

Example: 9020

priceRate

string

callback rate, only return with TRAILING_STOP_MARKET order

Example: 0.3

updateTime

integer · int64

update time

Example: 1579276756075

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

if conditional order trigger is protected

Example: false

priceMatch

string

price match mode

Example: NONE

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

GET/fapi/v1/allOrders

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/allOrders?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "avgPrice": "0.00000",
    "clientOrderId": "abc",
    "cumQuote": "0",
    "executedQty": "0",
    "orderId": 1917641,
    "origQty": "0.40",
    "origType": "TRAILING_STOP_MARKET",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "status": "NEW",
    "stopPrice": "9300",
    "closePosition": false,
    "symbol": "BTCUSDT",
    "time": 1579276756075,
    "timeInForce": "GTC",
    "type": "TRAILING_STOP_MARKET",
    "activatePrice": "9020",
    "priceRate": "0.3",
    "updateTime": 1579276756075,
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "priceMatch": "NONE",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0
  }
]

application/json

Auto-Cancel All Open Orders (TRADE)

Cancel all open orders of the specified symbol at the end of the specified countdown.

The endpoint should be called repeatedly as heartbeats so that the existing countdown time can be canceled and replaced by a new one.

Example usage:

Call this endpoint at 30s intervals with an countdownTime of 120000 (120s). If this endpoint is not called within 120 seconds, all your orders of the specified symbol will be automatically canceled. If this endpoint is called with an countdownTime of 0, the countdown timer will be stopped.

The system will check all countdowns approximately every 10 milliseconds, so please note that sufficient redundancy should be considered when using this function. We do not recommend setting the countdown time to be too precise or too small.

POST

/fapi/v1/countdownCancelAll

https://fapi.binance.com

Auto-Cancel All Open Orders (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

Auto-Cancel All Open Orders (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 Weight10

Auto-Cancel All Open Orders (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

Auto-Cancel All Open Orders (TRADE) › Request Body

symbol

string · required

Example: BTCUSDT

countdownTime

integer · int64 · required

Countdown in milliseconds. 1000 means 1 second; 0 disables countdown cancel-all.

Example: 1000

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

Example: 5000

Auto-Cancel All Open Orders (TRADE) › Responses

200

Auto-Cancel All Open Orders

symbol

string

Example: BTCUSDT

countdownTime

string

Example: 100000

POST/fapi/v1/countdownCancelAll

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/countdownCancelAll \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data symbol=BTCUSDT \
  --data countdownTime=1000 \
  --data timestamp=1770736694138

Example Request Body

{
  "symbol": "BTCUSDT",
  "countdownTime": 1000,
  "timestamp": 1770736694138
}

Example Responses

{
  "symbol": "BTCUSDT",
  "countdownTime": "100000"
}

application/json

Query Algo Order (USER_DATA)

Check the status of an algo (conditional) order, such as TP/SL (Take Profit / Stop Loss) or trailing stop orders on USD-M Futures.

These orders will not be found:
- order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time
- order create time + 90 days < current time

GET

/fapi/v1/algoOrder

https://fapi.binance.com

Query Algo Order (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 Algo Order (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 Algo Order (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 Algo Order (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

algoId

integer · int64

Order ID

Example: 1

clientAlgoId

string

Client order ID

Example: 1

recvWindow

integer · int64

Example: 5000

Query Algo Order (USER_DATA) › Responses

200

Algo Order

algoId

integer · int64

Example: 2146760

clientAlgoId

string

Example: 6B2I9XVcJpCjqPAJ4YoFX7

algoType

string

Example: CONDITIONAL

orderType

string

Example: TAKE_PROFIT

symbol

string

Example: BNBUSDT

side

string

Example: SELL

positionSide

string

Example: BOTH

timeInForce

string

Example: GTC

quantity

string

Example: 0.01

algoStatus

string

Example: CANCELED

actualOrderId

string

Empty string if not triggered; orderId if triggered.

Example:

actualPrice

string

0 if not triggered; average price if filled/partially filled.

Example: 0.00000

actualType

string

Optional field, only present when triggered.

Example: LIMIT

actualQty

string

Optional field, only present when filled/partially filled.

Example: 0.01

triggerPrice

string

Example: 750.000

price

string

Example: 750.000

icebergQuantity

string

Example: null

tpOrderType

string

Example:

selfTradePreventionMode

string

Example: EXPIRE_MAKER

workingType

string

Example: CONTRACT_PRICE

priceMatch

string

Example: NONE

closePosition

boolean

Example: false

priceProtect

boolean

Example: false

reduceOnly

boolean

Example: false

createTime

integer · int64

Example: 1750485492076

updateTime

integer · int64

Example: 1750514545091

triggerTime

integer · int64

Example: 0

goodTillDate

integer · int64

Example: 0

GET/fapi/v1/algoOrder

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/algoOrder?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "algoId": 2146760,
  "clientAlgoId": "6B2I9XVcJpCjqPAJ4YoFX7",
  "algoType": "CONDITIONAL",
  "orderType": "TAKE_PROFIT",
  "symbol": "BNBUSDT",
  "side": "SELL",
  "positionSide": "BOTH",
  "timeInForce": "GTC",
  "quantity": "0.01",
  "algoStatus": "CANCELED",
  "actualOrderId": "",
  "actualPrice": "0.00000",
  "actualType": "LIMIT",
  "actualQty": "0.01",
  "triggerPrice": "750.000",
  "price": "750.000",
  "icebergQuantity": "null",
  "tpOrderType": "",
  "selfTradePreventionMode": "EXPIRE_MAKER",
  "workingType": "CONTRACT_PRICE",
  "priceMatch": "NONE",
  "closePosition": false,
  "priceProtect": false,
  "reduceOnly": false,
  "createTime": 1750485492076,
  "updateTime": 1750514545091,
  "triggerTime": 0,
  "goodTillDate": 0
}

application/json

New Algo Order (TRADE)

Send in a new algo (conditional) order. Use this endpoint to place TP/SL (Take Profit / Stop Loss) and trailing stop orders on USD-M Futures. Supported order types under algoType=CONDITIONAL are STOP_MARKET, TAKE_PROFIT_MARKET, STOP, TAKE_PROFIT, and TRAILING_STOP_MARKET.

POST

/fapi/v1/algoOrder

https://fapi.binance.com

New 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

New 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 Weight

1 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); 0 on IP rate limit(x-mbx-used-weight-1m)

New 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

New Algo Order (TRADE) › Request Body

algoType

string · enum · required

Enum values:

CONDITIONAL

Example: CONDITIONAL

symbol

string · required

Example: BNBUSDT

side

string · enum · required

Enum values:

BUY

SELL

Example: BUY

type

string · enum · required

Enum values:

LIMIT

MARKET

STOP

STOP_MARKET

TAKE_PROFIT

TAKE_PROFIT_MARKET

TRAILING_STOP_MARKET

Example: STOP_MARKET

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

positionSide

string

Default BOTH for One-way Mode ; LONG or SHORT for Hedge Mode. It must be sent in Hedge Mode.

Example: BOTH

timeInForce

string · enum

Enum values:

GTC

IOC

FOK

GTX

GTD

RPI

Example: GTC

quantity

number · float

Cannot be sent with closePosition=true(Close-All)

Example: 1.0

price

number · float

Example: 1.0

triggerPrice

number · float

Trigger price

Example: 1.0

workingType

string · enum

Enum values:

MARK_PRICE

CONTRACT_PRICE

Example: MARK_PRICE

Default: CONTRACT_PRICE

priceMatch

string · enum

only avaliable for LIMIT/STOP/TAKE_PROFIT order; Can't be passed together with price

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

closePosition

string · enum

Close-All，used with STOP_MARKET or TAKE_PROFIT_MARKET.

Enum values:

true

false

Example: true

priceProtect

string · enum

Used with STOP_MARKET or TAKE_PROFIT_MARKET order. when price reaches the triggerPrice ，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the Price Protection Threshold of the symbol.'

Enum values:

true

false

Example: true

Default: false

reduceOnly

string · enum

Cannot be sent in Hedge Mode; cannot be sent with closePosition=true'

Enum values:

true

false

Example: true

Default: false

activatePrice

number · float

Used with TRAILING_STOP_MARKET orders, default as the latest price(supporting different workingType)

Example: 1.0

callbackRate

number · float · min: 0.1 · max: 10

Used with TRAILING_STOP_MARKET orders

Example: 1

clientAlgoId

string

A unique id among open orders. Automatically generated if not sent. Can only be string following the rule: ^[\.A-Z\:/a-z0-9_-]{1,36}$

Example: 1

newOrderRespType

string · enum

Enum values:

ACK

RESULT

Example: ACK

Default: ACK

selfTradePreventionMode

string · enum

EXPIRE_TAKER taker order when STP triggers / EXPIRE_MAKER taker order when STP triggers/ EXPIRE_BOTH both orders when STP triggers; default NONE

Enum values:

NONE

EXPIRE_TAKER

EXPIRE_BOTH

EXPIRE_MAKER

Example: EXPIRE_TAKER

Default: NONE

goodTillDate

integer · int64

order cancel time for timeInForce GTD, mandatory when timeInforce set to GTD; order the timestamp only retains second-level precision, ms part will be ignored; The goodTillDate timestamp must be greater than the current time plus 600 seconds and smaller than 253402300799000

Example: 1770736694138

recvWindow

integer · int64

Example: 5000

New Algo Order (TRADE) › Responses

200

New Algo Order

algoId

integer · int64

Example: 2146760

clientAlgoId

string

Example: 6B2I9XVcJpCjqPAJ4YoFX7

algoType

string

Example: CONDITIONAL

orderType

string

Example: TAKE_PROFIT

symbol

string

Example: BNBUSDT

side

string

Example: SELL

positionSide

string

Example: BOTH

timeInForce

string

Example: GTC

quantity

string

Example: 0.01

algoStatus

string

Example: NEW

triggerPrice

string

Example: 750.000

price

string

Example: 750.000

icebergQuantity

string

Example: null

selfTradePreventionMode

string

Example: EXPIRE_MAKER

workingType

string

Example: CONTRACT_PRICE

priceMatch

string

Example: NONE

closePosition

boolean

Example: false

priceProtect

boolean

Example: false

reduceOnly

boolean

Example: false

activatePrice

string

TRAILING_STOP_MARKET order

Example:

callbackRate

string

TRAILING_STOP_MARKET order

Example:

createTime

integer · int64

Example: 1750485492076

updateTime

integer · int64

Example: 1750485492076

triggerTime

integer · int64

Example: 0

goodTillDate

integer · int64

Example: 0

POST/fapi/v1/algoOrder

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/algoOrder \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data algoType=CONDITIONAL \
  --data symbol=BNBUSDT \
  --data side=BUY \
  --data type=STOP_MARKET \
  --data timestamp=1770736694138

Example Request Body

{
  "algoType": "CONDITIONAL",
  "symbol": "BNBUSDT",
  "side": "BUY",
  "type": "STOP_MARKET",
  "timestamp": 1770736694138
}

Example Responses

{
  "algoId": 2146760,
  "clientAlgoId": "6B2I9XVcJpCjqPAJ4YoFX7",
  "algoType": "CONDITIONAL",
  "orderType": "TAKE_PROFIT",
  "symbol": "BNBUSDT",
  "side": "SELL",
  "positionSide": "BOTH",
  "timeInForce": "GTC",
  "quantity": "0.01",
  "algoStatus": "NEW",
  "triggerPrice": "750.000",
  "price": "750.000",
  "icebergQuantity": "null",
  "selfTradePreventionMode": "EXPIRE_MAKER",
  "workingType": "CONTRACT_PRICE",
  "priceMatch": "NONE",
  "closePosition": false,
  "priceProtect": false,
  "reduceOnly": false,
  "activatePrice": "",
  "callbackRate": "",
  "createTime": 1750485492076,
  "updateTime": 1750485492076,
  "triggerTime": 0,
  "goodTillDate": 0
}

application/json

Cancel Algo Order (TRADE)

Cancel an active algo (conditional) order, including TP/SL (Take Profit / Stop Loss) and trailing stop orders on USD-M Futures.

DELETE

/fapi/v1/algoOrder

https://fapi.binance.com

Cancel 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 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 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 Algo Order (TRADE) › 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

algoId

integer · int64

Example: 2146760

clientAlgoId

string

Example: 6B2I9XVcJpCjqPAJ4YoFX7

recvWindow

integer · int64 · max: 60000

Example: 5000

Cancel Algo Order (TRADE) › Responses

200

Cancel Algo Order

algoId

integer · int64

Example: 2146760

clientAlgoId

string

Example: 6B2I9XVcJpCjqPAJ4YoFX7

code

string

Example: 200

msg

string

Example: success

DELETE/fapi/v1/algoOrder

curl --request DELETE \
  --url 'https://fapi.binance.com/fapi/v1/algoOrder?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "algoId": 2146760,
  "clientAlgoId": "6B2I9XVcJpCjqPAJ4YoFX7",
  "code": "200",
  "msg": "success"
}

application/json

Cancel All Algo Open Orders (TRADE)

Cancel all open algo (conditional) orders on a symbol, including TP/SL (Take Profit / Stop Loss) and trailing stop orders on USD-M Futures.

DELETE

/fapi/v1/algoOpenOrders

https://fapi.binance.com

Cancel All Algo Open Orders (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 All Algo Open Orders (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 All Algo Open Orders (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 All Algo Open Orders (TRADE) › Query Parameters

symbol

string · required

Example: BTCUSDT

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

Example: 5000

Cancel All Algo Open Orders (TRADE) › Responses

200

Cancel All Algo Open Orders

code

integer · int64

Example: 200

msg

string

Example: The operation of cancel all open order is done.

DELETE/fapi/v1/algoOpenOrders

curl --request DELETE \
  --url 'https://fapi.binance.com/fapi/v1/algoOpenOrders?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "code": 200,
  "msg": "The operation of cancel all open order is done."
}

application/json

Cancel All Open Orders (TRADE)

Cancel All Open Orders

DELETE

/fapi/v1/allOpenOrders

https://fapi.binance.com

Cancel All Open Orders (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 All Open Orders (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 All Open Orders (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 All Open Orders (TRADE) › Query Parameters

symbol

string · required

Example: BTCUSDT

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

Example: 5000

Cancel All Open Orders (TRADE) › Responses

200

Cancel All Open Orders

code

integer · int64

Example: 200

msg

string

Example: The operation of cancel all open order is done.

DELETE/fapi/v1/allOpenOrders

curl --request DELETE \
  --url 'https://fapi.binance.com/fapi/v1/allOpenOrders?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "code": 200,
  "msg": "The operation of cancel all open order is done."
}

application/json

Modify Multiple Orders (TRADE)

PUT

/fapi/v1/batchOrders

https://fapi.binance.com

Modify Multiple Orders (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

Modify Multiple Orders (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 Weight

5 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); 5 on IP rate limit(x-mbx-used-weight-1m);

Modify Multiple Orders (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

Modify Multiple Orders (TRADE) › Request Body

object[] · required

order list. Max 5 orders

Example: []

orderId

integer · int64

Example: 20072994037

origClientOrderId

string

Example: LJ9R4QZDihCaS8UAOOLpgW

symbol

string

Example: BTCUSDT

side

string · enum

Enum values:

BUY

SELL

Example: BUY

quantity

number · float

Order quantity, cannot be sent with closePosition=true

Example: 1

price

number · float

Example: 30005

priceMatch

string · enum

Only avaliable for LIMIT/STOP/TAKE_PROFIT order; Cannot be sent together with price.

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

stopPrice

number · float

stop price, only STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET need

Example: 0

recvWindow

integer · int64 · max: 60000

Validity window in milliseconds.

Example: 5000

timestamp

integer · int64

Unix timestamp in milliseconds.

Example: 1770736694138

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

Example: 5000

Modify Multiple Orders (TRADE) › Responses

200

Modify Multiple Orders

object

orderId

integer · int64

Example: 20072994037

symbol

string

Example: BTCUSDT

pair

string

Example: BTCUSDT

status

string

Example: NEW

clientOrderId

string

Example: LJ9R4QZDihCaS8UAOOLpgW

price

string

Example: 30005

origQty

string

Example: 1

executedQty

string

Example: 0

cumQty

string

Example: 0

timeInForce

string

Example: GTC

type

string

Example: LIMIT

reduceOnly

boolean

Example: false

closePosition

boolean

Example: false

side

string

Example: BUY

positionSide

string

Example: LONG

stopPrice

string

Example: 0

workingType

string

Example: CONTRACT_PRICE

priceProtect

boolean

Example: false

origType

string

Example: LIMIT

priceMatch

string

price match mode

Example: NONE

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

updateTime

integer · int64

Example: 1629182711600

code

integer · int64

Example: -2022

msg

string

Example: ReduceOnly Order is rejected.

PUT/fapi/v1/batchOrders

curl --request PUT \
  --url https://fapi.binance.com/fapi/v1/batchOrders \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data timestamp=1770736694138

Example Request Body

{
  "batchOrders": [],
  "timestamp": 1770736694138
}

Example Responses

[
  {
    "orderId": 20072994037,
    "symbol": "BTCUSDT",
    "pair": "BTCUSDT",
    "status": "NEW",
    "clientOrderId": "LJ9R4QZDihCaS8UAOOLpgW",
    "price": "30005",
    "origQty": "1",
    "executedQty": "0",
    "cumQty": "0",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "reduceOnly": false,
    "closePosition": false,
    "side": "BUY",
    "positionSide": "LONG",
    "stopPrice": "0",
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "origType": "LIMIT",
    "priceMatch": "NONE",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0,
    "updateTime": 1629182711600,
    "code": -2022,
    "msg": "ReduceOnly Order is rejected."
  }
]

application/json

Place Multiple Orders (TRADE)

Place Multiple Orders

POST

/fapi/v1/batchOrders

https://fapi.binance.com

Place Multiple Orders (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

Place Multiple Orders (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 Weight

5 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); 5 on IP rate limit(x-mbx-used-weight-1m);

Place Multiple Orders (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

Place Multiple Orders (TRADE) › Request Body

object[] · required

order list. Max 5 orders

Example: []

symbol

string

Example: BTCUSDT

side

string · enum

Enum values:

BUY

SELL

Example: BUY

positionSide

string · enum

Default BOTH for One-way Mode; LONG or SHORT for Hedge Mode.

Enum values:

BOTH

LONG

SHORT

Example: BOTH

type

string · enum

Enum values:

LIMIT

MARKET

STOP

STOP_MARKET

TAKE_PROFIT

TAKE_PROFIT_MARKET

TRAILING_STOP_MARKET

Example: LIMIT

timeInForce

string · enum

Enum values:

GTC

IOC

FOK

GTX

GTD

RPI

Example: GTC

quantity

number · float

Example: 0.001

reduceOnly

string · enum

Enum values:

true

false

Example: false

Default: false

price

number · float

Example: 10001

newClientOrderId

string

Example: 1

newOrderRespType

string · enum

Enum values:

ACK

RESULT

Example: ACK

Default: ACK

priceMatch

string · enum

only avaliable for LIMIT/STOP/TAKE_PROFIT order; Can't be passed together with price

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

selfTradePreventionMode

string · enum

EXPIRE_TAKER taker order when STP triggers/ EXPIRE_MAKER taker order when STP triggers/ EXPIRE_BOTH both orders when STP triggers; default NONE

Enum values:

NONE

EXPIRE_TAKER

EXPIRE_BOTH

EXPIRE_MAKER

Example: NONE

goodTillDate

integer · int64

Auto-cancel time for GTD orders.

Example: 1693207680000

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

Example: 5000

Place Multiple Orders (TRADE) › Responses

200

Place Multiple Orders

object

clientOrderId

string

Client Order Id.

Example: testOrder

cumQty

string

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Order Id.

Example: 22542179

origQty

string

Orig Qty.

Example: 10

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: SELL

positionSide

string

Position Side.

Example: SHORT

status

string

Status.

Example: NEW

stopPrice

string

Example: 0

closePosition

boolean

Close Position.

Example: false

symbol

string

Symbol.

Example: BTCUSDT

timeInForce

string

Time In Force.

Example: GTC

type

string

Type.

Example: TRAILING_STOP_MARKET

origType

string

Orig Type.

Example: TRAILING_STOP_MARKET

updateTime

integer · int64

Update Time.

Example: 1566818724722

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

if conditional order trigger is protected

Example: false

priceMatch

string

price match mode

Example: NONE

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auto cancel time for TIF GTD order

Example: 1693207680000

code

integer · int64

Example: -2022

msg

string

Example: ReduceOnly Order is rejected.

POST/fapi/v1/batchOrders

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/batchOrders \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data timestamp=1770736694138

Example Request Body

{
  "batchOrders": [],
  "timestamp": 1770736694138
}

Example Responses

[
  {
    "clientOrderId": "testOrder",
    "cumQty": "0",
    "executedQty": "0",
    "orderId": 22542179,
    "origQty": "10",
    "price": "0",
    "reduceOnly": false,
    "side": "SELL",
    "positionSide": "SHORT",
    "status": "NEW",
    "stopPrice": "0",
    "closePosition": false,
    "symbol": "BTCUSDT",
    "timeInForce": "GTC",
    "type": "TRAILING_STOP_MARKET",
    "origType": "TRAILING_STOP_MARKET",
    "updateTime": 1566818724722,
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "priceMatch": "NONE",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 1693207680000,
    "code": -2022,
    "msg": "ReduceOnly Order is rejected."
  }
]

application/json

Cancel Multiple Orders (TRADE)

Cancel Multiple Orders

DELETE

/fapi/v1/batchOrders

https://fapi.binance.com

Cancel Multiple Orders (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 Multiple Orders (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 Multiple Orders (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 Multiple Orders (TRADE) › Query Parameters

symbol

string · required

Example: BTCUSDT

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

orderIdList

integer[] · maxLength: 10

Example: [1234567]

origClientOrderIdList

string[] · maxLength: 10

Example: ["my_id_1"]

recvWindow

integer · int64 · max: 60000

Example: 5000

Cancel Multiple Orders (TRADE) › Responses

200

Cancel Multiple Orders

object

clientOrderId

string

Client Order Id.

Example: myOrder1

cumQty

string

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Order Id.

Example: 283194212

origQty

string

Orig Qty.

Example: 11

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

Position Side.

Example: SHORT

status

string

Status.

Example: CANCELED

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

closePosition

boolean

if Close-All

Example: false

symbol

string

Symbol.

Example: BTCUSDT

timeInForce

string

Time In Force.

Example: GTC

origType

string

Orig Type.

Example: TRAILING_STOP_MARKET

type

string

Type.

Example: TRAILING_STOP_MARKET

activatePrice

string

activation price, only return with TRAILING_STOP_MARKET order

Example: 9020

priceRate

string

callback rate, only return with TRAILING_STOP_MARKET order

Example: 0.3

updateTime

integer · int64

Update Time.

Example: 1571110484038

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

if conditional order trigger is protected

Example: false

priceMatch

string

price match mode

Example: NONE

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

code

integer · int64

Example: -2011

msg

string

Example: Unknown order sent.

DELETE/fapi/v1/batchOrders

curl --request DELETE \
  --url 'https://fapi.binance.com/fapi/v1/batchOrders?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "clientOrderId": "myOrder1",
    "cumQty": "0",
    "executedQty": "0",
    "orderId": 283194212,
    "origQty": "11",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "status": "CANCELED",
    "stopPrice": "9300",
    "closePosition": false,
    "symbol": "BTCUSDT",
    "timeInForce": "GTC",
    "origType": "TRAILING_STOP_MARKET",
    "type": "TRAILING_STOP_MARKET",
    "activatePrice": "9020",
    "priceRate": "0.3",
    "updateTime": 1571110484038,
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "priceMatch": "NONE",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0,
    "code": -2011,
    "msg": "Unknown order sent."
  }
]

application/json

Query Order (USER_DATA)

Check an order's status.

These orders will not be found:
- order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time
- order create time + 90 days < current time

GET

/fapi/v1/order

https://fapi.binance.com

Query Order (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 Order (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 Order (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 Order (USER_DATA) › Query Parameters

symbol

string · required

Example: BTCUSDT

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

orderId

integer · int64

Example: 1917641

origClientOrderId

string

Example: abc

recvWindow

integer · int64

Example: 5000

Query Order (USER_DATA) › Responses

200

Order

avgPrice

string

Avg Price.

Example: 0.00000

clientOrderId

string

Client Order Id.

Example: abc

cumQuote

string

Cum Quote.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Order Id.

Example: 1573346959

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: TRAILING_STOP_MARKET

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

Position Side.

Example: SHORT

status

string

Status.

Example: NEW

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

closePosition

boolean

if Close-All

Example: false

symbol

string

Symbol.

Example: BTCUSDT

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Type.

Example: TRAILING_STOP_MARKET

activatePrice

string

activation price, only return with TRAILING_STOP_MARKET order

Example: 9020

priceRate

string

callback rate, only return with TRAILING_STOP_MARKET order

Example: 0.3

updateTime

integer · int64

update time

Example: 1579276756075

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

if conditional order trigger is protected

Example: false

priceMatch

string

Price Match.

Example: NONE

selfTradePreventionMode

string

Self Trade Prevention Mode.

Example: NONE

goodTillDate

integer · int64

Good Till Date.

Example: 0

GET/fapi/v1/order

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/order?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "avgPrice": "0.00000",
  "clientOrderId": "abc",
  "cumQuote": "0",
  "executedQty": "0",
  "orderId": 1573346959,
  "origQty": "0.40",
  "origType": "TRAILING_STOP_MARKET",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "status": "NEW",
  "stopPrice": "9300",
  "closePosition": false,
  "symbol": "BTCUSDT",
  "time": 1579276756075,
  "timeInForce": "GTC",
  "type": "TRAILING_STOP_MARKET",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "updateTime": 1579276756075,
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false,
  "priceMatch": "NONE",
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 0
}

application/json

Modify Order (TRADE)

Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue

PUT

/fapi/v1/order

https://fapi.binance.com

Modify 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

Modify 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 Weight

1 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); 0 on IP rate limit(x-mbx-used-weight-1m)

Modify 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

Modify Order (TRADE) › Request Body

symbol

string · required

Example: BTCUSDT

side

string · enum · required

Enum values:

BUY

SELL

Example: BUY

quantity

number · float · required

Order quantity, cannot be sent with closePosition=true

Example: 1.0

price

number · float · required

Example: 30005

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

orderId

integer · int64

Example: 20072994037

origClientOrderId

string

Example: LJ9R4QZDihCaS8UAOOLpgW

priceMatch

string · enum

only avaliable for LIMIT/STOP/TAKE_PROFIT order; Can't be passed together with price

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

recvWindow

integer · int64 · max: 60000

Example: 5000

Modify Order (TRADE) › Responses

200

Modify Order

orderId

integer · int64

Example: 20072994037

symbol

string

Example: BTCUSDT

pair

string

Example: BTCUSDT

status

string

Example: NEW

clientOrderId

string

Example: LJ9R4QZDihCaS8UAOOLpgW

price

string

Example: 30005

origQty

string

Example: 1

executedQty

string

Example: 0

cumQty

string

Example: 0

timeInForce

string

Example: GTC

type

string

Example: LIMIT

reduceOnly

boolean

Example: false

closePosition

boolean

Example: false

side

string

Example: BUY

positionSide

string

Example: LONG

stopPrice

string

Example: 0

workingType

string

Example: CONTRACT_PRICE

priceProtect

boolean

Example: false

origType

string

Example: LIMIT

priceMatch

string

price match mode

Example: NONE

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

updateTime

integer · int64

Example: 1629182711600

PUT/fapi/v1/order

curl --request PUT \
  --url https://fapi.binance.com/fapi/v1/order \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data symbol=BTCUSDT \
  --data side=BUY \
  --data quantity=1.0 \
  --data price=30005 \
  --data timestamp=1770736694138

Example Request Body

{
  "symbol": "BTCUSDT",
  "side": "BUY",
  "quantity": "1.0",
  "price": 30005,
  "timestamp": 1770736694138
}

Example Responses

{
  "orderId": 20072994037,
  "symbol": "BTCUSDT",
  "pair": "BTCUSDT",
  "status": "NEW",
  "clientOrderId": "LJ9R4QZDihCaS8UAOOLpgW",
  "price": "30005",
  "origQty": "1",
  "executedQty": "0",
  "cumQty": "0",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "reduceOnly": false,
  "closePosition": false,
  "side": "BUY",
  "positionSide": "LONG",
  "stopPrice": "0",
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false,
  "origType": "LIMIT",
  "priceMatch": "NONE",
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 0,
  "updateTime": 1629182711600
}

application/json

New Order (TRADE)

Send in a new order.

POST

/fapi/v1/order

https://fapi.binance.com

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

New 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 Weight

1 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); 0 on IP rate limit(x-mbx-used-weight-1m)

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

New Order (TRADE) › Request Body

symbol

string · required

Example: BTCUSDT

side

string · enum · required

Enum values:

BUY

SELL

Example: BUY

type

string · enum · required

Order type

Enum values:

LIMIT

MARKET

STOP

STOP_MARKET

TAKE_PROFIT

TAKE_PROFIT_MARKET

TRAILING_STOP_MARKET

Example: LIMIT

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

positionSide

string

Default BOTH for One-way Mode ; LONG or SHORT for Hedge Mode. It must be sent in Hedge Mode.

Example: BOTH

timeInForce

string · enum

Enum values:

GTC

IOC

FOK

GTX

GTD

RPI

Example: GTC

reduceOnly

string · enum

Cannot be sent in Hedge Mode

Enum values:

true

false

Example: true

Default: false

quantity

number · float

Example: 1.0

price

number · float

Example: 1.0

newClientOrderId

string

A unique id among open orders. Automatically generated if not sent. Can only be string following the rule: ^[\.A-Z\:/a-z0-9_-]{1,36}$

Example: 1

newOrderRespType

string · enum

Enum values:

ACK

RESULT

Example: ACK

Default: ACK

priceMatch

string · enum

only avaliable for LIMIT/STOP/TAKE_PROFIT order; Can't be passed together with price

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

selfTradePreventionMode

string · enum

EXPIRE_TAKER taker order when STP triggers/ EXPIRE_MAKER taker order when STP triggers/ EXPIRE_BOTH both orders when STP triggers; default EXPIRE_MAKER

Enum values:

EXPIRE_TAKER

EXPIRE_BOTH

EXPIRE_MAKER

Example: EXPIRE_TAKER

goodTillDate

integer · int64

Example: 1770736694138

recvWindow

integer · int64

Example: 5000

Additional mandatory parameters based on type:

Type	Additional mandatory parameters
`LIMIT`	`timeInForce`, `quantity`, `price`
`MARKET`	`quantity`

If newOrderRespType is sent as RESULT:
- MARKET order: the final FILLED result of the order will be returned directly.
- LIMIT order with special timeInForce: the final status result of the order (FILLED or EXPIRED) will be returned directly.
selfTradePreventionMode is only effective when timeInForce is set to IOC, GTC, or GTD.
In extreme market conditions, timeInForce GTD order auto-cancel time might be delayed compared to goodTillDate.

New Order (TRADE) › Responses

200

New Order

clientOrderId

string

Client Order Id.

Example: testOrder

cumQty

string

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Order Id.

Example: 22542179

origQty

string

Orig Qty.

Example: 10

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: SELL

positionSide

string

Position Side.

Example: SHORT

status

string

Status.

Example: NEW

stopPrice

string

ignored for LIMIT / MARKET orders

Example: 0

closePosition

boolean

if Close-All

Example: false

symbol

string

Symbol.

Example: BTCUSDT

timeInForce

string

Time In Force.

Example: GTD

type

string

Type.

Example: LIMIT

origType

string

Orig Type.

Example: LIMIT

updateTime

integer · int64

Update Time.

Example: 1566818724722

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

if conditional order trigger is protected

Example: false

priceMatch

string

price match mode

Example: NONE

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 1693207680000

POST/fapi/v1/order

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/order \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data symbol=BTCUSDT \
  --data side=BUY \
  --data type=LIMIT \
  --data timestamp=1770736694138

Example Request Body

{
  "symbol": "BTCUSDT",
  "side": "BUY",
  "type": "LIMIT",
  "timestamp": 1770736694138
}

Example Responses

{
  "clientOrderId": "testOrder",
  "cumQty": "0",
  "executedQty": "0",
  "orderId": 22542179,
  "origQty": "10",
  "price": "0",
  "reduceOnly": false,
  "side": "SELL",
  "positionSide": "SHORT",
  "status": "NEW",
  "stopPrice": "0",
  "closePosition": false,
  "symbol": "BTCUSDT",
  "timeInForce": "GTD",
  "type": "LIMIT",
  "origType": "LIMIT",
  "updateTime": 1566818724722,
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false,
  "priceMatch": "NONE",
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 1693207680000
}

application/json

Cancel Order (TRADE)

Cancel an active order.

DELETE

/fapi/v1/order

https://fapi.binance.com

Cancel 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 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 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 Order (TRADE) › Query Parameters

symbol

string · required

Example: BTCUSDT

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

orderId

integer · int64

Example: 283194212

origClientOrderId

string

Example: myOrder1

recvWindow

integer · int64 · max: 60000

Example: 5000

Cancel Order (TRADE) › Responses

200

Cancel Order

clientOrderId

string

Client Order Id.

Example: myOrder1

cumQty

string

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Order Id.

Example: 283194212

origQty

string

Orig Qty.

Example: 11

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

Position Side.

Example: SHORT

status

string

Status.

Example: CANCELED

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

closePosition

boolean

if Close-All

Example: false

symbol

string

Symbol.

Example: BTCUSDT

timeInForce

string

Time In Force.

Example: GTC

origType

string

Orig Type.

Example: TRAILING_STOP_MARKET

type

string

Type.

Example: TRAILING_STOP_MARKET

activatePrice

string

activation price, only return with TRAILING_STOP_MARKET order

Example: 9020

priceRate

string

callback rate, only return with TRAILING_STOP_MARKET order

Example: 0.3

updateTime

integer · int64

Update Time.

Example: 1571110484038

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

if conditional order trigger is protected

Example: false

priceMatch

string

price match mode

Example: NONE

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

DELETE/fapi/v1/order

curl --request DELETE \
  --url 'https://fapi.binance.com/fapi/v1/order?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "clientOrderId": "myOrder1",
  "cumQty": "0",
  "executedQty": "0",
  "orderId": 283194212,
  "origQty": "11",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "status": "CANCELED",
  "stopPrice": "9300",
  "closePosition": false,
  "symbol": "BTCUSDT",
  "timeInForce": "GTC",
  "origType": "TRAILING_STOP_MARKET",
  "type": "TRAILING_STOP_MARKET",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "updateTime": 1571110484038,
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false,
  "priceMatch": "NONE",
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 0
}

application/json

Change Initial Leverage (TRADE)

Change user's initial leverage of specific symbol market.

POST

/fapi/v1/leverage

https://fapi.binance.com

Change Initial Leverage (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

Change Initial Leverage (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

Change Initial Leverage (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

Change Initial Leverage (TRADE) › Request Body

symbol

string · required

Example: BTCUSDT

leverage

integer · int64 · min: 1 · max: 125 · required

target initial leverage

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

recvWindow

integer · int64 · max: 60000

Example: 5000

Change Initial Leverage (TRADE) › Responses

200

Change Initial Leverage

leverage

integer · int64

Leverage.

Example: 21

maxNotionalValue

string

Max Notional Value.

Example: 1000000

symbol

string

Symbol.

Example: BTCUSDT

POST/fapi/v1/leverage

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/leverage \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data symbol=BTCUSDT \
  --data leverage=1 \
  --data timestamp=1770736694138

Example Request Body

{
  "symbol": "BTCUSDT",
  "leverage": 1,
  "timestamp": 1770736694138
}

Example Responses

{
  "leverage": 21,
  "maxNotionalValue": "1000000",
  "symbol": "BTCUSDT"
}

application/json

Change Margin Type (TRADE)

Change symbol level margin type

POST

/fapi/v1/marginType

https://fapi.binance.com

Change Margin Type (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

Change Margin Type (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

Change Margin Type (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

Change Margin Type (TRADE) › Request Body

symbol

string · required

Example: BTCUSDT

marginType

string · enum · required

Enum values:

ISOLATED

CROSSED

Example: ISOLATED

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

Example: 5000

Change Margin Type (TRADE) › Responses

200

Change Margin Type

code

integer · int64

Example: 200

msg

string

Example: success

POST/fapi/v1/marginType

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/marginType \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data symbol=BTCUSDT \
  --data marginType=ISOLATED \
  --data timestamp=1770736694138

Example Request Body

{
  "symbol": "BTCUSDT",
  "marginType": "ISOLATED",
  "timestamp": 1770736694138
}

Example Responses

{
  "code": 200,
  "msg": "success"
}

application/json

Current All Algo Open Orders (USER_DATA)

Get all open algo (conditional) orders on a symbol, including TP/SL (Take Profit / Stop Loss) and trailing stop orders on USD-M Futures.

GET

/fapi/v1/openAlgoOrders

https://fapi.binance.com

Current All 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

Current All 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 Weight

1 for a single symbol; 40 when the symbol parameter is omitted

Careful when accessing this with no symbol.

Current All 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

Current All 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

algoType

string

Example: CONDITIONAL

symbol

string

Example: BTCUSDT

algoId

integer · int64

Example: 2148627

recvWindow

integer · int64 · max: 60000

Example: 5000

Current All Algo Open Orders (USER_DATA) › Responses

200

Current All Algo Open Orders

object

algoId

integer · int64

Example: 2148627

clientAlgoId

string

Example: MRumok0dkhrP4kCm12AHaB

algoType

string

Example: CONDITIONAL

orderType

string

Example: TAKE_PROFIT

symbol

string

Example: BNBUSDT

side

string

Example: SELL

positionSide

string

Example: BOTH

timeInForce

string

Example: GTC

quantity

string

Example: 0.01

algoStatus

string

Example: NEW

actualOrderId

string

Example:

actualPrice

string

Example: 0.00000

triggerPrice

string

Example: 750.000

price

string

Example: 750.000

icebergQuantity

string

Example: null

tpTriggerPrice

string

Example: 0.000

tpPrice

string

Example: 0.000

slTriggerPrice

string

Example: 0.000

slPrice

string

Example: 0.000

tpOrderType

string

Example:

selfTradePreventionMode

string

Example: EXPIRE_MAKER

workingType

string

Example: CONTRACT_PRICE

priceMatch

string

Example: NONE

closePosition

boolean

Example: false

priceProtect

boolean

Example: false

reduceOnly

boolean

Example: false

createTime

integer · int64

Example: 1750514941540

updateTime

integer · int64

Example: 1750514941540

triggerTime

integer · int64

Example: 0

goodTillDate

integer · int64

Example: 0

GET/fapi/v1/openAlgoOrders

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/openAlgoOrders?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "algoId": 2148627,
    "clientAlgoId": "MRumok0dkhrP4kCm12AHaB",
    "algoType": "CONDITIONAL",
    "orderType": "TAKE_PROFIT",
    "symbol": "BNBUSDT",
    "side": "SELL",
    "positionSide": "BOTH",
    "timeInForce": "GTC",
    "quantity": "0.01",
    "algoStatus": "NEW",
    "actualOrderId": "",
    "actualPrice": "0.00000",
    "triggerPrice": "750.000",
    "price": "750.000",
    "icebergQuantity": "null",
    "tpTriggerPrice": "0.000",
    "tpPrice": "0.000",
    "slTriggerPrice": "0.000",
    "slPrice": "0.000",
    "tpOrderType": "",
    "selfTradePreventionMode": "EXPIRE_MAKER",
    "workingType": "CONTRACT_PRICE",
    "priceMatch": "NONE",
    "closePosition": false,
    "priceProtect": false,
    "reduceOnly": false,
    "createTime": 1750514941540,
    "updateTime": 1750514941540,
    "triggerTime": 0,
    "goodTillDate": 0
  }
]

application/json

Current All Open Orders (USER_DATA)

Get all open orders on a symbol.

GET

/fapi/v1/openOrders

https://fapi.binance.com

Current All 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

Current All 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 Weight

1 for a single symbol; 40 when the symbol parameter is omitted

Careful when accessing this with no symbol.

Current All 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

Current All 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

symbol

string

Example: BTCUSDT

recvWindow

integer · int64 · max: 60000

Example: 5000

Current All Open Orders (USER_DATA) › Responses

200

Current All Open Orders

object

avgPrice

string

Avg Price.

Example: 0.00000

clientOrderId

string

Client Order Id.

Example: abc

cumQuote

string

Cum Quote.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Order Id.

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: TRAILING_STOP_MARKET

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

Position Side.

Example: SHORT

status

string

Status.

Example: NEW

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

closePosition

boolean

if Close-All

Example: false

symbol

string

Symbol.

Example: BTCUSDT

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Type.

Example: TRAILING_STOP_MARKET

activatePrice

string

activation price, only return with TRAILING_STOP_MARKET order

Example: 9020

priceRate

string

callback rate, only return with TRAILING_STOP_MARKET order

Example: 0.3

updateTime

integer · int64

update time

Example: 1579276756075

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

if conditional order trigger is protected

Example: false

priceMatch

string

price match mode

Example: NONE

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

GET/fapi/v1/openOrders

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/openOrders?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "avgPrice": "0.00000",
    "clientOrderId": "abc",
    "cumQuote": "0",
    "executedQty": "0",
    "orderId": 1917641,
    "origQty": "0.40",
    "origType": "TRAILING_STOP_MARKET",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "status": "NEW",
    "stopPrice": "9300",
    "closePosition": false,
    "symbol": "BTCUSDT",
    "time": 1579276756075,
    "timeInForce": "GTC",
    "type": "TRAILING_STOP_MARKET",
    "activatePrice": "9020",
    "priceRate": "0.3",
    "updateTime": 1579276756075,
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "priceMatch": "NONE",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0
  }
]

application/json

Futures TradFi Perps Contract (USER_DATA)

Sign TradFi-Perps agreement contract

POST

/fapi/v1/stock/contract

https://fapi.binance.com

Futures TradFi Perps Contract (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

Futures TradFi Perps Contract (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 Weight50

Futures TradFi Perps Contract (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

Futures TradFi Perps Contract (USER_DATA) › Request Body

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

Example: 5000

Futures TradFi Perps Contract (USER_DATA) › Responses

200

Futures TradFi Perps Contract

code

integer · int64

Example: 200

msg

string

Example: success

POST/fapi/v1/stock/contract

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/stock/contract \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data timestamp=1770736694138

Example Request Body

{
  "timestamp": 1770736694138
}

Example Responses

{
  "code": 200,
  "msg": "success"
}

application/json

Get Order Modify History (USER_DATA)

Get order modification history

GET

/fapi/v1/orderAmendment

https://fapi.binance.com

Get Order Modify History (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

Get Order Modify History (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

Get Order Modify History (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

Get Order Modify History (USER_DATA) › Query Parameters

symbol

string · required

Example: BTCUSDT

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

orderId

integer · int64

Example: 20072994037

origClientOrderId

string

Example: LJ9R4QZDihCaS8UAOOLpgW

startTime

integer · int64

Timestamp in ms to get modification history from INCLUSIVE

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get modification history until INCLUSIVE

Example: 1641782889000

limit

integer · int64 · max: 100

Example: 50

Default: 50

recvWindow

integer · int64 · max: 60000

Example: 5000

Get Order Modify History (USER_DATA) › Responses

200

Get Order Modify History

object

amendmentId

integer · int64

Order modification ID

Example: 5363

symbol

string

Example: BTCUSDT

pair

string

Example: BTCUSDT

orderId

integer · int64

Example: 20072994037

clientOrderId

string

Example: LJ9R4QZDihCaS8UAOOLpgW

time

integer · int64

Order modification time

Example: 1629184560899

object

before

string

Example: 30004

after

string

Example: 30003.2

object

before

string

Example: 1

after

string

Example: 1

count

integer · int64

Order modification count, representing the number of times the order has been modified

Example: 3

GET/fapi/v1/orderAmendment

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/orderAmendment?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "amendmentId": 5363,
    "symbol": "BTCUSDT",
    "pair": "BTCUSDT",
    "orderId": 20072994037,
    "clientOrderId": "LJ9R4QZDihCaS8UAOOLpgW",
    "time": 1629184560899,
    "amendment": {
      "price": {
        "before": "30004",
        "after": "30003.2"
      },
      "origQty": {
        "before": "1",
        "after": "1"
      },
      "count": 3
    }
  }
]

application/json

Get Position Margin Change History (TRADE)

Get Position Margin Change History

GET

/fapi/v1/positionMargin/history

https://fapi.binance.com

Get Position Margin Change History (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

Get Position Margin Change History (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

Get Position Margin Change History (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

Get Position Margin Change History (TRADE) › Query Parameters

symbol

string · required

Example: BTCUSDT

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

type

string

1: Add position margin，2: Reduce position margin

Example: 1

startTime

integer · int64

Start time

Example: 1623319461670

endTime

integer · int64

time if not pass

Example: 1641782889000

Default: current

limit

integer · int64

Example: 50

Default: 500

recvWindow

integer · int64 · max: 60000

Example: 5000

Get Position Margin Change History (TRADE) › Responses

200

Get Position Margin Change History

object

symbol

string

Symbol.

Example: BTCUSDT

type

integer · int64

Type.

Example: 1

deltaType

string

Delta Type.

Example: USER_ADJUST

amount

string

Amount.

Example: 23.36332311

asset

string

Asset.

Example: USDT

time

integer · int64

Time.

Example: 1578047897183

positionSide

string

Position Side.

Example: BOTH

GET/fapi/v1/positionMargin/history

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/positionMargin/history?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "symbol": "BTCUSDT",
    "type": 1,
    "deltaType": "USER_ADJUST",
    "amount": "23.36332311",
    "asset": "USDT",
    "time": 1578047897183,
    "positionSide": "BOTH"
  }
]

application/json

Modify Isolated Position Margin (TRADE)

Modify Isolated Position Margin

POST

/fapi/v1/positionMargin

https://fapi.binance.com

Modify Isolated Position Margin (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

Modify Isolated Position Margin (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

Modify Isolated Position Margin (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

Modify Isolated Position Margin (TRADE) › Request Body

symbol

string · required

Example: BTCUSDT

amount

number · float · required

Margin asset

Example: 1.0

type

integer · required

1: Add position margin，2: Reduce position margin

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

positionSide

string

Default BOTH for One-way Mode ; LONG or SHORT for Hedge Mode. It must be sent with Hedge Mode.

Example: BOTH

recvWindow

integer · int64 · max: 60000

Example: 5000

Modify Isolated Position Margin (TRADE) › Responses

200

Modify Isolated Position Margin

amount

number · float

Example: 100

code

integer · int64

Example: 200

msg

string

Example: Successfully modify position margin.

type

integer · int64

Example: 1

POST/fapi/v1/positionMargin

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/positionMargin \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data symbol=BTCUSDT \
  --data amount=1.0 \
  --data type=1 \
  --data timestamp=1770736694138

Example Request Body

{
  "symbol": "BTCUSDT",
  "amount": "1.0",
  "type": 1,
  "timestamp": 1770736694138
}

Example Responses

{
  "amount": 100,
  "code": 200,
  "msg": "Successfully modify position margin.",
  "type": 1
}

application/json

Position ADL Quantile Estimation (USER_DATA)

Position ADL Quantile Estimation

Values update every 30s.
Values 0, 1, 2, 3, 4 shows the queue position and possibility of ADL from low to high.
For positions of the symbol are in One-way Mode or isolated margined in Hedge Mode, "LONG", "SHORT", and "BOTH" will be returned to show the positions' adl quantiles of different position sides.
If the positions of the symbol are crossed margined in Hedge Mode:
- "HEDGE" as a sign will be returned instead of "BOTH";
- A same value caculated on unrealized pnls on long and short sides' positions will be shown for "LONG" and "SHORT" when there are positions in both of long and short sides.

GET

/fapi/v1/adlQuantile

https://fapi.binance.com

Position ADL Quantile Estimation (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

Position ADL Quantile Estimation (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 Weight5

Position ADL Quantile Estimation (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

Position ADL Quantile Estimation (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

Example: BTCUSDT

recvWindow

integer · int64 · max: 60000

Example: 5000

Position ADL Quantile Estimation (USER_DATA) › Responses

200

Position ADL Quantile Estimation

object

symbol

string

Example: ETHUSDT

object

Example: {}

LONG

integer · int64

adl quantile for "LONG" position in hedge mode

Example: 3

SHORT

integer · int64

adl qauntile for "SHORT" position in hedge mode

Example: 3

HEDGE

integer · int64

only a sign, ignore the value

Example: 0

BOTH

integer · int64

adl qunatile for position in one-way mode

Example: 0

GET/fapi/v1/adlQuantile

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/adlQuantile?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "symbol": "ETHUSDT",
    "adlQuantile": {}
  }
]

application/json

Position Information V2 (USER_DATA)

Get current position information.

GET

/fapi/v2/positionRisk

https://fapi.binance.com

Position Information V2 (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

Position Information V2 (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 Weight5

Position Information V2 (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

Position Information V2 (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

Example: BTCUSDT

recvWindow

integer · int64 · max: 60000

Example: 5000

Position Information V2 (USER_DATA) › Responses

200

Position Information V2

object

entryPrice

string

Entry Price.

Example: 0.00000

breakEvenPrice

string

Break Even Price.

Example: 0.0

marginType

string

Margin Type.

Example: isolated

isAutoAddMargin

string

Example: false

isolatedMargin

string

Isolated Margin.

Example: 0.00000000

leverage

string

Leverage.

Example: 10

liquidationPrice

string

Liquidation Price.

Example: 0

markPrice

string

Mark Price.

Example: 6679.50671178

maxNotionalValue

string

Max Notional Value.

Example: 20000000

positionAmt

string

Position Amt.

Example: 0.000

notional

string

Example: 0

isolatedWallet

string

Example: 0

symbol

string

Symbol.

Example: BTCUSDT

unRealizedProfit

string

Un Realized Profit.

Example: 0.00000000

positionSide

string

Position Side.

Example: BOTH

updateTime

integer · int64

Update Time.

Example: 1625474304765

GET/fapi/v2/positionRisk

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v2/positionRisk?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "entryPrice": "0.00000",
    "breakEvenPrice": "0.0",
    "marginType": "isolated",
    "isAutoAddMargin": "false",
    "isolatedMargin": "0.00000000",
    "leverage": "10",
    "liquidationPrice": "0",
    "markPrice": "6679.50671178",
    "maxNotionalValue": "20000000",
    "positionAmt": "0.000",
    "notional": "0",
    "isolatedWallet": "0",
    "symbol": "BTCUSDT",
    "unRealizedProfit": "0.00000000",
    "positionSide": "BOTH",
    "updateTime": 1625474304765
  }
]

application/json

Position Information V3 (USER_DATA)

Get current position information(only symbol that has position or open orders will be returned).

GET

/fapi/v3/positionRisk

https://fapi.binance.com

Position Information V3 (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

Position Information V3 (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 Weight5

Position Information V3 (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

Position Information V3 (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

Example: BTCUSDT

recvWindow

integer · int64 · max: 60000

Example: 5000

Position Information V3 (USER_DATA) › Responses

200

Position Information V3

object

symbol

string

symbol

Example: ADAUSDT

positionSide

string

position side

Example: BOTH

positionAmt

string

position amount, positive for long, negative for short

Example: 30

entryPrice

string

entry price

Example: 0.385

breakEvenPrice

string

break-even price

Example: 0.385077

markPrice

string

current mark price

Example: 0.41047590

unRealizedProfit

string

unrealized profit

Example: 0.76427700

liquidationPrice

string

liquidation price

Example: 0

isolatedMargin

string

isolated margin

Example: 0

notional

string

notional value of position

Example: 12.31427700

marginAsset

string

margin asset

Example: USDT

isolatedWallet

string

isolated wallet (if isolated position)

Example: 0

initialMargin

string

initial margin required with current mark price

Example: 0.61571385

maintMargin

string

maintenance margin required

Example: 0.08004280

positionInitialMargin

string

initial margin required for positions with current mark price

Example: 0.61571385

openOrderInitialMargin

string

initial margin required for open orders with current mark price

Example: 0

adl

integer · int64

auto-deleverage ranking

Example: 2

bidNotional

string

ignore

Example: 0

askNotional

string

ignore

Example: 0

updateTime

integer · int64

update time

Example: 1720736417660

GET/fapi/v3/positionRisk

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v3/positionRisk?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "symbol": "ADAUSDT",
    "positionSide": "BOTH",
    "positionAmt": "30",
    "entryPrice": "0.385",
    "breakEvenPrice": "0.385077",
    "markPrice": "0.41047590",
    "unRealizedProfit": "0.76427700",
    "liquidationPrice": "0",
    "isolatedMargin": "0",
    "notional": "12.31427700",
    "marginAsset": "USDT",
    "isolatedWallet": "0",
    "initialMargin": "0.61571385",
    "maintMargin": "0.08004280",
    "positionInitialMargin": "0.61571385",
    "openOrderInitialMargin": "0",
    "adl": 2,
    "bidNotional": "0",
    "askNotional": "0",
    "updateTime": 1720736417660
  }
]

application/json

Query All Algo Orders (USER_DATA)

Get all algo (conditional) orders — active, CANCELED, TRIGGERED, or FINISHED — including TP/SL (Take Profit / Stop Loss) and trailing stop orders on USD-M Futures.

These orders will not be found:
- order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time
- order create time + 90 days < current time

GET

/fapi/v1/allAlgoOrders

https://fapi.binance.com

Query All 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 All 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 Weight5

Query All 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 All Algo Orders (USER_DATA) › Query Parameters

symbol

string · required

Symbol

Example: BTCUSDT

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

algoId

integer · int64

Example: 2146760

startTime

integer · int64

Example: 1623319461670

endTime

integer · int64

Example: 1641782889000

limit

integer · int64 · max: 1000

Example: 50

Default: 500

recvWindow

integer · int64

Example: 5000

Query All Algo Orders (USER_DATA) › Responses

200

All Algo Orders

object

algoId

integer · int64

Example: 2146760

clientAlgoId

string

Example: 6B2I9XVcJpCjqPAJ4YoFX7

algoType

string

Example: CONDITIONAL

orderType

string

Example: TAKE_PROFIT

symbol

string

Example: BNBUSDT

side

string

Example: SELL

positionSide

string

Example: BOTH

timeInForce

string

Example: GTC

quantity

string

Example: 0.01

algoStatus

string

Example: CANCELED

actualOrderId

string

Example:

actualPrice

string

Example: 0.00000

triggerPrice

string

Example: 750.000

price

string

Example: 750.000

icebergQuantity

string

Example: null

tpTriggerPrice

string

Example: 0.000

tpPrice

string

Example: 0.000

slTriggerPrice

string

Example: 0.000

slPrice

string

Example: 0.000

tpOrderType

string

Example:

selfTradePreventionMode

string

Example: EXPIRE_MAKER

workingType

string

Example: CONTRACT_PRICE

priceMatch

string

Example: NONE

closePosition

boolean

Example: false

priceProtect

boolean

Example: false

reduceOnly

boolean

Example: false

createTime

integer · int64

Example: 1750485492076

updateTime

integer · int64

Example: 1750514545091

triggerTime

integer · int64

Example: 0

goodTillDate

integer · int64

Example: 0

GET/fapi/v1/allAlgoOrders

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/allAlgoOrders?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "algoId": 2146760,
    "clientAlgoId": "6B2I9XVcJpCjqPAJ4YoFX7",
    "algoType": "CONDITIONAL",
    "orderType": "TAKE_PROFIT",
    "symbol": "BNBUSDT",
    "side": "SELL",
    "positionSide": "BOTH",
    "timeInForce": "GTC",
    "quantity": "0.01",
    "algoStatus": "CANCELED",
    "actualOrderId": "",
    "actualPrice": "0.00000",
    "triggerPrice": "750.000",
    "price": "750.000",
    "icebergQuantity": "null",
    "tpTriggerPrice": "0.000",
    "tpPrice": "0.000",
    "slTriggerPrice": "0.000",
    "slPrice": "0.000",
    "tpOrderType": "",
    "selfTradePreventionMode": "EXPIRE_MAKER",
    "workingType": "CONTRACT_PRICE",
    "priceMatch": "NONE",
    "closePosition": false,
    "priceProtect": false,
    "reduceOnly": false,
    "createTime": 1750485492076,
    "updateTime": 1750514545091,
    "triggerTime": 0,
    "goodTillDate": 0
  }
]

application/json

Query Current Open Order (USER_DATA)

Query open order

GET

/fapi/v1/openOrder

https://fapi.binance.com

Query Current Open Order (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 Open Order (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 Open Order (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 Open Order (USER_DATA) › Query Parameters

symbol

string · required

Example: BTCUSDT

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

orderId

integer · int64

Example: 1917641

origClientOrderId

string

Example: abc

recvWindow

integer · int64

Example: 5000

Query Current Open Order (USER_DATA) › Responses

200

Current Open Order

avgPrice

string

Avg Price.

Example: 0.00000

clientOrderId

string

Client Order Id.

Example: abc

cumQuote

string

Cum Quote.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Order Id.

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: TRAILING_STOP_MARKET

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

status

string

Status.

Example: NEW

positionSide

string

Position Side.

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

closePosition

boolean

if Close-All

Example: false

symbol

string

Symbol.

Example: BTCUSDT

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Type.

Example: TRAILING_STOP_MARKET

activatePrice

string

activation price, only return with TRAILING_STOP_MARKET order

Example: 9020

priceRate

string

callback rate, only return with TRAILING_STOP_MARKET order

Example: 0.3

updateTime

integer · int64

Update Time.

Example: 1579276756075

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

if conditional order trigger is protected

Example: false

priceMatch

string

price match mode

Example: NONE

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

GET/fapi/v1/openOrder

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/openOrder?symbol=%3Cstring%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "avgPrice": "0.00000",
  "clientOrderId": "abc",
  "cumQuote": "0",
  "executedQty": "0",
  "orderId": 1917641,
  "origQty": "0.40",
  "origType": "TRAILING_STOP_MARKET",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "status": "NEW",
  "positionSide": "SHORT",
  "stopPrice": "9300",
  "closePosition": false,
  "symbol": "BTCUSDT",
  "time": 1579276756075,
  "timeInForce": "GTC",
  "type": "TRAILING_STOP_MARKET",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "updateTime": 1579276756075,
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false,
  "priceMatch": "NONE",
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 0
}

application/json

Test Order (TRADE)

Testing order request, this order will not be submitted to matching engine

POST

/fapi/v1/order/test

https://fapi.binance.com

Test 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

Test 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

Test Order (TRADE) › Request Body

symbol

string · required

Example: BTCUSDT

side

string · enum · required

Enum values:

BUY

SELL

Example: BUY

type

string · enum · required

Enum values:

LIMIT

MARKET

STOP

STOP_MARKET

TAKE_PROFIT

TAKE_PROFIT_MARKET

TRAILING_STOP_MARKET

Example: LIMIT

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

positionSide

string · enum

Default BOTH for One-way Mode ; LONG or SHORT for Hedge Mode. It must be sent in Hedge Mode.

Enum values:

BOTH

LONG

SHORT

Example: BOTH

reduceOnly

string · enum

Cannot be sent in Hedge Mode; cannot be sent with closePosition=true

Enum values:

true

false

Example: true

Default: false

quantity

number · float

Cannot be sent with closePosition=true(Close-All)

Example: 1.0

price

number · float

Example: 1.0

newClientOrderId

string

A unique id among open orders. Automatically generated if not sent. Can only be string following the rule: ^[\.A-Z\:/a-z0-9_-]{1,36}$

Example: 1

stopPrice

number · float

Used with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders.

Example: 1.0

closePosition

string · enum

Close-All，used with STOP_MARKET or TAKE_PROFIT_MARKET."

Enum values:

true

false

Example: false

activationPrice

number · float

Used with TRAILING_STOP_MARKET orders, default as the latest price(supporting different workingType)

Example: 1.0

callbackRate

number · float · min: 0.1 · max: 5

Used with TRAILING_STOP_MARKET orders

Example: 1

timeInForce

string · enum

Enum values:

GTC

IOC

FOK

GTX

GTD

RPI

Example: GTC

workingType

string · enum

Enum values:

MARK_PRICE

CONTRACT_PRICE

Example: MARK_PRICE

Default: CONTRACT_PRICE

priceProtect

string · enum

Enum values:

true

false

Example: true

Default: false

newOrderRespType

string · enum

Enum values:

ACK

RESULT

Example: ACK

Default: ACK

priceMatch

string · enum

only avaliable for LIMIT/STOP/TAKE_PROFIT order; Can't be passed together with price

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

selfTradePreventionMode

string · enum

NONE STP / EXPIRE_TAKER taker order when STP triggers/ EXPIRE_MAKER taker order when STP triggers/ EXPIRE_BOTH both orders when STP triggers; default NONE

Enum values:

NONE

EXPIRE_TAKER

EXPIRE_BOTH

EXPIRE_MAKER

Example: EXPIRE_TAKER

Default: NONE

goodTillDate

integer · int64

Example: 1770736694138

recvWindow

integer · int64

Example: 5000

Additional mandatory parameters based on type:

Type	Additional mandatory parameters
`LIMIT`	`timeInForce`, `quantity`, `price`
`MARKET`	`quantity`
`STOP/TAKE_PROFIT`	`quantity`, `price`, `stopPrice`
`STOP_MARKET/TAKE_PROFIT_MARKET`	`stopPrice`
`TRAILING_STOP_MARKET`	`callbackRate`

Order with type STOP, parameter timeInForce can be sent ( default GTC).
Order with type TAKE_PROFIT, parameter timeInForce can be sent (default GTC).
Condition orders will be triggered when:
- If parameterpriceProtectis sent as true:
  - when price reaches the stopPrice ，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol
  - "triggerProtect" of a symbol can be got from GET /fapi/v1/exchangeInfo
- STOP, STOP_MARKET:
  - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= stopPrice
  - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE")
- TAKE_PROFIT, TAKE_PROFIT_MARKET:
  - BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE")
  - SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= stopPrice
- TRAILING_STOP_MARKET:
  - BUY: the lowest price after order placed ``= the lowest price * (1 + callbackRate)
  - SELL: the highest price after order placed >= activationPrice, and the latest price
For TRAILING_STOP_MARKET, if you got such error code. > {"code": -2021, "msg": "Order would immediately trigger."} > means that the parameters you send do not meet the following requirements:
- BUY: activationPrice should be smaller than latest price.
- SELL: activationPrice should be larger than latest price.
If newOrderRespType is sent as RESULT :
- MARKET order: the final FILLED result of the order will be return directly.
- LIMIT order with special timeInForce: the final status result of the order(FILLED or EXPIRED) will be returned directly.
STOP_MARKET, TAKE_PROFIT_MARKET with closePosition=true:
- Follow the same rules for condition orders.
- If triggered，close all current long position( if SELL) or current short position( if BUY).
- Cannot be used with quantity paremeter
- Cannot be used with reduceOnly parameter
- In Hedge Mode,cannot be used with BUY orders in LONG position side. and cannot be used with SELL orders in SHORT position side
selfTradePreventionMode is only effective when timeInForce set to IOC or GTC or GTD.
In extreme market conditions, timeInForce GTD order auto cancel time might be delayed comparing to goodTillDate

Test Order (TRADE) › Responses

200

Test Order

clientOrderId

string

Client Order Id.

Example: testOrder

cumQty

string

Example: 0

cumQuote

string

Cum Quote.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Order Id.

Example: 22542179

avgPrice

string

Avg Price.

Example: 0.00000

origQty

string

Orig Qty.

Example: 10

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: SELL

positionSide

string

Position Side.

Example: SHORT

status

string

Status.

Example: NEW

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 0

closePosition

boolean

if Close-All

Example: false

symbol

string

Symbol.

Example: BTCUSDT

timeInForce

string

Time In Force.

Example: GTD

type

string

Type.

Example: TRAILING_STOP_MARKET

origType

string

Orig Type.

Example: TRAILING_STOP_MARKET

activatePrice

string

activation price, only return with TRAILING_STOP_MARKET order

Example: 9020

priceRate

string

callback rate, only return with TRAILING_STOP_MARKET order

Example: 0.3

updateTime

integer · int64

Update Time.

Example: 1566818724722

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

if conditional order trigger is protected

Example: false

priceMatch

string

price match mode

Example: NONE

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 1693207680000

POST/fapi/v1/order/test

curl --request POST \
  --url https://fapi.binance.com/fapi/v1/order/test \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data symbol=BTCUSDT \
  --data side=BUY \
  --data type=LIMIT \
  --data timestamp=1770736694138

Example Request Body

{
  "symbol": "BTCUSDT",
  "side": "BUY",
  "type": "LIMIT",
  "timestamp": 1770736694138
}

Example Responses

{
  "clientOrderId": "testOrder",
  "cumQty": "0",
  "cumQuote": "0",
  "executedQty": "0",
  "orderId": 22542179,
  "avgPrice": "0.00000",
  "origQty": "10",
  "price": "0",
  "reduceOnly": false,
  "side": "SELL",
  "positionSide": "SHORT",
  "status": "NEW",
  "stopPrice": "0",
  "closePosition": false,
  "symbol": "BTCUSDT",
  "timeInForce": "GTD",
  "type": "TRAILING_STOP_MARKET",
  "origType": "TRAILING_STOP_MARKET",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "updateTime": 1566818724722,
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false,
  "priceMatch": "NONE",
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 1693207680000
}

application/json

User's Force Orders (USER_DATA)

Query user's Force Orders

GET

/fapi/v1/forceOrders

https://fapi.binance.com

User's Force 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

User's Force 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 Weight

20 with symbol, 50 without symbol

User's Force 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

User's Force 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

Example: BTCUSDT

autoCloseType

string · enum

"LIQUIDATION" for liquidation orders, "ADL" for ADL orders.

Enum values:

LIQUIDATION

ADL

Example: LIQUIDATION

startTime

integer · int64

Example: 1623319461670

endTime

integer · int64

Example: 1641782889000

limit

integer · int64 · max: 100

Example: 50

Default: 50

recvWindow

integer · int64

Example: 5000

User's Force Orders (USER_DATA) › Responses

200

User's Force Orders

object

orderId

integer · int64

Example: 6071832819

symbol

string

Example: BTCUSDT

status

string

Example: FILLED

clientOrderId

string

Example: autoclose-1596107620040000020

price

string

Example: 10871.09

avgPrice

string

Example: 10913.21000

origQty

string

Example: 0.001

executedQty

string

Example: 0.001

cumQuote

string

Example: 10.91321

timeInForce

string

Example: IOC

type

string

Example: LIMIT

reduceOnly

boolean

Example: false

closePosition

boolean

Example: false

side

string

Example: SELL

positionSide

string

Example: BOTH

stopPrice

string

Example: 0

workingType

string

Example: CONTRACT_PRICE

origType

string

Example: LIMIT

time

integer · int64

Example: 1596107620044

updateTime

integer · int64

Example: 1596107620087

GET/fapi/v1/forceOrders

curl --request GET \
  --url 'https://fapi.binance.com/fapi/v1/forceOrders?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

[
  {
    "orderId": 6071832819,
    "symbol": "BTCUSDT",
    "status": "FILLED",
    "clientOrderId": "autoclose-1596107620040000020",
    "price": "10871.09",
    "avgPrice": "10913.21000",
    "origQty": "0.001",
    "executedQty": "0.001",
    "cumQuote": "10.91321",
    "timeInForce": "IOC",
    "type": "LIMIT",
    "reduceOnly": false,
    "closePosition": false,
    "side": "SELL",
    "positionSide": "BOTH",
    "stopPrice": "0",
    "workingType": "CONTRACT_PRICE",
    "origType": "LIMIT",
    "time": 1596107620044,
    "updateTime": 1596107620087
  }
]

application/json