Trade

Endpoint

Cancel All CM Open Conditional Orders (TRADE)

Cancel All CM Open Conditional Orders

DELETE

/papi/v1/cm/conditional/allOpenOrders

https://papi.binance.com

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

recvWindow

integer · int64

Example: 5000

Cancel All CM Open Conditional Orders (TRADE) › Responses

200

Cancel All CM Open Conditional Orders

code

string

Code.

Example: 200

msg

string

Msg.

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

DELETE/papi/v1/cm/conditional/allOpenOrders

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

Example Responses

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

application/json

Cancel All CM Open Orders (TRADE)

Cancel all active LIMIT orders on specific symbol

DELETE

/papi/v1/cm/allOpenOrders

https://papi.binance.com

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

recvWindow

integer · int64

Example: 5000

Cancel All CM Open Orders (TRADE) › Responses

200

Cancel All CM Open Orders

code

integer · int64

Code.

Example: 200

msg

string

Msg.

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

DELETE/papi/v1/cm/allOpenOrders

curl --request DELETE \
  --url 'https://papi.binance.com/papi/v1/cm/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

Cancel All UM Open Conditional Orders (TRADE)

Cancel All UM Open Conditional Orders

DELETE

/papi/v1/um/conditional/allOpenOrders

https://papi.binance.com

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

recvWindow

integer · int64

Example: 5000

Cancel All UM Open Conditional Orders (TRADE) › Responses

200

Cancel All UM Open Conditional Orders

code

string

Code.

Example: 200

msg

string

Msg.

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

DELETE/papi/v1/um/conditional/allOpenOrders

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

Example Responses

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

application/json

Cancel All UM Open Orders (TRADE)

Cancel all active LIMIT orders on specific symbol

DELETE

/papi/v1/um/allOpenOrders

https://papi.binance.com

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

recvWindow

integer · int64

Example: 5000

Cancel All UM Open Orders (TRADE) › Responses

200

Cancel All UM Open Orders

code

integer · int64

Code.

Example: 200

msg

string

Msg.

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

DELETE/papi/v1/um/allOpenOrders

curl --request DELETE \
  --url 'https://papi.binance.com/papi/v1/um/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

New CM Conditional Order (TRADE)

New CM Conditional Order

POST

/papi/v1/cm/conditional/order

https://papi.binance.com

New CM Conditional 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 CM Conditional 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

New CM Conditional 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 CM Conditional Order (TRADE) › Request Body

symbol

string · required

Symbol

Example: BTCUSDT

side

string · enum · required

Side

Enum values:

BUY

SELL

Example: BUY

strategyType

string · enum · required

Enum values:

STOP

STOP_MARKET

TAKE_PROFIT

TAKE_PROFIT_MARKET

TRAILING_STOP_MARKET

Example: STOP

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

Default: BOTH

timeInForce

string · enum

Enum values:

GTC

IOC

FOK

GTX

Example: GTC

quantity

number · float

Example: 1.0

reduceOnly

string

"true" or "false". default "false". Cannot be sent in Hedge Mode

Example: true

Default: false

price

number · float

Example: 1.0

workingType

string · enum

stopPrice triggered by: "MARK_PRICE", "CONTRACT_PRICE". Default "CONTRACT_PRICE"

Enum values:

MARK_PRICE

CONTRACT_PRICE

Example: MARK_PRICE

Default: CONTRACT_PRICE

priceProtect

string · enum

"true" or "false", default "false". Used with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders

Enum values:

true

false

Example: true

Default: false

newClientStrategyId

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

activationPrice

number · float

Used with TRAILING_STOP_MARKET orders.

Example: 1.0

callbackRate

number · float · min: 0.1 · max: 5

Used with TRAILING_STOP_MARKET orders.

Example: 1.0

recvWindow

integer · int64

Example: 5000

New CM Conditional Order (TRADE) › Responses

200

New CM Conditional Order

newClientStrategyId

string

New Client Strategy ID.

Example: testOrder

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: NEW

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 10

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSD_200925

pair

string

Pair.

Example: BTCUSD

timeInForce

string

Time In Force.

Example: GTC

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

bookTime

integer · int64

order place time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

Price Protect.

Example: false

POST/papi/v1/cm/conditional/order

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

Example Request Body

{
  "symbol": "BTCUSDT",
  "side": "BUY",
  "strategyType": "STOP",
  "timestamp": 1770736694138
}

Example Responses

{
  "newClientStrategyId": "testOrder",
  "strategyId": 123445,
  "strategyStatus": "NEW",
  "strategyType": "TRAILING_STOP_MARKET",
  "origQty": "10",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "stopPrice": "9300",
  "symbol": "BTCUSD_200925",
  "pair": "BTCUSD",
  "timeInForce": "GTC",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "bookTime": 1566818724710,
  "updateTime": 1566818724722,
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false
}

application/json

Cancel CM Conditional Order (TRADE)

Cancel CM Conditional Order

DELETE

/papi/v1/cm/conditional/order

https://papi.binance.com

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

strategyId

integer · int64

Example: 1

newClientStrategyId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Cancel CM Conditional Order (TRADE) › Responses

200

Cancel CM Conditional Order

newClientStrategyId

string

New Client Strategy ID.

Example: myOrder1

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: CANCELED

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 11

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSD

timeInForce

string

Time In Force.

Example: GTC

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

bookTime

integer · int64

order place time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

Price Protect.

Example: false

DELETE/papi/v1/cm/conditional/order

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

Example Responses

{
  "newClientStrategyId": "myOrder1",
  "strategyId": 123445,
  "strategyStatus": "CANCELED",
  "strategyType": "TRAILING_STOP_MARKET",
  "origQty": "11",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "stopPrice": "9300",
  "symbol": "BTCUSD",
  "timeInForce": "GTC",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "bookTime": 1566818724710,
  "updateTime": 1566818724722,
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false
}

application/json

Query CM Order (USER_DATA)

Check an CM order's status.

GET

/papi/v1/cm/order

https://papi.binance.com

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

symbol

string · required

Symbol

Example: BTCUSD_200925

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: 1

origClientOrderId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Query CM Order (USER_DATA) › Responses

200

CM Order

avgPrice

string

Avg Price.

Example: 0.0

clientOrderId

string

Client Order ID.

Example: abc

cumBase

string

Cum Base.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: LIMIT

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

status

string

Enum：completed，processing

Example: NEW

symbol

string

Trade symbol, if existing.

Example: BTCUSD_200925

pair

string

Pair.

Example: BTCUSD

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

update time

Example: 1579276756075

GET/papi/v1/cm/order

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

Example Responses

{
  "avgPrice": "0.0",
  "clientOrderId": "abc",
  "cumBase": "0",
  "executedQty": "0",
  "orderId": 1917641,
  "origQty": "0.40",
  "origType": "LIMIT",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "status": "NEW",
  "symbol": "BTCUSD_200925",
  "pair": "BTCUSD",
  "positionSide": "SHORT",
  "time": 1579276756075,
  "timeInForce": "GTC",
  "type": "LIMIT",
  "updateTime": 1579276756075
}

application/json

Modify CM Order (TRADE)

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

PUT

/papi/v1/cm/order

https://papi.binance.com

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

Modify CM 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 CM Order (TRADE) › Request Body

symbol

string · required

Symbol

Example: BTCUSD_PERP

side

string · enum · required

Enum values:

BUY

SELL

Example: BUY

quantity

number · float · required

Order quantity

Example: 1.0

price

number · float · required

Order price

Example: 1.0

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

Order ID

Example: 1

origClientOrderId

string

Client order ID

Example: 1

priceMatch

string · enum

only avaliable for LIMIT/STOP/TAKE_PROFIT order; can be set to OPPONENT/ OPPONENT_5/ OPPONENT_10/ OPPONENT_20: /QUEUE/ QUEUE_5/ QUEUE_10/ QUEUE_20; 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

Example: 5000

Modify CM Order (TRADE) › Responses

200

Modify CM Order

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 20072994037

symbol

string

Trade symbol, if existing.

Example: BTCUSD_PERP

pair

string

Pair.

Example: BTCUSD

status

string

Enum：completed，processing

Example: NEW

clientOrderId

string

Client Order ID.

Example: LJ9R4QZDihCaS8UAOOLpgW

price

string

Price.

Example: 30005

avgPrice

string

Avg Price.

Example: 0.0

origQty

string

Orig Qty.

Example: 1

executedQty

string

Executed Qty.

Example: 0

cumQty

string

Cum Qty.

Example: 0

cumBase

string

Cum Base.

Example: 0

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: LONG

origType

string

Orig Type.

Example: LIMIT

updateTime

integer · int64

last update time

Example: 1629182711600

PUT/papi/v1/cm/order

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

Example Request Body

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

Example Responses

{
  "orderId": 20072994037,
  "symbol": "BTCUSD_PERP",
  "pair": "BTCUSD",
  "status": "NEW",
  "clientOrderId": "LJ9R4QZDihCaS8UAOOLpgW",
  "price": "30005",
  "avgPrice": "0.0",
  "origQty": "1",
  "executedQty": "0",
  "cumQty": "0",
  "cumBase": "0",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "LONG",
  "origType": "LIMIT",
  "updateTime": 1629182711600
}

application/json

New CM Order (TRADE)

Place new CM order

POST

/papi/v1/cm/order

https://papi.binance.com

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

New CM 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 CM Order (TRADE) › Request Body

symbol

string · required

Symbol

Example: BTCUSDT

side

string · enum · required

Side

Enum values:

BUY

SELL

Example: BUY

type

string · enum · required

Enum values:

LIMIT

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

Default: BOTH

timeInForce

string · enum

Enum values:

GTC

IOC

FOK

GTX

Example: GTC

quantity

number · float

Place amount

Example: 1.0

reduceOnly

string · enum

"true" or "false". Cannot be sent in Hedge Mode.

Enum values:

true

false

Example: true

Default: false

price

number · float

Order price

Example: 1.0

priceMatch

string · enum

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

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,32}$

Example: 1

newOrderRespType

string · enum

"ACK", "RESULT", default "ACK"

Enum values:

ACK

RESULT

Example: ACK

Default: ACK

recvWindow

integer · int64

Example: 5000

New CM Order (TRADE) › Responses

200

New CM Order

clientOrderId

string

Client Order ID.

Example: testOrder

cumQty

string

Cum Qty.

Example: 0

cumBase

string

Cum Base.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 22542179

avgPrice

string

Avg Price.

Example: 0.0

origQty

string

Orig Qty.

Example: 10

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: NEW

symbol

string

Trade symbol, if existing.

Example: BTCUSD_200925

pair

string

Pair.

Example: BTCUSD

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: MARKET

updateTime

integer · int64

last update time

Example: 1566818724722

POST/papi/v1/cm/order

curl --request POST \
  --url https://papi.binance.com/papi/v1/cm/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",
  "cumBase": "0",
  "executedQty": "0",
  "orderId": 22542179,
  "avgPrice": "0.0",
  "origQty": "10",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "status": "NEW",
  "symbol": "BTCUSD_200925",
  "pair": "BTCUSD",
  "timeInForce": "GTC",
  "type": "MARKET",
  "updateTime": 1566818724722
}

application/json

Cancel CM Order (TRADE)

Cancel an active LIMIT order

DELETE

/papi/v1/cm/order

https://papi.binance.com

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

symbol

string · required

Symbol

Example: BTCUSD_200925

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: 1

origClientOrderId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Cancel CM Order (TRADE) › Responses

200

Cancel CM Order

avgPrice

string

Avg Price.

Example: 0.0

clientOrderId

string

Client Order ID.

Example: myOrder1

cumQty

string

Cum Qty.

Example: 0

cumBase

string

Cum Base.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 283194212

origQty

string

Orig Qty.

Example: 2

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: CANCELED

symbol

string

Trade symbol, if existing.

Example: BTCUSD_200925

pair

string

Pair.

Example: BTCUSD

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

last update time

Example: 1571110484038

DELETE/papi/v1/cm/order

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

Example Responses

{
  "avgPrice": "0.0",
  "clientOrderId": "myOrder1",
  "cumQty": "0",
  "cumBase": "0",
  "executedQty": "0",
  "orderId": 283194212,
  "origQty": "2",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "status": "CANCELED",
  "symbol": "BTCUSD_200925",
  "pair": "BTCUSD",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "updateTime": 1571110484038
}

application/json

Cancel Margin Account All Open Orders on a Symbol (TRADE)

Cancel Margin Account All Open Orders on a Symbol

DELETE

/papi/v1/margin/allOpenOrders

https://papi.binance.com

Cancel Margin Account All Open Orders on a Symbol (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 Margin Account All Open Orders on a Symbol (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 Weight5

Cancel Margin Account All Open Orders on a Symbol (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 Margin Account All Open Orders on a Symbol (TRADE) › 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

recvWindow

integer · int64 · max: 60000

Example: 5000

Cancel Margin Account All Open Orders on a Symbol (TRADE) › Responses

200

Cancel Margin Account All Open Orders on a Symbol

object

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

origClientOrderId

string

Orig Client Order ID.

Example: E6APeyTJvkMvLMYMqu1KQ4

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 11

orderListId

integer · int64

Order List ID.

Example: -1

clientOrderId

string

Client Order ID.

Example: pXLV6Hz6mprAcVYpVMTGgx

price

string

Price.

Example: 0.089853

origQty

string

Orig Qty.

Example: 0.178622

executedQty

string

Executed Qty.

Example: 0.000000

cummulativeQuoteQty

string

Cummulative Quote Qty.

Example: 0.000000

status

string

Enum：completed，processing

Example: CANCELED

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

side

string

Side.

Example: BUY

contingencyType

string

Contingency Type.

Example: OCO

listStatusType

string

List Status Type.

Example: ALL_DONE

listOrderStatus

string

List Order Status.

Example: ALL_DONE

listClientOrderId

string

List Client Order ID.

Example: 2inzWQdDvZLHbbAmAozX2N

transactionTime

integer · int64

Transaction Time.

Example: 1585230948299

object[]

Orders.

object[]

Order Reports.

DELETE/papi/v1/margin/allOpenOrders

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

Example Responses

[
  {
    "symbol": "BTCUSDT",
    "origClientOrderId": "E6APeyTJvkMvLMYMqu1KQ4",
    "orderId": 11,
    "orderListId": -1,
    "clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
    "price": "0.089853",
    "origQty": "0.178622",
    "executedQty": "0.000000",
    "cummulativeQuoteQty": "0.000000",
    "status": "CANCELED",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "BUY",
    "contingencyType": "OCO",
    "listStatusType": "ALL_DONE",
    "listOrderStatus": "ALL_DONE",
    "listClientOrderId": "2inzWQdDvZLHbbAmAozX2N",
    "transactionTime": 1585230948299,
    "orders": [
      {
        "symbol": "BTCUSDT",
        "orderId": 20,
        "clientOrderId": "CwOOIPHSmYywx6jZX77TdL"
      }
    ],
    "orderReports": [
      {
        "symbol": "BTCUSDT",
        "origClientOrderId": "CwOOIPHSmYywx6jZX77TdL",
        "orderId": 20,
        "orderListId": 1929,
        "clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
        "price": "0.668611",
        "origQty": "0.690354",
        "executedQty": "0.000000",
        "cummulativeQuoteQty": "0.000000",
        "status": "CANCELED",
        "timeInForce": "GTC",
        "type": "STOP_LOSS_LIMIT",
        "side": "BUY",
        "stopPrice": "0.378131",
        "icebergQty": "0.017083"
      }
    ]
  }
]

application/json

Query Margin Account's OCO (USER_DATA)

Retrieves a specific OCO based on provided optional parameters

GET

/papi/v1/margin/orderList

https://papi.binance.com

Query Margin Account's OCO (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 Margin Account's OCO (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 Margin Account's OCO (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 Margin Account's OCO (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

orderListId

integer · int64

Either orderListId or listClientOrderId must be provided

Example: 1

origClientOrderId

string

orderListId or listClientOrderId must be provided.

Example: 1

recvWindow

integer · int64

Value cannot be greater than 60000

Example: 5000

Query Margin Account's OCO (USER_DATA) › Responses

200

Margin Account's OCO

orderListId

integer · int64

Order List ID.

Example: 27

contingencyType

string

Contingency Type.

Example: OCO

listStatusType

string

List Status Type.

Example: EXEC_STARTED

listOrderStatus

string

List Order Status.

Example: EXECUTING

listClientOrderId

string

List Client Order ID.

Example: h2USkA5YQpaXHPIrkd96xE

transactionTime

integer · int64

Transaction Time.

Example: 1565245656253

symbol

string

Trade symbol, if existing.

Example: LTCBTC

object[]

Orders.

GET/papi/v1/margin/orderList

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

Example Responses

{
  "orderListId": 27,
  "contingencyType": "OCO",
  "listStatusType": "EXEC_STARTED",
  "listOrderStatus": "EXECUTING",
  "listClientOrderId": "h2USkA5YQpaXHPIrkd96xE",
  "transactionTime": 1565245656253,
  "symbol": "LTCBTC",
  "orders": [
    {
      "symbol": "LTCBTC",
      "orderId": 4,
      "clientOrderId": "qD1gy3kc3Gx0rihm9Y3xwS"
    }
  ]
}

application/json

Cancel Margin Account OCO Orders (TRADE)

Cancel Margin Account OCO Orders

DELETE

/papi/v1/margin/orderList

https://papi.binance.com

Cancel Margin Account OCO 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 Margin Account OCO 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 Weight2

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

symbol

string · required

Symbol

Example: LTCBTC

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

orderListId

integer · int64

Either orderListId or listClientOrderId must be provided

Example: 1

listClientOrderId

string

Either orderListId or listClientOrderId must be provided

Example: 1

newClientOrderId

string

Used to uniquely identify this cancel request.

Example: 1

recvWindow

integer · int64

The value cannot be greater than 60000

Example: 5000

Cancel Margin Account OCO Orders (TRADE) › Responses

200

Cancel Margin Account OCO Orders

orderListId

integer · int64

Order List ID.

Example: 0

contingencyType

string

Contingency Type.

Example: OCO

listStatusType

string

List Status Type.

Example: ALL_DONE

listOrderStatus

string

List Order Status.

Example: ALL_DONE

listClientOrderId

string

List Client Order ID.

Example: C3wyj4WVEktd7u9aVBRXcN

transactionTime

integer · int64

Transaction Time.

Example: 1574040868128

symbol

string

Trade symbol, if existing.

Example: LTCBTC

object[]

Orders.

object[]

Order Reports.

DELETE/papi/v1/margin/orderList

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

Example Responses

{
  "orderListId": 0,
  "contingencyType": "OCO",
  "listStatusType": "ALL_DONE",
  "listOrderStatus": "ALL_DONE",
  "listClientOrderId": "C3wyj4WVEktd7u9aVBRXcN",
  "transactionTime": 1574040868128,
  "symbol": "LTCBTC",
  "orders": [
    {
      "symbol": "LTCBTC",
      "orderId": 2,
      "clientOrderId": "pO9ufTiFGg3nw2fOdgeOXa"
    }
  ],
  "orderReports": [
    {
      "symbol": "LTCBTC",
      "origClientOrderId": "pO9ufTiFGg3nw2fOdgeOXa",
      "orderId": 2,
      "orderListId": 0,
      "clientOrderId": "unfWT8ig8i0uj6lPuYLez6",
      "price": "1.00000000",
      "origQty": "10.00000000",
      "executedQty": "0.00000000",
      "cummulativeQuoteQty": "0.00000000",
      "status": "CANCELED",
      "timeInForce": "GTC",
      "type": "STOP_LOSS_LIMIT",
      "side": "SELL",
      "stopPrice": "1.00000000"
    }
  ]
}

application/json

Query Margin Account Order (USER_DATA)

Query Margin Account Order

GET

/papi/v1/margin/order

https://papi.binance.com

Query Margin Account 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 Margin Account 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 Weight10

Query Margin Account 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 Margin Account Order (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

orderId

integer · int64

Example: 1

origClientOrderId

string

Example: 1

recvWindow

integer · int64

Value cannot be greater than 60000

Example: 5000

Query Margin Account Order (USER_DATA) › Responses

200

Margin Account Order

clientOrderId

string

Client Order ID.

Example: ZwfQzuDIGpceVhKW5DvCmO

cummulativeQuoteQty

string

Cummulative Quote Qty.

Example: 0.00000000

executedQty

string

Executed Qty.

Example: 0.00000000

icebergQty

string

Iceberg Qty.

Example: 0.00000000

isWorking

boolean

Is Working.

Example: true

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 213205622

origQty

string

Orig Qty.

Example: 0.30000000

price

string

Price.

Example: 0.00493630

side

string

Side.

Example: SELL

status

string

Enum：completed，processing

Example: NEW

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 0.00000000

symbol

string

Trade symbol, if existing.

Example: BNBBTC

time

integer · int64

Event time.

Example: 1562133008725

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

last update time

Example: 1562133008725

accountId

integer · int64

Account ID.

Example: 152950866

selfTradePreventionMode

string

self trading preventation mode

Example: EXPIRE_TAKER

preventedMatchId

string

Prevented Match ID.

Example: null

preventedQuantity

string

Prevented Quantity.

Example: null

GET/papi/v1/margin/order

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

Example Responses

{
  "clientOrderId": "ZwfQzuDIGpceVhKW5DvCmO",
  "cummulativeQuoteQty": "0.00000000",
  "executedQty": "0.00000000",
  "icebergQty": "0.00000000",
  "isWorking": true,
  "orderId": 213205622,
  "origQty": "0.30000000",
  "price": "0.00493630",
  "side": "SELL",
  "status": "NEW",
  "stopPrice": "0.00000000",
  "symbol": "BNBBTC",
  "time": 1562133008725,
  "timeInForce": "GTC",
  "type": "LIMIT",
  "updateTime": 1562133008725,
  "accountId": 152950866,
  "selfTradePreventionMode": "EXPIRE_TAKER",
  "preventedMatchId": "null",
  "preventedQuantity": "null"
}

application/json

New Margin Order (TRADE)

New Margin Order

POST

/papi/v1/margin/order

https://papi.binance.com

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

New Margin 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 Margin 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_LOSS

STOP_LOSS_LIMIT

TAKE_PROFIT

TAKE_PROFIT_LIMIT

LIMIT_MAKER

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

quantity

number · float

Example: 1.0

quoteOrderQty

number · float

Example: 1.0

price

number · float

Example: 1.0

stopPrice

number · float

Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.

Example: 1.0

newClientOrderId

string

A unique id among open orders. Automatically generated if not sent.

Example: 1

newOrderRespType

string · enum

Set the response JSON. ACK, RESULT, or FULL.

Enum values:

ACK

RESULT

FULL

Example: ACK

icebergQty

number · float

Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order

Example: 1.0

sideEffectType

string · enum

Enum values:

NO_SIDE_EFFECT

MARGIN_BUY

AUTO_REPAY

AUTO_BORROW_REPAY

Example: NO_SIDE_EFFECT

Default: NO_SIDE_EFFECT

timeInForce

string · enum

Enum values:

GTC

IOC

FOK

Example: GTC

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

Enum values:

NONE

EXPIRE_TAKER

EXPIRE_BOTH

EXPIRE_MAKER

Example: NONE

autoRepayAtCancel

boolean · enum

Only when MARGIN_BUY or AUTO_BORROW_REPAY order takes effect, true means that the debt generated by the order needs to be repaid after the order is cancelled.

Enum values:

Example: true

Default: true

recvWindow

integer · int64

The value cannot be greater than 60000

Example: 5000

New Margin Order (TRADE) › Responses

200

New Margin Order

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 28

clientOrderId

string

Client Order ID.

Example: 6gCrw2kRUAF9CvJDGP16IP

transactTime

integer · int64

Transact Time.

Example: 1507725176595

price

string

Price.

Example: 1.00000000

origQty

string

Orig Qty.

Example: 10.00000000

executedQty

string

Executed Qty.

Example: 10.00000000

cummulativeQuoteQty

string

Cummulative Quote Qty.

Example: 10.00000000

status

string

Enum：completed，processing

Example: FILLED

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: MARKET

side

string

Side.

Example: SELL

marginBuyBorrowAmount

string

will not return if no margin trade happens

Example: 5

marginBuyBorrowAsset

string

will not return if no margin trade happens

Example: BTC

object[]

Fills.

POST/papi/v1/margin/order

curl --request POST \
  --url https://papi.binance.com/papi/v1/margin/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

{
  "symbol": "BTCUSDT",
  "orderId": 28,
  "clientOrderId": "6gCrw2kRUAF9CvJDGP16IP",
  "transactTime": 1507725176595,
  "price": "1.00000000",
  "origQty": "10.00000000",
  "executedQty": "10.00000000",
  "cummulativeQuoteQty": "10.00000000",
  "status": "FILLED",
  "timeInForce": "GTC",
  "type": "MARKET",
  "side": "SELL",
  "marginBuyBorrowAmount": "5",
  "marginBuyBorrowAsset": "BTC",
  "fills": [
    {
      "price": "4000.00000000",
      "qty": "1.00000000",
      "commission": "4.00000000",
      "commissionAsset": "USDT"
    }
  ]
}

application/json

Cancel Margin Account Order (TRADE)

Cancel Margin Account Order

DELETE

/papi/v1/margin/order

https://papi.binance.com

Cancel Margin Account 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 Margin Account 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 Weight2

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

symbol

string · required

Symbol

Example: LTCBTC

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: 1

origClientOrderId

string

Example: 1

newClientOrderId

string

Used to uniquely identify this cancel request.

Example: 1

recvWindow

integer · int64

The value cannot be greater than 60000

Example: 5000

Cancel Margin Account Order (TRADE) › Responses

200

Cancel Margin Account Order

symbol

string

Trade symbol, if existing.

Example: LTCBTC

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 28

origClientOrderId

string

Orig Client Order ID.

Example: myOrder1

clientOrderId

string

Client Order ID.

Example: cancelMyOrder1

price

string

Price.

Example: 1.00000000

origQty

string

Orig Qty.

Example: 10.00000000

executedQty

string

Executed Qty.

Example: 8.00000000

cummulativeQuoteQty

string

Cummulative Quote Qty.

Example: 8.00000000

status

string

Enum：completed，processing

Example: CANCELED

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

side

string

Side.

Example: SELL

DELETE/papi/v1/margin/order

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

Example Responses

{
  "symbol": "LTCBTC",
  "orderId": 28,
  "origClientOrderId": "myOrder1",
  "clientOrderId": "cancelMyOrder1",
  "price": "1.00000000",
  "origQty": "10.00000000",
  "executedQty": "8.00000000",
  "cummulativeQuoteQty": "8.00000000",
  "status": "CANCELED",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "side": "SELL"
}

application/json

New UM Conditional Order (TRADE)

Place new UM conditional order

POST

/papi/v1/um/conditional/order

https://papi.binance.com

New UM Conditional 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 UM Conditional 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

New UM Conditional 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 UM Conditional Order (TRADE) › Request Body

symbol

string · required

Symbol

Example: BTCUSDT

side

string · enum · required

Enum values:

BUY

SELL

Example: BUY

strategyType

string · enum · required

Enum values:

STOP

STOP_MARKET

TAKE_PROFIT

TAKE_PROFIT_MARKET

TRAILING_STOP_MARKET

Example: STOP

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

Default: BOTH

timeInForce

string · enum

Enum values:

GTC

IOC

FOK

GTX

GTD

Example: GTC

quantity

number · float

Example: 1.0

reduceOnly

string · enum

"true" or "false". Cannot be sent in Hedge Mode ; cannot be sent with closePosition=true

Enum values:

true

false

Example: false

Default: false

price

number · float

Example: 1.0

workingType

string · enum

stopPrice triggered by: "MARK_PRICE", "CONTRACT_PRICE". Default "CONTRACT_PRICE"

Enum values:

MARK_PRICE

CONTRACT_PRICE

Example: MARK_PRICE

Default: CONTRACT_PRICE

priceProtect

string · enum

"true" or "false". Used with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders

Enum values:

true

false

Example: false

Default: false

newClientStrategyId

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,32}$

Example: 1

stopPrice

number · float

Used with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders.

Example: 1.0

activationPrice

number · float

Used with TRAILING_STOP_MARKET orders.

Example: 1.0

callbackRate

number · float · min: 0.1 · max: 5

Used with TRAILING_STOP_MARKET orders.

Example: 1.0

priceMatch

string · enum

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

Enum values:

NONE

EXPIRE_TAKER

EXPIRE_BOTH

EXPIRE_MAKER

Example: 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 253402300799000Mode. It must be sent in Hedge Mode.

Example: 1770736694138

recvWindow

integer · int64

Example: 5000

New UM Conditional Order (TRADE) › Responses

200

New UM Conditional Order

newClientStrategyId

string

New Client Strategy ID.

Example: testOrder

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: NEW

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 10

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

timeInForce

string

Time In Force.

Example: GTD

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

bookTime

integer · int64

order place time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

Price Protect.

Example: false

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 1693207680000

priceMatch

string

Price Match.

Example: NONE

POST/papi/v1/um/conditional/order

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

Example Request Body

{
  "symbol": "BTCUSDT",
  "side": "BUY",
  "strategyType": "STOP",
  "timestamp": 1770736694138
}

Example Responses

{
  "newClientStrategyId": "testOrder",
  "strategyId": 123445,
  "strategyStatus": "NEW",
  "strategyType": "TRAILING_STOP_MARKET",
  "origQty": "10",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "stopPrice": "9300",
  "symbol": "BTCUSDT",
  "timeInForce": "GTD",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "bookTime": 1566818724710,
  "updateTime": 1566818724722,
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false,
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 1693207680000,
  "priceMatch": "NONE"
}

application/json

Cancel UM Conditional Order (TRADE)

Cancel UM Conditional Order

DELETE

/papi/v1/um/conditional/order

https://papi.binance.com

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

strategyId

integer · int64

Example: 1

newClientStrategyId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Cancel UM Conditional Order (TRADE) › Responses

200

Cancel UM Conditional Order

newClientStrategyId

string

New Client Strategy ID.

Example: myOrder1

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: CANCELED

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 11

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

timeInForce

string

Time In Force.

Example: GTC

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

bookTime

integer · int64

order place time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

Price Protect.

Example: false

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

priceMatch

string

Price Match.

Example: NONE

DELETE/papi/v1/um/conditional/order

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

Example Responses

{
  "newClientStrategyId": "myOrder1",
  "strategyId": 123445,
  "strategyStatus": "CANCELED",
  "strategyType": "TRAILING_STOP_MARKET",
  "origQty": "11",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "stopPrice": "9300",
  "symbol": "BTCUSDT",
  "timeInForce": "GTC",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "bookTime": 1566818724710,
  "updateTime": 1566818724722,
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false,
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 0,
  "priceMatch": "NONE"
}

application/json

Query UM Order (USER_DATA)

Check an UM order's status.

GET

/papi/v1/um/order

https://papi.binance.com

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

orderId

integer · int64

Example: 1

origClientOrderId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Query UM Order (USER_DATA) › Responses

200

UM 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

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: LIMIT

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: NEW

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

update time

Example: 1579276756075

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

priceMatch

string

Price Match.

Example: NONE

GET/papi/v1/um/order

curl --request GET \
  --url 'https://papi.binance.com/papi/v1/um/order?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": "LIMIT",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "status": "NEW",
  "symbol": "BTCUSDT",
  "time": 1579276756075,
  "timeInForce": "GTC",
  "type": "LIMIT",
  "updateTime": 1579276756075,
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 0,
  "priceMatch": "NONE"
}

application/json

Modify UM Order (TRADE)

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

PUT

/papi/v1/um/order

https://papi.binance.com

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

Modify UM 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 UM Order (TRADE) › Request Body

symbol

string · required

Symbol

Example: BTCUSDT

side

string · enum · required

Enum values:

BUY

SELL

Example: BUY

quantity

number · float · required

Order quantity

Example: 1.0

price

number · float · required

Order price

Example: 1.0

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

Order ID

Example: 1

origClientOrderId

string

Client order ID

Example: 1

priceMatch

string · enum

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

recvWindow

integer · int64

Example: 5000

Modify UM Order (TRADE) › Responses

200

Modify UM Order

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 20072994037

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

status

string

Enum：completed，processing

Example: NEW

clientOrderId

string

Client Order ID.

Example: LJ9R4QZDihCaS8UAOOLpgW

price

string

Price.

Example: 30005

avgPrice

string

Avg Price.

Example: 0.0

origQty

string

Orig Qty.

Example: 1

executedQty

string

Executed Qty.

Example: 0

cumQty

string

Cum Qty.

Example: 0

cumQuote

string

Cum Quote.

Example: 0

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: LONG

origType

string

Orig Type.

Example: LIMIT

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

last update time

Example: 1629182711600

priceMatch

string

Price Match.

Example: NONE

PUT/papi/v1/um/order

curl --request PUT \
  --url https://papi.binance.com/papi/v1/um/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=1.0 \
  --data timestamp=1770736694138

Example Request Body

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

Example Responses

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

application/json

New UM Order (TRADE)

Place new UM order

POST

/papi/v1/um/order

https://papi.binance.com

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

New UM 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 UM Order (TRADE) › Request Body

symbol

string · required

Symbol

Example: BTCUSDT

side

string · enum · required

Enum values:

BUY

SELL

Example: BUY

type

string · enum · required

Enum values:

LIMIT

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

Default: BOTH

timeInForce

string · enum

Valid values

Enum values:

GTC

IOC

FOK

GTX

GTD

Example: GTC

quantity

number · float

Place amount

Example: 1.0

reduceOnly

string · enum

"true" or "false". default "false". Cannot be sent in Hedge Mode .

Enum values:

true

false

Example: true

Default: false

price

number · float

Order price

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,32}$

Example: 1

newOrderRespType

string · enum

ACK, RESULT, default ACK

Enum values:

ACK

RESULT

Example: ACK

Default: ACK

priceMatch

string · enum

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

Enum values:

NONE

EXPIRE_TAKER

EXPIRE_BOTH

EXPIRE_MAKER

Example: NONE

goodTillDate

integer · int64

Example: 1770736694138

recvWindow

integer · int64

Example: 5000

New UM Order (TRADE) › Responses

200

New UM Order

clientOrderId

string

Client Order ID.

Example: testOrder

cumQty

string

Cum Qty.

Example: 0

cumQuote

string

Cum Quote.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

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: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: NEW

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

timeInForce

string

Time In Force.

Example: GTD

type

string

Normal order type after trigger if appliable

Example: MARKET

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 1693207680000

updateTime

integer · int64

last update time

Example: 1566818724722

priceMatch

string

Price Match.

Example: NONE

POST/papi/v1/um/order

curl --request POST \
  --url https://papi.binance.com/papi/v1/um/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",
  "cumQuote": "0",
  "executedQty": "0",
  "orderId": 22542179,
  "avgPrice": "0.00000",
  "origQty": "10",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "status": "NEW",
  "symbol": "BTCUSDT",
  "timeInForce": "GTD",
  "type": "MARKET",
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 1693207680000,
  "updateTime": 1566818724722,
  "priceMatch": "NONE"
}

application/json

Cancel UM Order (TRADE)

Cancel an active UM LIMIT order

DELETE

/papi/v1/um/order

https://papi.binance.com

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

orderId

integer · int64

Example: 1

origClientOrderId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Cancel UM Order (TRADE) › Responses

200

Cancel UM Order

avgPrice

string

Avg Price.

Example: 0.00000

clientOrderId

string

Client Order ID.

Example: myOrder1

cumQty

string

Cum Qty.

Example: 0

cumQuote

string

Cum Quote.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 4611875134427365000

origQty

string

Orig Qty.

Example: 0.40

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: CANCELED

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

last update time

Example: 1571110484038

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

priceMatch

string

Price Match.

Example: NONE

DELETE/papi/v1/um/order

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

Example Responses

{
  "avgPrice": "0.00000",
  "clientOrderId": "myOrder1",
  "cumQty": "0",
  "cumQuote": "0",
  "executedQty": "0",
  "orderId": 4611875134427365000,
  "origQty": "0.40",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "status": "CANCELED",
  "symbol": "BTCUSDT",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "updateTime": 1571110484038,
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 0,
  "priceMatch": "NONE"
}

application/json

CM Account Trade List (USER_DATA)

Get trades for a specific account and CM symbol.

GET

/papi/v1/cm/userTrades

https://papi.binance.com

CM 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

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

20 with symbol
40 with pair

CM 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

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

pair

string

Example: BTCUSD

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

fromId

integer · int64

Trade ID to fetch from.

Example: 1

limit

integer · int64 · max: 1000

Number of results returned.

Example: 50

Default: 50

recvWindow

integer · int64

Example: 5000

CM Account Trade List (USER_DATA) › Responses

200

CM Account Trade List

object

symbol

string

Trade symbol, if existing.

Example: BTCUSD_200626

id

integer · int64

ID.

Example: 6

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 28

pair

string

Pair.

Example: BTCUSD

side

string

Side.

Example: SELL

price

string

Price.

Example: 8800

qty

string

Qty.

Example: 1

realizedPnl

string

Realized Pnl.

Example: 0

marginAsset

string

Margin Asset.

Example: BTC

baseQty

string

Base Qty.

Example: 0.01136364

commission

string

Commission.

Example: 0.00000454

commissionAsset

string

Commission Asset.

Example: BTC

time

integer · int64

Event time.

Example: 1590743483586

positionSide

string

BOTH means that it is the position of One-way Mode

Example: BOTH

buyer

boolean

Buyer.

Example: false

maker

boolean

Maker.

Example: false

GET/papi/v1/cm/userTrades

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

Example Responses

[
  {
    "symbol": "BTCUSD_200626",
    "id": 6,
    "orderId": 28,
    "pair": "BTCUSD",
    "side": "SELL",
    "price": "8800",
    "qty": "1",
    "realizedPnl": "0",
    "marginAsset": "BTC",
    "baseQty": "0.01136364",
    "commission": "0.00000454",
    "commissionAsset": "BTC",
    "time": 1590743483586,
    "positionSide": "BOTH",
    "buyer": false,
    "maker": false
  }
]

application/json

CM Position ADL Quantile Estimation (USER_DATA)

Query CM 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

/papi/v1/cm/adlQuantile

https://papi.binance.com

CM 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

CM 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

CM 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

CM 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: BTCUSD_201225

recvWindow

integer · int64

Example: 5000

CM Position ADL Quantile Estimation (USER_DATA) › Responses

200

CM Position ADL Quantile Estimation

object

symbol

string

Trade symbol, if existing.

Example: BTCUSD_201225

object

Adl Quantile.

GET/papi/v1/cm/adlQuantile

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

Example Responses

[
  {
    "symbol": "BTCUSD_201225",
    "adlQuantile": {
      "LONG": 3,
      "SHORT": 3,
      "HEDGE": 0,
      "BOTH": 0
    }
  }
]

application/json

Get UM Futures BNB Burn Status (USER_DATA)

Get user's BNB Fee Discount for UM Futures (Fee Discount On or Fee Discount Off )

GET

/papi/v1/um/feeBurn

https://papi.binance.com

Get UM Futures BNB Burn Status (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 UM Futures BNB Burn Status (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 Weight30

Get UM Futures BNB Burn Status (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 UM Futures BNB Burn Status (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

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

Example: 1770736694138

recvWindow

integer · int64

Example: 5000

Get UM Futures BNB Burn Status (USER_DATA) › Responses

200

Get UM Futures BNB Burn Status

feeBurn

boolean

"true": Fee Discount On; "false": Fee Discount Off

Example: true

GET/papi/v1/um/feeBurn

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

Example Responses

{
  "feeBurn": true
}

application/json

Toggle BNB Burn On UM Futures Trade (TRADE)

Change user's BNB Fee Discount for UM Futures (Fee Discount On or Fee Discount Off ) on EVERY symbol

POST

/papi/v1/um/feeBurn

https://papi.binance.com

Toggle BNB Burn On UM Futures Trade (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

Toggle BNB Burn On UM Futures Trade (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

Toggle BNB Burn On UM Futures Trade (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

Toggle BNB Burn On UM Futures Trade (TRADE) › Request Body

feeBurn

string · enum · required

"true": Fee Discount On; "false": Fee Discount Off

Enum values:

true

false

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

Example: 5000

Toggle BNB Burn On UM Futures Trade (TRADE) › Responses

200

Toggle BNB Burn On UM Futures Trade

code

integer · int64

Code.

Example: 200

msg

string

Msg.

Example: success

POST/papi/v1/um/feeBurn

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

Example Request Body

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

Example Responses

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

application/json

Margin Account Borrow (MARGIN)

Apply for a margin loan.

POST

/papi/v1/marginLoan

https://papi.binance.com

Margin Account Borrow (MARGIN) › 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

Margin Account Borrow (MARGIN) › 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 Weight100

Margin Account Borrow (MARGIN) › 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

Margin Account Borrow (MARGIN) › Request Body

asset

string · required

Example: USDT

amount

number · float · required

Example: 1.0

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

Margin Account Borrow (MARGIN) › Responses

200

Margin Account Borrow

tranId

integer · int64

Transaction ID.

Example: 100000001

POST/papi/v1/marginLoan

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

Example Request Body

{
  "asset": "USDT",
  "amount": "1.0",
  "timestamp": 1770736694138
}

Example Responses

{
  "tranId": 100000001
}

application/json

Margin Account New OCO (TRADE)

Send in a new OCO for a margin account

POST

/papi/v1/margin/order/oco

https://papi.binance.com

Margin Account New OCO (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

Margin Account New OCO (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

Margin Account New OCO (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

Margin Account New OCO (TRADE) › Request Body

symbol

string · required

Example: LTCBTC

side

string · enum · required

See enum definitions: order side

Enum values:

BUY

SELL

Example: BUY

quantity

number · float · required

Example: 1.0

price

number · float · required

Example: 1.0

stopPrice

number · float · required

Example: 1.0

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

listClientOrderId

string

A unique Id for the entire orderList

Example: 1

limitClientOrderId

string

A unique Id for the limit order

Example: 1

limitIcebergQty

number · float

Example: 1.0

stopClientOrderId

string

A unique Id for the stop loss/stop loss limit leg

Example: 1

stopLimitPrice

number · float

If provided, stopLimitTimeInForce is required.

Example: 1.0

stopIcebergQty

number · float

Example: 1.0

stopLimitTimeInForce

string · enum

Valid values are GTC/FOK/IOC

Enum values:

GTC

IOC

FOK

Example: GTC

newOrderRespType

string · enum

Set the response JSON.

Enum values:

ACK

RESULT

Example: ACK

sideEffectType

string · enum

NO_SIDE_EFFECT, MARGIN_BUY, AUTO_REPAY; default NO_SIDE_EFFECT.

Enum values:

NO_SIDE_EFFECT

MARGIN_BUY

AUTO_REPAY

Example: NO_SIDE_EFFECT

Default: NO_SIDE_EFFECT

recvWindow

integer · int64 · max: 60000

Example: 5000

Margin Account New OCO (TRADE) › Responses

200

Margin Account New OCO

orderListId

integer · int64

Order List ID.

Example: 0

contingencyType

string

Contingency Type.

Example: OCO

listStatusType

string

List Status Type.

Example: EXEC_STARTED

listOrderStatus

string

List Order Status.

Example: EXECUTING

listClientOrderId

string

List Client Order ID.

Example: JYVpp3F0f5CAG15DhtrqLp

transactionTime

integer · int64

Transaction Time.

Example: 1563417480525

symbol

string

Trade symbol, if existing.

Example: LTCBTC

marginBuyBorrowAmount

string

will not return if no margin trade happens

Example: 5

marginBuyBorrowAsset

string

will not return if no margin trade happens

Example: BTC

object[]

Orders.

object[]

Order Reports.

POST/papi/v1/margin/order/oco

curl --request POST \
  --url https://papi.binance.com/papi/v1/margin/order/oco \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data symbol=LTCBTC \
  --data side=BUY \
  --data quantity=1.0 \
  --data price=1.0 \
  --data stopPrice=1.0 \
  --data timestamp=1770736694138

Example Request Body

{
  "symbol": "LTCBTC",
  "side": "BUY",
  "quantity": "1.0",
  "price": "1.0",
  "stopPrice": "1.0",
  "timestamp": 1770736694138
}

Example Responses

{
  "orderListId": 0,
  "contingencyType": "OCO",
  "listStatusType": "EXEC_STARTED",
  "listOrderStatus": "EXECUTING",
  "listClientOrderId": "JYVpp3F0f5CAG15DhtrqLp",
  "transactionTime": 1563417480525,
  "symbol": "LTCBTC",
  "marginBuyBorrowAmount": "5",
  "marginBuyBorrowAsset": "BTC",
  "orders": [
    {
      "symbol": "LTCBTC",
      "orderId": 2,
      "clientOrderId": "Kk7sqHb9J6mJWTMDVW7Vos"
    }
  ],
  "orderReports": [
    {
      "symbol": "LTCBTC",
      "orderId": 2,
      "orderListId": 0,
      "clientOrderId": "Kk7sqHb9J6mJWTMDVW7Vos",
      "transactTime": 1563417480525,
      "price": "0.000000",
      "origQty": "0.624363",
      "executedQty": "0.000000",
      "cummulativeQuoteQty": "0.000000",
      "status": "NEW",
      "timeInForce": "GTC",
      "type": "STOP_LOSS",
      "side": "BUY",
      "stopPrice": "0.960664"
    }
  ]
}

application/json

Margin Account Repay (MARGIN)

Repay for a margin loan.

POST

/papi/v1/repayLoan

https://papi.binance.com

Margin Account Repay (MARGIN) › 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

Margin Account Repay (MARGIN) › 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 Weight100

Margin Account Repay (MARGIN) › 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

Margin Account Repay (MARGIN) › Request Body

asset

string · required

Example: USDT

amount

number · float · required

Example: 1.0

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

The value cannot be greater than 60000

Example: 5000

Margin Account Repay (MARGIN) › Responses

200

Margin Account Repay

tranId

integer · int64

Transaction ID.

Example: 100000001

POST/papi/v1/repayLoan

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

Example Request Body

{
  "asset": "USDT",
  "amount": "1.0",
  "timestamp": 1770736694138
}

Example Responses

{
  "tranId": 100000001
}

application/json

Margin Account Repay Debt (TRADE)

Repay debt for a margin loan.

POST

/papi/v1/margin/repay-debt

https://papi.binance.com

Margin Account Repay Debt (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

Margin Account Repay Debt (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 Weight3000

Margin Account Repay Debt (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

Margin Account Repay Debt (TRADE) › Request Body

asset

string · required

Example: USDT

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

amount

string

Example: 1.0

specifyRepayAssets

string

Specific asset list to repay debt; Can be added in batch, separated by commas

Example: BNB

recvWindow

integer · int64

The value cannot be greater than 60000

Example: 5000

Margin Account Repay Debt (TRADE) › Responses

200

Margin Account Repay Debt

amount

string

Amount repaid

Example: 0.10000000

asset

string

asset name

Example: BNB

specifyRepayAssets

string[]

Specify Repay Assets.

updateTime

integer · int64

last update time

Example: 1636371437000

success

boolean

Success.

Example: true

POST/papi/v1/margin/repay-debt

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

Example Request Body

{
  "asset": "USDT",
  "timestamp": 1770736694138
}

Example Responses

{
  "amount": "0.10000000",
  "asset": "BNB",
  "specifyRepayAssets": [
    "USDT"
  ],
  "updateTime": 1636371437000,
  "success": true
}

application/json

Margin Account Trade List (USER_DATA)

Margin Account Trade List

GET

/papi/v1/margin/myTrades

https://papi.binance.com

Margin 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

Margin 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

Margin 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

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

orderId

integer · int64

Example: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

fromId

integer · int64

Trade ID to fetch from.

Example: 1

limit

integer · int64 · max: 1000

Number of results returned.

Example: 500

Default: 500

recvWindow

integer · int64

Value cannot be greater than 60000

Example: 5000

Margin Account Trade List (USER_DATA) › Responses

200

Margin Account Trade List

object

commission

string

Commission.

Example: 0.00006000

commissionAsset

string

Commission Asset.

Example: BTC

id

integer · int64

ID.

Example: 34

isBestMatch

boolean

Is Best Match.

Example: true

isBuyer

boolean

Is Buyer.

Example: false

isMaker

boolean

Is Maker.

Example: false

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 39324

price

string

Price.

Example: 0.02000000

qty

string

Qty.

Example: 3.00000000

symbol

string

Trade symbol, if existing.

Example: BNBBTC

time

integer · int64

Event time.

Example: 1561973357171

GET/papi/v1/margin/myTrades

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

Example Responses

[
  {
    "commission": "0.00006000",
    "commissionAsset": "BTC",
    "id": 34,
    "isBestMatch": true,
    "isBuyer": false,
    "isMaker": false,
    "orderId": 39324,
    "price": "0.02000000",
    "qty": "3.00000000",
    "symbol": "BNBBTC",
    "time": 1561973357171
  }
]

application/json

Query All CM Conditional Orders (USER_DATA)

Query All CM Conditional Orders

GET

/papi/v1/cm/conditional/allOrders

https://papi.binance.com

Query All CM Conditional 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 CM Conditional 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 symbol is omitted

Query All CM Conditional 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 CM Conditional 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

strategyId

integer · int64

Example: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 1000

Number of results returned.

Example: 500

Default: 500

recvWindow

integer · int64

Example: 5000

Query All CM Conditional Orders (USER_DATA) › Responses

200

All CM Conditional Orders

object

newClientStrategyId

string

New Client Strategy ID.

Example: abc

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: TRIGGERED

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 0.40

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSD

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 12123343534

status

string

Normal order status after trigger if appliable, only have when the strategy is triggered

Example: NEW

bookTime

integer · int64

order time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

triggerTime

integer · int64

Trigger Time.

Example: 1566818724750

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: 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

GET/papi/v1/cm/conditional/allOrders

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

Example Responses

[
  {
    "newClientStrategyId": "abc",
    "strategyId": 123445,
    "strategyStatus": "TRIGGERED",
    "strategyType": "TRAILING_STOP_MARKET",
    "origQty": "0.40",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "stopPrice": "9300",
    "symbol": "BTCUSD",
    "orderId": 12123343534,
    "status": "NEW",
    "bookTime": 1566818724710,
    "updateTime": 1566818724722,
    "triggerTime": 1566818724750,
    "timeInForce": "GTC",
    "type": "MARKET",
    "activatePrice": "9020",
    "priceRate": "0.3"
  }
]

application/json

Query All CM Orders (USER_DATA)

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

GET

/papi/v1/cm/allOrders

https://papi.binance.com

Query All CM 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 CM 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
40 with pair

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

Symbol

Example: BTCUSD_200925

pair

string

Example: BTCUSD

orderId

integer · int64

Example: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 100

Number of results returned.

Example: 500

Default: 50

recvWindow

integer · int64

Example: 5000

Query All CM Orders (USER_DATA) › Responses

200

All CM Orders

object

avgPrice

string

Avg Price.

Example: 0.0

clientOrderId

string

Client Order ID.

Example: abc

cumBase

string

Cum Base.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: LIMIT

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: NEW

symbol

string

Trade symbol, if existing.

Example: BTCUSD_200925

pair

string

Pair.

Example: BTCUSD

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

update time

Example: 1579276756075

GET/papi/v1/cm/allOrders

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

Example Responses

[
  {
    "avgPrice": "0.0",
    "clientOrderId": "abc",
    "cumBase": "0",
    "executedQty": "0",
    "orderId": 1917641,
    "origQty": "0.40",
    "origType": "LIMIT",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "status": "NEW",
    "symbol": "BTCUSD_200925",
    "pair": "BTCUSD",
    "time": 1579276756075,
    "timeInForce": "GTC",
    "type": "LIMIT",
    "updateTime": 1579276756075
  }
]

application/json

Query All Current CM Open Conditional Orders (USER_DATA)

Get all open conditional orders on a symbol. Careful when accessing this with no symbol.

GET

/papi/v1/cm/conditional/openOrders

https://papi.binance.com

Query All Current CM Open Conditional 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 Current CM Open Conditional 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 symbol is omitted

Query All Current CM Open Conditional 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 Current CM Open Conditional 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: BTCUSD

recvWindow

integer · int64

Example: 5000

Query All Current CM Open Conditional Orders (USER_DATA) › Responses

200

All Current CM Open Conditional Orders

object

newClientStrategyId

string

New Client Strategy ID.

Example: abc

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: NEW

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 0.40

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSD

bookTime

integer · int64

order time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

timeInForce

string

Time In Force.

Example: GTC

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

GET/papi/v1/cm/conditional/openOrders

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

Example Responses

[
  {
    "newClientStrategyId": "abc",
    "strategyId": 123445,
    "strategyStatus": "NEW",
    "strategyType": "TRAILING_STOP_MARKET",
    "origQty": "0.40",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "stopPrice": "9300",
    "symbol": "BTCUSD",
    "bookTime": 1566818724710,
    "updateTime": 1566818724722,
    "timeInForce": "GTC",
    "activatePrice": "9020",
    "priceRate": "0.3"
  }
]

application/json

Query All Current CM Open Orders (USER_DATA)

Get all open orders on a symbol.

If the symbol is not sent, orders for all symbols will be returned in an array.

GET

/papi/v1/cm/openOrders

https://papi.binance.com

Query All Current CM Open Orders (USER_DATA) › Authorization

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

Query All Current CM 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 symbol is omitted

Query All Current CM Open Orders (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Query All Current CM 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: BTCUSD_200925

pair

string

Example: BTCUSD

recvWindow

integer · int64

Example: 5000

Query All Current CM Open Orders (USER_DATA) › Responses

200

All Current CM Open Orders

object

avgPrice

string

Avg Price.

Example: 0.0

clientOrderId

string

Client Order ID.

Example: abc

cumBase

string

Cum Base.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: LIMIT

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: NEW

symbol

string

Trade symbol, if existing.

Example: BTCUSD_200925

pair

string

Pair.

Example: BTCUSD

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

update time

Example: 1579276756075

GET/papi/v1/cm/openOrders

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

Example Responses

[
  {
    "avgPrice": "0.0",
    "clientOrderId": "abc",
    "cumBase": "0",
    "executedQty": "0",
    "orderId": 1917641,
    "origQty": "0.40",
    "origType": "LIMIT",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "status": "NEW",
    "symbol": "BTCUSD_200925",
    "pair": "BTCUSD",
    "time": 1579276756075,
    "timeInForce": "GTC",
    "type": "LIMIT",
    "updateTime": 1579276756075
  }
]

application/json

Query All Current UM Open Conditional Orders (USER_DATA)

Get all open conditional orders on a symbol.

GET

/papi/v1/um/conditional/openOrders

https://papi.binance.com

Query All Current UM Open Conditional 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 Current UM Open Conditional 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 symbol is omitted

Query All Current UM Open Conditional 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 Current UM Open Conditional 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

Example: 5000

Query All Current UM Open Conditional Orders (USER_DATA) › Responses

200

All Current UM Open Conditional Orders

object

newClientStrategyId

string

New Client Strategy ID.

Example: abc

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: NEW

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 0.40

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

bookTime

integer · int64

order time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

timeInForce

string

Time In Force.

Example: GTC

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

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

priceMatch

string

Price Match.

Example: NONE

GET/papi/v1/um/conditional/openOrders

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

Example Responses

[
  {
    "newClientStrategyId": "abc",
    "strategyId": 123445,
    "strategyStatus": "NEW",
    "strategyType": "TRAILING_STOP_MARKET",
    "origQty": "0.40",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "stopPrice": "9300",
    "symbol": "BTCUSDT",
    "bookTime": 1566818724710,
    "updateTime": 1566818724722,
    "timeInForce": "GTC",
    "activatePrice": "9020",
    "priceRate": "0.3",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0,
    "priceMatch": "NONE"
  }
]

application/json

Query All Current UM Open Orders (USER_DATA)

Get all open orders on a symbol.

GET

/papi/v1/um/openOrders

https://papi.binance.com

Query All Current UM Open Orders (USER_DATA) › Authorization

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

Query All Current UM 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 symbol is omitted

Query All Current UM Open Orders (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

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

Example: 5000

Query All Current UM Open Orders (USER_DATA) › Responses

200

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

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: LIMIT

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: NEW

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

update time

Example: 1579276756075

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

priceMatch

string

Price Match.

Example: NONE

GET/papi/v1/um/openOrders

curl --request GET \
  --url 'https://papi.binance.com/papi/v1/um/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": "LIMIT",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "status": "NEW",
    "symbol": "BTCUSDT",
    "time": 1579276756075,
    "timeInForce": "GTC",
    "type": "LIMIT",
    "updateTime": 1579276756075,
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0,
    "priceMatch": "NONE"
  }
]

application/json

Query All Margin Account Orders (USER_DATA)

Query All Margin Account Orders

GET

/papi/v1/margin/allOrders

https://papi.binance.com

Query All Margin Account 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 Margin Account 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 Weight100

Query All Margin Account 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 Margin Account 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

orderId

integer · int64

Example: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 500

Number of results returned.

Example: 500

Default: 500

recvWindow

integer · int64

Value cannot be greater than 60000

Example: 5000

Query All Margin Account Orders (USER_DATA) › Responses

200

All Margin Account Orders

object

clientOrderId

string

Client Order ID.

Example: D2KDy4DIeS56PvkM13f8cP

cummulativeQuoteQty

string

Cummulative Quote Qty.

Example: 0.00000000

executedQty

string

Executed Qty.

Example: 0.00000000

icebergQty

string

Iceberg Qty.

Example: 0.00000000

isWorking

boolean

Is Working.

Example: false

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 41295

origQty

string

Orig Qty.

Example: 5.31000000

price

string

Price.

Example: 0.22500000

side

string

Side.

Example: SELL

status

string

Enum：completed，processing

Example: CANCELED

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 0.18000000

symbol

string

Trade symbol, if existing.

Example: BNBBTC

time

integer · int64

Event time.

Example: 1565769338806

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: TAKE_PROFIT_LIMIT

updateTime

integer · int64

last update time

Example: 1565769342148

accountId

integer · int64

Account ID.

Example: 152950866

selfTradePreventionMode

string

self trading preventation mode

Example: EXPIRE_TAKER

preventedMatchId

string

Prevented Match ID.

Example: null

preventedQuantity

string

Prevented Quantity.

Example: null

GET/papi/v1/margin/allOrders

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

Example Responses

[
  {
    "clientOrderId": "D2KDy4DIeS56PvkM13f8cP",
    "cummulativeQuoteQty": "0.00000000",
    "executedQty": "0.00000000",
    "icebergQty": "0.00000000",
    "isWorking": false,
    "orderId": 41295,
    "origQty": "5.31000000",
    "price": "0.22500000",
    "side": "SELL",
    "status": "CANCELED",
    "stopPrice": "0.18000000",
    "symbol": "BNBBTC",
    "time": 1565769338806,
    "timeInForce": "GTC",
    "type": "TAKE_PROFIT_LIMIT",
    "updateTime": 1565769342148,
    "accountId": 152950866,
    "selfTradePreventionMode": "EXPIRE_TAKER",
    "preventedMatchId": "null",
    "preventedQuantity": "null"
  }
]

application/json

Query All UM Conditional Orders (USER_DATA)

Query All UM Conditional Orders

GET

/papi/v1/um/conditional/allOrders

https://papi.binance.com

Query All UM Conditional 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 UM Conditional 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 symbol is omitted

Query All UM Conditional 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 UM Conditional 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

strategyId

integer · int64

Example: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 1000

Number of results returned.

Example: 500

Default: 500

recvWindow

integer · int64

Example: 5000

Query All UM Conditional Orders (USER_DATA) › Responses

200

All UM Conditional Orders

object

newClientStrategyId

string

New Client Strategy ID.

Example: abc

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: TRIGGERED

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 0.40

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 12132343435

status

string

Normal order status after trigger if appliable, only have when the strategy is triggered

Example: NEW

bookTime

integer · int64

order time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

triggerTime

integer · int64

Trigger Time.

Example: 1566818724750

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: 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

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

priceMatch

string

Price Match.

Example: NONE

GET/papi/v1/um/conditional/allOrders

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

Example Responses

[
  {
    "newClientStrategyId": "abc",
    "strategyId": 123445,
    "strategyStatus": "TRIGGERED",
    "strategyType": "TRAILING_STOP_MARKET",
    "origQty": "0.40",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "stopPrice": "9300",
    "symbol": "BTCUSDT",
    "orderId": 12132343435,
    "status": "NEW",
    "bookTime": 1566818724710,
    "updateTime": 1566818724722,
    "triggerTime": 1566818724750,
    "timeInForce": "GTC",
    "type": "MARKET",
    "activatePrice": "9020",
    "priceRate": "0.3",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0,
    "priceMatch": "NONE"
  }
]

application/json

Query All UM Orders (USER_DATA)

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

GET

/papi/v1/um/allOrders

https://papi.binance.com

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

orderId

integer · int64

Example: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 1000

Number of results returned.

Example: 500

Default: 500

recvWindow

integer · int64

Example: 5000

Query All UM Orders (USER_DATA) › Responses

200

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

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: LIMIT

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: NEW

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

update time

Example: 1579276756075

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

priceMatch

string

Price Match.

Example: NONE

GET/papi/v1/um/allOrders

curl --request GET \
  --url 'https://papi.binance.com/papi/v1/um/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": "LIMIT",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "status": "NEW",
    "symbol": "BTCUSDT",
    "time": 1579276756075,
    "timeInForce": "GTC",
    "type": "LIMIT",
    "updateTime": 1579276756075,
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0,
    "priceMatch": "NONE"
  }
]

application/json

Query CM Conditional Order History (USER_DATA)

Query CM Conditional Order History

GET

/papi/v1/cm/conditional/orderHistory

https://papi.binance.com

Query CM Conditional Order 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

Query CM Conditional Order 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

Query CM Conditional Order 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

Query CM Conditional Order History (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

strategyId

integer · int64

Example: 1

newClientStrategyId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Query CM Conditional Order History (USER_DATA) › Responses

200

CM Conditional Order History

newClientStrategyId

string

New Client Strategy ID.

Example: abc

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: TRIGGERED

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 0.40

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSD

orderId

integer · int64

Normal orderID after trigger if appliable，only have when the strategy is triggered

Example: 12123343534

status

string

Normal order status after trigger if appliable, only have when the strategy is triggered

Example: NEW

bookTime

integer · int64

order time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

triggerTime

integer · int64

Trigger Time.

Example: 1566818724750

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: 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

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

Price Protect.

Example: false

priceMatch

string

Price Match.

Example: NONE

GET/papi/v1/cm/conditional/orderHistory

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

Example Responses

{
  "newClientStrategyId": "abc",
  "strategyId": 123445,
  "strategyStatus": "TRIGGERED",
  "strategyType": "TRAILING_STOP_MARKET",
  "origQty": "0.40",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "stopPrice": "9300",
  "symbol": "BTCUSD",
  "orderId": 12123343534,
  "status": "NEW",
  "bookTime": 1566818724710,
  "updateTime": 1566818724722,
  "triggerTime": 1566818724750,
  "timeInForce": "GTC",
  "type": "MARKET",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false,
  "priceMatch": "NONE"
}

application/json

Query CM Modify Order History (TRADE)

Get order modification history

GET

/papi/v1/cm/orderAmendment

https://papi.binance.com

Query CM Modify Order 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

Query CM Modify Order 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

Query CM Modify Order 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

Query CM Modify Order History (TRADE) › 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

orderId

integer · int64

Order ID

Example: 1

origClientOrderId

string

Client order ID

Example: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 1000

Number of results returned.

Example: 500

Default: 100

recvWindow

integer · int64

Example: 5000

Query CM Modify Order History (TRADE) › Responses

200

CM Modify Order History

object

amendmentId

integer · int64

Order modification ID

Example: 5363

symbol

string

Trade symbol, if existing.

Example: BTCUSD_PERP

pair

string

Pair.

Example: BTCUSD

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 20072994037

clientOrderId

string

Client Order ID.

Example: LJ9R4QZDihCaS8UAOOLpgW

time

integer · int64

Order modification time

Example: 1629184560899

object

Amendment.

GET/papi/v1/cm/orderAmendment

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

Example Responses

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

application/json

Query Current CM Open Conditional Order (USER_DATA)

Query Current CM Open Conditional Order

GET

/papi/v1/cm/conditional/openOrder

https://papi.binance.com

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

symbol

string · required

Symbol

Example: BTCUSD_200925

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

strategyId

integer · int64

Example: 1

newClientStrategyId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Query Current CM Open Conditional Order (USER_DATA) › Responses

200

Current CM Open Conditional Order

newClientStrategyId

string

New Client Strategy ID.

Example: abc

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: NEW

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 0.40

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSD

bookTime

integer · int64

order time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

timeInForce

string

Time In Force.

Example: GTC

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

GET/papi/v1/cm/conditional/openOrder

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

Example Responses

{
  "newClientStrategyId": "abc",
  "strategyId": 123445,
  "strategyStatus": "NEW",
  "strategyType": "TRAILING_STOP_MARKET",
  "origQty": "0.40",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "stopPrice": "9300",
  "symbol": "BTCUSD",
  "bookTime": 1566818724710,
  "updateTime": 1566818724722,
  "timeInForce": "GTC",
  "activatePrice": "9020",
  "priceRate": "0.3"
}

application/json

Query Current CM Open Order (USER_DATA)

Query current CM open order

GET

/papi/v1/cm/openOrder

https://papi.binance.com

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

symbol

string · required

Trading pair.

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

Order ID.

Example: 1917641

origClientOrderId

string

User-defined order ID.

Example: abc

recvWindow

integer · int64

Example: 5000

Query Current CM Open Order (USER_DATA) › Responses

200

Current CM Open Order

object

avgPrice

string

Avg Price.

Example: 0.0

clientOrderId

string

Client Order ID.

Example: abc

cumBase

string

Cum Base.

Example: 0

executedQty

string

Executed Qty.

Example: 0

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: LIMIT

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: NEW

symbol

string

Trade symbol, if existing.

Example: BTCUSD_200925

pair

string

Pair.

Example: BTCUSD

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

update time

Example: 1579276756075

GET/papi/v1/cm/openOrder

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

Example Responses

[
  {
    "avgPrice": "0.0",
    "clientOrderId": "abc",
    "cumBase": "0",
    "executedQty": "0",
    "orderId": 1917641,
    "origQty": "0.40",
    "origType": "LIMIT",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "status": "NEW",
    "symbol": "BTCUSD_200925",
    "pair": "BTCUSD",
    "time": 1579276756075,
    "timeInForce": "GTC",
    "type": "LIMIT",
    "updateTime": 1579276756075
  }
]

application/json

Query Current Margin Open Order (USER_DATA)

Query Current Margin Open Order

GET

/papi/v1/margin/openOrders

https://papi.binance.com

Query Current Margin 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 Margin 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 Weight5

Query Current Margin 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 Margin Open Order (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

recvWindow

integer · int64

Value cannot be greater than 60000

Example: 5000

Query Current Margin Open Order (USER_DATA) › Responses

200

Current Margin Open Order

object

clientOrderId

string

Client Order ID.

Example: qhcZw71gAkCCTv0t0k8LUK

cummulativeQuoteQty

string

Cummulative Quote Qty.

Example: 0.00000000

executedQty

string

Executed Qty.

Example: 0.00000000

icebergQty

string

Iceberg Qty.

Example: 0.00000000

isWorking

boolean

Is Working.

Example: true

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 211842552

origQty

string

Orig Qty.

Example: 0.30000000

price

string

Price.

Example: 0.00475010

side

string

Side.

Example: SELL

status

string

Enum：completed，processing

Example: NEW

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 0.00000000

symbol

string

Trade symbol, if existing.

Example: BNBBTC

time

integer · int64

Event time.

Example: 1562040170089

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

last update time

Example: 1562040170089

accountId

integer · int64

Account ID.

Example: 152950866

selfTradePreventionMode

string

self trading preventation mode

Example: EXPIRE_TAKER

preventedMatchId

string

Prevented Match ID.

Example: null

preventedQuantity

string

Prevented Quantity.

Example: null

GET/papi/v1/margin/openOrders

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

Example Responses

[
  {
    "clientOrderId": "qhcZw71gAkCCTv0t0k8LUK",
    "cummulativeQuoteQty": "0.00000000",
    "executedQty": "0.00000000",
    "icebergQty": "0.00000000",
    "isWorking": true,
    "orderId": 211842552,
    "origQty": "0.30000000",
    "price": "0.00475010",
    "side": "SELL",
    "status": "NEW",
    "stopPrice": "0.00000000",
    "symbol": "BNBBTC",
    "time": 1562040170089,
    "timeInForce": "GTC",
    "type": "LIMIT",
    "updateTime": 1562040170089,
    "accountId": 152950866,
    "selfTradePreventionMode": "EXPIRE_TAKER",
    "preventedMatchId": "null",
    "preventedQuantity": "null"
  }
]

application/json

Query Current UM Open Conditional Order (USER_DATA)

Query Current UM Open Conditional Order

GET

/papi/v1/um/conditional/openOrder

https://papi.binance.com

Query Current UM Open Conditional 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 UM Open Conditional 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 UM Open Conditional 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 UM Open Conditional Order (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

strategyId

integer · int64

Example: 1

newClientStrategyId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Query Current UM Open Conditional Order (USER_DATA) › Responses

200

Current UM Open Conditional Order

newClientStrategyId

string

New Client Strategy ID.

Example: abc

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: NEW

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 0.40

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

bookTime

integer · int64

order time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

timeInForce

string

Time In Force.

Example: GTC

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

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

priceMatch

string

Price Match.

Example: NONE

GET/papi/v1/um/conditional/openOrder

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

Example Responses

{
  "newClientStrategyId": "abc",
  "strategyId": 123445,
  "strategyStatus": "NEW",
  "strategyType": "TRAILING_STOP_MARKET",
  "origQty": "0.40",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "stopPrice": "9300",
  "symbol": "BTCUSDT",
  "bookTime": 1566818724710,
  "updateTime": 1566818724722,
  "timeInForce": "GTC",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 0,
  "priceMatch": "NONE"
}

application/json

Query Current UM Open Order (USER_DATA)

Query current UM open order

GET

/papi/v1/um/openOrder

https://papi.binance.com

Query Current UM 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 UM 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 UM 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 UM Open Order (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

orderId

integer · int64

Example: 1

origClientOrderId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Query Current UM Open Order (USER_DATA) › Responses

200

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

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 1917641

origQty

string

Orig Qty.

Example: 0.40

origType

string

Orig Type.

Example: LIMIT

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

status

string

Enum：completed，processing

Example: NEW

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: LIMIT

updateTime

integer · int64

last update time

Example: 1579276756075

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

priceMatch

string

Price Match.

Example: NONE

GET/papi/v1/um/openOrder

curl --request GET \
  --url 'https://papi.binance.com/papi/v1/um/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": "LIMIT",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "status": "NEW",
  "symbol": "BTCUSDT",
  "time": 1579276756075,
  "timeInForce": "GTC",
  "type": "LIMIT",
  "updateTime": 1579276756075,
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 0,
  "priceMatch": "NONE"
}

application/json

Query Margin Account's all OCO (USER_DATA)

Query all OCO for a specific margin account based on provided optional parameters

GET

/papi/v1/margin/allOrderList

https://papi.binance.com

Query Margin Account's all OCO (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 Margin Account's all OCO (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 Weight100

Query Margin Account's all OCO (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 Margin Account's all OCO (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

fromId

integer · int64

Trade ID to fetch from.

Example: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 1000

Number of results returned.

Example: 500

Default: 100

recvWindow

integer · int64

Value cannot be greater than 60000

Example: 5000

Query Margin Account's all OCO (USER_DATA) › Responses

200

Margin Account's all OCO

object

orderListId

integer · int64

Order List ID.

Example: 29

contingencyType

string

Contingency Type.

Example: OCO

listStatusType

string

List Status Type.

Example: EXEC_STARTED

listOrderStatus

string

List Order Status.

Example: EXECUTING

listClientOrderId

string

List Client Order ID.

Example: amEEAXryFzFwYF1FeRpUoZ

transactionTime

integer · int64

Transaction Time.

Example: 1565245913483

symbol

string

Trade symbol, if existing.

Example: LTCBTC

object[]

Orders.

GET/papi/v1/margin/allOrderList

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

Example Responses

[
  {
    "orderListId": 29,
    "contingencyType": "OCO",
    "listStatusType": "EXEC_STARTED",
    "listOrderStatus": "EXECUTING",
    "listClientOrderId": "amEEAXryFzFwYF1FeRpUoZ",
    "transactionTime": 1565245913483,
    "symbol": "LTCBTC",
    "orders": [
      {
        "symbol": "LTCBTC",
        "orderId": 4,
        "clientOrderId": "oD7aesZqjEGlZrbtRpy5zB"
      }
    ]
  }
]

application/json

Query Margin Account's Open OCO (USER_DATA)

Query Margin Account's Open OCO

GET

/papi/v1/margin/openOrderList

https://papi.binance.com

Query Margin Account's Open OCO (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 Margin Account's Open OCO (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 Margin Account's Open OCO (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 Margin Account's Open OCO (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

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

Example: 1770736694138

recvWindow

integer · int64

Value cannot be greater than 60000

Example: 5000

Query Margin Account's Open OCO (USER_DATA) › Responses

200

Margin Account's Open OCO

object

orderListId

integer · int64

Order List ID.

Example: 31

contingencyType

string

Contingency Type.

Example: OCO

listStatusType

string

List Status Type.

Example: EXEC_STARTED

listOrderStatus

string

List Order Status.

Example: EXECUTING

listClientOrderId

string

List Client Order ID.

Example: wuB13fmulKj3YjdqWEcsnp

transactionTime

integer · int64

Transaction Time.

Example: 1565246080644

symbol

string

Trade symbol, if existing.

Example: LTCBTC

object[]

Orders.

GET/papi/v1/margin/openOrderList

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

Example Responses

[
  {
    "orderListId": 31,
    "contingencyType": "OCO",
    "listStatusType": "EXEC_STARTED",
    "listOrderStatus": "EXECUTING",
    "listClientOrderId": "wuB13fmulKj3YjdqWEcsnp",
    "transactionTime": 1565246080644,
    "symbol": "LTCBTC",
    "orders": [
      {
        "symbol": "LTCBTC",
        "orderId": 4,
        "clientOrderId": "r3EH2N76dHfLoSZWIUw1bT"
      }
    ]
  }
]

application/json

Query UM Conditional Order History (USER_DATA)

Query UM Conditional Order History

GET

/papi/v1/um/conditional/orderHistory

https://papi.binance.com

Query UM Conditional Order 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

Query UM Conditional Order 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

Query UM Conditional Order 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

Query UM Conditional Order History (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

strategyId

integer · int64

Example: 1

newClientStrategyId

string

Example: 1

recvWindow

integer · int64

Example: 5000

Query UM Conditional Order History (USER_DATA) › Responses

200

UM Conditional Order History

newClientStrategyId

string

New Client Strategy ID.

Example: abc

strategyId

integer · int64

Strategy ID.

Example: 123445

strategyStatus

string

Strategy Status.

Example: TRIGGERED

strategyType

string

Strategy Type.

Example: TRAILING_STOP_MARKET

origQty

string

Orig Qty.

Example: 0.40

price

string

Price.

Example: 0

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: BUY

positionSide

string

BOTH means that it is the position of One-way Mode

Example: SHORT

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

orderId

integer · int64

Normal orderID after trigger if appliable，only have when the strategy is triggered

Example: 12132343435

status

string

Normal order status after trigger if appliable, only have when the strategy is triggered

Example: NEW

bookTime

integer · int64

order time

Example: 1566818724710

updateTime

integer · int64

last update time

Example: 1566818724722

triggerTime

integer · int64

Trigger Time.

Example: 1566818724750

timeInForce

string

Time In Force.

Example: GTC

type

string

Normal order type after trigger if appliable

Example: 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

workingType

string

Working Type.

Example: CONTRACT_PRICE

priceProtect

boolean

Price Protect.

Example: false

selfTradePreventionMode

string

self trading preventation mode

Example: NONE

goodTillDate

integer · int64

order pre-set auot cancel time for TIF GTD order

Example: 0

GET/papi/v1/um/conditional/orderHistory

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

Example Responses

{
  "newClientStrategyId": "abc",
  "strategyId": 123445,
  "strategyStatus": "TRIGGERED",
  "strategyType": "TRAILING_STOP_MARKET",
  "origQty": "0.40",
  "price": "0",
  "reduceOnly": false,
  "side": "BUY",
  "positionSide": "SHORT",
  "stopPrice": "9300",
  "symbol": "BTCUSDT",
  "orderId": 12132343435,
  "status": "NEW",
  "bookTime": 1566818724710,
  "updateTime": 1566818724722,
  "triggerTime": 1566818724750,
  "timeInForce": "GTC",
  "type": "MARKET",
  "activatePrice": "9020",
  "priceRate": "0.3",
  "workingType": "CONTRACT_PRICE",
  "priceProtect": false,
  "selfTradePreventionMode": "NONE",
  "goodTillDate": 0
}

application/json

Query UM Modify Order History (TRADE)

Get order modification history

GET

/papi/v1/um/orderAmendment

https://papi.binance.com

Query UM Modify Order 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

Query UM Modify Order 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

Query UM Modify Order 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

Query UM Modify Order History (TRADE) › 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

orderId

integer · int64

Order ID

Example: 1

origClientOrderId

string

Client order ID

Example: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 1000

Number of results returned.

Example: 500

Default: 100

recvWindow

integer · int64

Example: 5000

Query UM Modify Order History (TRADE) › Responses

200

UM Modify Order History

object

amendmentId

integer · int64

Order modification ID

Example: 5363

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

pair

string

Pair.

Example: BTCUSDT

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 20072994037

clientOrderId

string

Client Order ID.

Example: LJ9R4QZDihCaS8UAOOLpgW

time

integer · int64

Order modification time

Example: 1629184560899

object

Amendment.

priceMatch

string

Price Match.

Example: NONE

GET/papi/v1/um/orderAmendment

curl --request GET \
  --url 'https://papi.binance.com/papi/v1/um/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
    },
    "priceMatch": "NONE"
  }
]

application/json

Query User's CM Force Orders (USER_DATA)

Query User's CM Force Orders

GET

/papi/v1/cm/forceOrders

https://papi.binance.com

Query User's CM 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

Query User's CM 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

Query User's CM 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

Query User's CM 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

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 100

Number of results returned.

Example: 500

Default: 50

recvWindow

integer · int64

The value cannot be greater than 60000

Example: 5000

Query User's CM Force Orders (USER_DATA) › Responses

200

User's CM Force Orders

object

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 165123080

symbol

string

Trade symbol, if existing.

Example: BTCUSD_200925

pair

string

Pair.

Example: BTCUSD

status

string

Enum：completed，processing

Example: FILLED

clientOrderId

string

Client Order ID.

Example: autoclose-1596542005017000006

price

string

Price.

Example: 11326.9

avgPrice

string

Avg Price.

Example: 11326.9

origQty

string

Orig Qty.

Example: 1

executedQty

string

Executed Qty.

Example: 1

cumBase

string

Cum Base.

Example: 0.00882854

timeInForce

string

Time In Force.

Example: IOC

type

string

Normal order type after trigger if appliable

Example: LIMIT

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: SELL

positionSide

string

BOTH means that it is the position of One-way Mode

Example: BOTH

origType

string

Orig Type.

Example: LIMIT

time

integer · int64

Event time.

Example: 1596542005019

updateTime

integer · int64

last update time

Example: 1596542005050

GET/papi/v1/cm/forceOrders

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

Example Responses

[
  {
    "orderId": 165123080,
    "symbol": "BTCUSD_200925",
    "pair": "BTCUSD",
    "status": "FILLED",
    "clientOrderId": "autoclose-1596542005017000006",
    "price": "11326.9",
    "avgPrice": "11326.9",
    "origQty": "1",
    "executedQty": "1",
    "cumBase": "0.00882854",
    "timeInForce": "IOC",
    "type": "LIMIT",
    "reduceOnly": false,
    "side": "SELL",
    "positionSide": "BOTH",
    "origType": "LIMIT",
    "time": 1596542005019,
    "updateTime": 1596542005050
  }
]

application/json

Query User's Margin Force Orders (USER_DATA)

Query user's margin force orders

GET

/papi/v1/margin/forceOrders

https://papi.binance.com

Query User's Margin 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

Query User's Margin 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 Weight1

Query User's Margin 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

Query User's Margin 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

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

current

integer · int64

Current page number.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results returned.

Example: 10

Default: 10

recvWindow

integer · int64

The value cannot be greater than 60000

Example: 5000

Query User's Margin Force Orders (USER_DATA) › Responses

200

User's Margin Force Orders

object[]

Rows.

total

integer · int64

Total.

Example: 1

GET/papi/v1/margin/forceOrders

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

Example Responses

{
  "rows": [
    {
      "avgPrice": "0.00388359",
      "executedQty": "31.39000000",
      "orderId": 180015097,
      "price": "0.00388110",
      "qty": "31.39000000",
      "side": "SELL",
      "symbol": "BNBBTC",
      "timeInForce": "GTC",
      "updatedTime": 1558941374745
    }
  ],
  "total": 1
}

application/json

Query User's UM Force Orders (USER_DATA)

Query User's UM Force Orders

GET

/papi/v1/um/forceOrders

https://papi.binance.com

Query User's UM 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

Query User's UM 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

Query User's UM 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

Query User's UM 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

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 100

Number of results returned.

Example: 500

Default: 50

recvWindow

integer · int64

The value cannot be greater than 60000

Example: 5000

Query User's UM Force Orders (USER_DATA) › Responses

200

User's UM Force Orders

object

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 6071832819

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

status

string

Enum：completed，processing

Example: FILLED

clientOrderId

string

Client Order ID.

Example: autoclose-1596107620040000020

price

string

Price.

Example: 10871.09

avgPrice

string

Avg Price.

Example: 10913.21000

origQty

string

Orig Qty.

Example: 0.001

executedQty

string

Executed Qty.

Example: 0.001

cumQuote

string

Cum Quote.

Example: 10.91321

timeInForce

string

Time In Force.

Example: IOC

type

string

Normal order type after trigger if appliable

Example: LIMIT

reduceOnly

boolean

Reduce Only.

Example: false

side

string

Side.

Example: SELL

positionSide

string

BOTH means that it is the position of One-way Mode

Example: BOTH

origType

string

Orig Type.

Example: LIMIT

time

integer · int64

Event time.

Example: 1596107620044

updateTime

integer · int64

last update time

Example: 1596107620087

GET/papi/v1/um/forceOrders

curl --request GET \
  --url 'https://papi.binance.com/papi/v1/um/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,
    "side": "SELL",
    "positionSide": "BOTH",
    "origType": "LIMIT",
    "time": 1596107620044,
    "updateTime": 1596107620087
  }
]

application/json

UM Account Trade List (USER_DATA)

Get trades for a specific account and UM symbol.

GET

/papi/v1/um/userTrades

https://papi.binance.com

UM 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

UM 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

UM 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

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

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

fromId

integer · int64

Trade ID to fetch from.

Example: 1

limit

integer · int64 · max: 1000

Number of results returned.

Example: 500

Default: 100

recvWindow

integer · int64

Example: 5000

UM Account Trade List (USER_DATA) › Responses

200

UM Account Trade List

object

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

id

integer · int64

ID.

Example: 67880589

orderId

integer · int64

Normal orderID after trigger if appliable, only have when the strategy is triggered

Example: 270093109

side

string

Side.

Example: SELL

price

string

Price.

Example: 28511.00

qty

string

Qty.

Example: 0.010

realizedPnl

string

Realized Pnl.

Example: 2.58500000

quoteQty

string

Quote Qty.

Example: 285.11000

commission

string

Commission.

Example: 0.11404400

commissionAsset

string

Commission Asset.

Example: USDT

time

integer · int64

Event time.

Example: 1680688557875

buyer

boolean

Buyer.

Example: false

maker

boolean

Maker.

Example: false

positionSide

string

BOTH means that it is the position of One-way Mode

Example: BOTH

GET/papi/v1/um/userTrades

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

Example Responses

[
  {
    "symbol": "BTCUSDT",
    "id": 67880589,
    "orderId": 270093109,
    "side": "SELL",
    "price": "28511.00",
    "qty": "0.010",
    "realizedPnl": "2.58500000",
    "quoteQty": "285.11000",
    "commission": "0.11404400",
    "commissionAsset": "USDT",
    "time": 1680688557875,
    "buyer": false,
    "maker": false,
    "positionSide": "BOTH"
  }
]

application/json

UM Position ADL Quantile Estimation (USER_DATA)

Query UM 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

/papi/v1/um/adlQuantile

https://papi.binance.com

UM 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

UM 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

UM 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

UM 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

Example: 5000

UM Position ADL Quantile Estimation (USER_DATA) › Responses

200

UM Position ADL Quantile Estimation

object

symbol

string

Trade symbol, if existing.

Example: ETHUSDT

object

Adl Quantile.

GET/papi/v1/um/adlQuantile

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

Example Responses

[
  {
    "symbol": "ETHUSDT",
    "adlQuantile": {
      "LONG": 3,
      "SHORT": 3,
      "BOTH": 0
    }
  }
]

application/json

New UM Algo Order (TRADE)

Place new UM conditional order

POST

/papi/v1/um/algo/order

https://papi.binance.com

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

New UM 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 UM Algo Order (TRADE) › Request Body

algoType

string · enum · required

Only support CONDITIONAL

Enum values:

CONDITIONAL

Example: CONDITIONAL

symbol

string · required

Example: BNBUSDT

side

string · enum · required

Enum values:

BUY

SELL

Example: SELL

type

string · enum · required

Conditional order type

Enum values:

STOP

TAKE_PROFIT

STOP_MARKET

TAKE_PROFIT_MARKET

TRAILING_STOP_MARKET

Example: TAKE_PROFIT

quantity

number · float · required

Order quantity

Example: 0.01

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

Enum values:

BOTH

LONG

SHORT

Example: BOTH

timeInForce

string · enum

Enum values:

IOC

GTC

FOK

GTX

GTD

Example: GTC

Default: GTC

price

number · float

Order price

Example: 750.000

triggerPrice

number · float

Trigger price

Example: 750.000

workingType

string · enum

Trigger price type. Default CONTRACT_PRICE

Enum values:

MARK_PRICE

CONTRACT_PRICE

Example: CONTRACT_PRICE

Default: CONTRACT_PRICE

priceMatch

string · enum

Can't be passed together with price

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: NONE

priceProtect

string · enum

Price protection. Default false

Enum values:

true

false

Example: false

Default: false

reduceOnly

string · enum

Cannot be sent in Hedge Mode

Enum values:

true

false

Example: false

Default: false

activatePrice

number · float

Used with TRAILING_STOP_MARKET, default as latest price

Example: 700

callbackRate

number · float

Used with TRAILING_STOP_MARKET, min 0.1, max 10 (1 = 1%)

Example: 1

clientAlgoId

string

Unique id among open orders. Auto-generated if not sent

Example: 6B2I9XVcJpCjqPAJ4YoFX7

newOrderRespType

string · enum

Enum values:

ACK

RESULT

Example: ACK

Default: ACK

selfTradePreventionMode

string · enum

Enum values:

NONE

EXPIRE_TAKER

EXPIRE_MAKER

EXPIRE_BOTH

Example: NONE

Default: NONE

goodTillDate

integer · int64

Order cancel time for GTD timeInForce, mandatory when timeInForce is GTD

Example: 0

recvWindow

integer · int64 · max: 60000

Example: 5000

New UM Algo Order (TRADE) › Responses

200

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

selfTradePreventionMode

string

Example: EXPIRE_MAKER

workingType

string

Example: CONTRACT_PRICE

priceMatch

string

Example: NONE

priceProtect

boolean

Example: false

reduceOnly

boolean

Example: false

activatePrice

string

Example:

callbackRate

string

Example:

createTime

integer · int64

Example: 1750485492076

updateTime

integer · int64

Example: 1750485492076

triggerTime

integer · int64

Example: 0

goodTillDate

integer · int64

Example: 0

POST/papi/v1/um/algo/order

curl --request POST \
  --url https://papi.binance.com/papi/v1/um/algo/order \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-MBX-APIKEY: <string>' \
  --data algoType=CONDITIONAL \
  --data symbol=BNBUSDT \
  --data side=SELL \
  --data type=TAKE_PROFIT \
  --data quantity=0.01 \
  --data timestamp=1770736694138

Example Request Body

{
  "algoType": "CONDITIONAL",
  "symbol": "BNBUSDT",
  "side": "SELL",
  "type": "TAKE_PROFIT",
  "quantity": "0.01",
  "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",
  "selfTradePreventionMode": "EXPIRE_MAKER",
  "workingType": "CONTRACT_PRICE",
  "priceMatch": "NONE",
  "priceProtect": false,
  "reduceOnly": false,
  "activatePrice": "",
  "callbackRate": "",
  "createTime": 1750485492076,
  "updateTime": 1750485492076,
  "triggerTime": 0,
  "goodTillDate": 0
}

application/json

Cancel UM Algo Order (TRADE)

Cancel an active UM algo order

DELETE

/papi/v1/um/algo/order

https://papi.binance.com

Cancel UM 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 UM 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 UM 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 UM 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

Algo order ID

Example: 2146760

clientAlgoId

string

Client algo order ID

Example: 6B2I9XVcJpCjqPAJ4YoFX7

recvWindow

integer · int64 · max: 60000

Example: 5000

Cancel UM Algo Order (TRADE) › Responses

200

Cancel UM Algo Order

complete

boolean

Example: true

DELETE/papi/v1/um/algo/order

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

Example Responses

{
  "complete": true
}

application/json

Cancel All UM Algo Open Orders (TRADE)

Cancel All UM Algo Open Orders

DELETE

/papi/v1/um/algo/allOpenOrders

https://papi.binance.com

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

symbol

string · required

Symbol

Example: BNBUSDT

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 UM Algo Open Orders (TRADE) › Responses

200

Cancel All UM Algo Open Orders

code

integer

Example: 200

msg

string

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

DELETE/papi/v1/um/algo/allOpenOrders

curl --request DELETE \
  --url 'https://papi.binance.com/papi/v1/um/algo/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

Query Current UM Open Algo Order (USER_DATA)

Check an UM algo order's status. Orders will not be found if: status is CANCELED/EXPIRED with no fills and created 3+ days ago; or created 90+ days ago.

GET

/papi/v1/um/algo/algoOrder

https://papi.binance.com

Query Current UM Open 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 Current UM Open 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 Current UM Open 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 Current UM Open 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

Algo order ID

Example: 2146760

clientAlgoId

string

Client algo order ID

Example: 6B2I9XVcJpCjqPAJ4YoFX7

recvWindow

integer · int64 · max: 60000

Example: 5000

Query Current UM Open Algo Order (USER_DATA) › Responses

200

Query UM 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

Example:

actualPrice

string

Example: 0.00000

triggerPrice

string

Example: 750.000

price

string

Example: 750.000

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/papi/v1/um/algo/algoOrder

curl --request GET \
  --url 'https://papi.binance.com/papi/v1/um/algo/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",
  "triggerPrice": "750.000",
  "price": "750.000",
  "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 All Current UM Open Algo Orders (USER_DATA)

Get all UM open algo orders on a symbol. If the symbol is not sent, orders for all symbols will be returned.

GET

/papi/v1/um/algo/openAlgoOrders

https://papi.binance.com

Query All Current UM Open 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 Current UM Open Algo Orders (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

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

timestamp

integer · int64 · required

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

Example: 1770736694138

algoType

string

Example: CONDITIONAL

symbol

string

Example: BNBUSDT

algoId

integer · int64

Example: 2146760

recvWindow

integer · int64 · max: 60000

Example: 5000

Query All Current UM Open Algo Orders (USER_DATA) › Responses

200

Query All Current UM Open 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: NEW

triggerPrice

string

Example: 750.000

price

string

Example: 750.000

selfTradePreventionMode

string

Example: NONE

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: 1750485492076

triggerTime

integer · int64

Example: 0

goodTillDate

integer · int64

Example: 0

GET/papi/v1/um/algo/openAlgoOrders

curl --request GET \
  --url 'https://papi.binance.com/papi/v1/um/algo/openAlgoOrders?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": "NEW",
    "triggerPrice": "750.000",
    "price": "750.000",
    "selfTradePreventionMode": "NONE",
    "workingType": "CONTRACT_PRICE",
    "priceMatch": "NONE",
    "closePosition": false,
    "priceProtect": false,
    "reduceOnly": false,
    "createTime": 1750485492076,
    "updateTime": 1750485492076,
    "triggerTime": 0,
    "goodTillDate": 0
  }
]

application/json

Query UM Algo Order History (USER_DATA)

Get all algo orders: ACTIVE, CANCELED, TRIGGERED or FINISHED.

GET

/papi/v1/um/algo/allAlgoOrders

https://papi.binance.com

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

Query UM Algo Order 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 Weight5

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

Query UM Algo Order History (USER_DATA) › Query Parameters

symbol

string · required

Example: BNBUSDT

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

Only return orders >= this algoId

Example: 2146760

startTime

integer · int64

Example: 1770130294138

endTime

integer · int64

Example: 1770736694138

limit

integer · int64 · max: 1000

Default 500; max 1000

Example: 500

Default: 500

recvWindow

integer · int64 · max: 60000

Example: 5000

Query UM Algo Order History (USER_DATA) › Responses

200

Query UM Algo Order History

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

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/papi/v1/um/algo/allAlgoOrders

curl --request GET \
  --url 'https://papi.binance.com/papi/v1/um/algo/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",
    "selfTradePreventionMode": "EXPIRE_MAKER",
    "workingType": "CONTRACT_PRICE",
    "priceMatch": "NONE",
    "closePosition": false,
    "priceProtect": false,
    "reduceOnly": false,
    "createTime": 1750485492076,
    "updateTime": 1750514545091,
    "triggerTime": 0,
    "goodTillDate": 0
  }
]

application/json

Futures TradFi Perps Contract (USER_DATA)

Sign TradFi-Perps agreement contract

POST

/papi/v1/um/stock/contract

https://papi.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 Weight5

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

Example: 200

msg

string

Example: success

POST/papi/v1/um/stock/contract

curl --request POST \
  --url https://papi.binance.com/papi/v1/um/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