Trade

Endpoint

Cancel Algo Order (TRADE)

Cancel an active algo order.

WSS

algoOrder.cancel

wss://ws-fapi.binance.com/ws-fapi/v1

Cancel Algo Order (TRADE) › Authorization

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

Cancel Algo Order (TRADE) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Cancel Algo Order (TRADE) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

algoOrder.cancel

Example: algoOrder.cancel

object · required

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

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

algoId

integer · int64

Algo Id.

Example: 2000000002162519

clientAlgoId

string

Client Algo Id.

Example: rDMG8WSde6LkyMNtk6s825

recvWindow

integer · int64

Recv Window.

Example: 5000

Cancel Algo Order (TRADE) › Responses

Successful Response

Cancel Algo Order

id

string

Example: unique-cancel-request-id-5678

status

integer · int64

Example: 200

object

algoId

integer · int64

Example: 2000000002162519

clientAlgoId

string

Example: rDMG8WSde6LkyMNtk6s825

code

string

Example: 200

msg

string

Example: success

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 6

WSSalgoOrder.cancel

wscat -c wss://ws-fapi.binance.com/ws-fapi/v1 -x '{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "algoOrder.cancel",
  "params": {
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}'

Example Request

{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "algoOrder.cancel",
  "params": {
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}

json

application/json

Example Responses

{
  "id": "unique-cancel-request-id-5678",
  "status": 200,
  "result": {
    "algoId": 2000000002162519,
    "clientAlgoId": "rDMG8WSde6LkyMNtk6s825",
    "code": "200",
    "msg": "success"
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 6
    }
  ]
}

json

application/json

Cancel Order (TRADE)

Cancel an active order.

WSS

order.cancel

wss://ws-fapi.binance.com/ws-fapi/v1

Cancel Order (TRADE) › Authorization

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

Cancel Order (TRADE) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Cancel Order (TRADE) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

order.cancel

Example: order.cancel

object · required

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

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

orderId

integer · int64

Order Id.

Example: 1

origClientOrderId

string

Orig Client Order Id.

Example: 1

recvWindow

integer · int64

Recv Window.

Example: 5000

Cancel Order (TRADE) › Responses

Successful Response

Cancel Order

id

string

Example: 5633b6a2-90a9-4192-83e7-925c90b6a2fd

status

integer · int64

Example: 200

object

clientOrderId

string

Example: myOrder1

cumQty

string

Example: 0

executedQty

string

Example: 0

orderId

integer · int64

Example: 283194212

origQty

string

Example: 11

origType

string

Example: TRAILING_STOP_MARKET

price

string

Example: 0

reduceOnly

boolean

Example: false

side

string

Example: BUY

positionSide

string

Example: SHORT

status

string

Example: CANCELED

stopPrice

string

Example: 9300

closePosition

boolean

Example: false

symbol

string

Example: BTCUSDT

timeInForce

string

Example: GTC

type

string

Example: TRAILING_STOP_MARKET

activatePrice

string

Example: 9020

priceRate

string

Example: 0.3

updateTime

integer · int64

Example: 1571110484038

workingType

string

Example: CONTRACT_PRICE

priceProtect

boolean

Example: false

priceMatch

string

Example: NONE

selfTradePreventionMode

string

Example: NONE

goodTillDate

integer · int64

Example: 0

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 1

WSSorder.cancel

wscat -c wss://ws-fapi.binance.com/ws-fapi/v1 -x '{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "order.cancel",
  "params": {
    "symbol": "BTCUSDT",
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}'

Example Request

{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "order.cancel",
  "params": {
    "symbol": "BTCUSDT",
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}

json

application/json

Example Responses

{
  "id": "5633b6a2-90a9-4192-83e7-925c90b6a2fd",
  "status": 200,
  "result": {
    "clientOrderId": "myOrder1",
    "cumQty": "0",
    "executedQty": "0",
    "orderId": 283194212,
    "origQty": "11",
    "origType": "TRAILING_STOP_MARKET",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "status": "CANCELED",
    "stopPrice": "9300",
    "closePosition": false,
    "symbol": "BTCUSDT",
    "timeInForce": "GTC",
    "type": "TRAILING_STOP_MARKET",
    "activatePrice": "9020",
    "priceRate": "0.3",
    "updateTime": 1571110484038,
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "priceMatch": "NONE",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 1
    }
  ]
}

json

application/json

Modify Order (TRADE)

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

WSS

order.modify

wss://ws-fapi.binance.com/ws-fapi/v1

Modify Order (TRADE) › Authorization

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

Modify Order (TRADE) › Request Weight

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

Learn more in the Rate limits section.

IP Weight

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

Modify Order (TRADE) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

order.modify

Example: order.modify

object · required

symbol

string · required

Symbol.

Example: BTCUSDT

side

string · enum · required

SELL, BUY

Enum values:

BUY

SELL

Example: BUY

quantity

number · float · required

Order quantity, cannot be sent with closePosition=true

Example: 1.0

price

number · float · required

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

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

orderId

integer · int64

Order Id.

Example: 1

origClientOrderId

string

Orig Client Order Id.

Example: 1

priceMatch

string · enum

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

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

modifyId

integer · int64

User-defined modification identifier, returned as-is in the response. Optional; not validated for uniqueness.

Example: 1

recvWindow

integer · int64

Recv Window.

Example: 5000

Modify Order (TRADE) › Responses

Successful Response

Modify Order

id

string

Example: c8c271ba-de70-479e-870c-e64951c753d9

status

integer · int64

Example: 200

object

orderId

integer · int64

Example: 328971409

symbol

string

Example: BTCUSDT

status

string

Example: NEW

clientOrderId

string

Example: xGHfltUMExx0TbQstQQfRX

modifyId

integer · int64

user-defined modification identifier, only returned if provided in the request

Example: 1

price

string

Example: 43769.10

origQty

string

Example: 0.110

executedQty

string

Example: 0.000

cumQty

string

Example: 0.000

timeInForce

string

Example: GTC

type

string

Example: LIMIT

reduceOnly

boolean

Example: false

closePosition

boolean

Example: false

side

string

Example: SELL

positionSide

string

Example: SHORT

stopPrice

string

Example: 0.00

workingType

string

Example: CONTRACT_PRICE

priceProtect

boolean

Example: false

origType

string

Example: LIMIT

priceMatch

string

Example: NONE

selfTradePreventionMode

string

Example: NONE

goodTillDate

integer · int64

Example: 0

updateTime

integer · int64

Example: 1703426756190

object[]

rateLimitType

string

Example: ORDERS

interval

string

Example: SECOND

intervalNum

integer · int64

Example: 10

limit

integer · int64

Example: 300

count

integer · int64

Example: 1

WSSorder.modify

wscat -c wss://ws-fapi.binance.com/ws-fapi/v1 -x '{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "order.modify",
  "params": {
    "symbol": "BTCUSDT",
    "side": "BUY",
    "quantity": "1.0",
    "price": "1.0",
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}'

Example Request

{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "order.modify",
  "params": {
    "symbol": "BTCUSDT",
    "side": "BUY",
    "quantity": "1.0",
    "price": "1.0",
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}

json

application/json

Example Responses

{
  "id": "c8c271ba-de70-479e-870c-e64951c753d9",
  "status": 200,
  "result": {
    "orderId": 328971409,
    "symbol": "BTCUSDT",
    "status": "NEW",
    "clientOrderId": "xGHfltUMExx0TbQstQQfRX",
    "modifyId": 1,
    "price": "43769.10",
    "origQty": "0.110",
    "executedQty": "0.000",
    "cumQty": "0.000",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "reduceOnly": false,
    "closePosition": false,
    "side": "SELL",
    "positionSide": "SHORT",
    "stopPrice": "0.00",
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "origType": "LIMIT",
    "priceMatch": "NONE",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0,
    "updateTime": 1703426756190
  },
  "rateLimits": [
    {
      "rateLimitType": "ORDERS",
      "interval": "SECOND",
      "intervalNum": 10,
      "limit": 300,
      "count": 1
    }
  ]
}

json

application/json

New Algo Order (TRADE)

Send in a new algo order.

WSS

algoOrder.place

wss://ws-fapi.binance.com/ws-fapi/v1

New Algo Order (TRADE) › Authorization

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

New Algo Order (TRADE) › Request Weight

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

Learn more in the Rate limits section.

IP Weight0

New Algo Order (TRADE) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

algoOrder.place

Example: algoOrder.place

object · required

algoType

string · enum · required

Only support CONDITIONAL

Enum values:

CONDITIONAL

Example: CONDITIONAL

symbol

string · required

Symbol.

Example: BTCUSDT

side

string · enum · required

Side.

Enum values:

BUY

SELL

Example: BUY

type

string · enum · required

For CONDITIONAL algoType, STOP_MARKET/TAKE_PROFIT_MARKET/STOP/TAKE_PROFIT/TRAILING_STOP_MARKET as order type

Enum values:

STOP_MARKET

TAKE_PROFIT_MARKET

STOP

TAKE_PROFIT

TRAILING_STOP_MARKET

Example: STOP_MARKET

timestamp

integer · int64 · required

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

Example: 1770736694138

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

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

timeInForce

string · enum

IOC or GTC or FOK, default GTC

Enum values:

IOC

GTC

FOK

Example: GTC

quantity

number · float

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

Example: 1.0

price

number · float

Price.

Example: 1.0

triggerPrice

number · float

Trigger Price.

Example: 1.0

workingType

string · enum

triggerPrice triggered by: MARK_PRICE, CONTRACT_PRICE. Default CONTRACT_PRICE

Enum values:

MARK_PRICE

CONTRACT_PRICE

Example: MARK_PRICE

Default: CONTRACT_PRICE

priceMatch

string · enum

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

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

closePosition

string · enum

Close-All，used with STOP_MARKET or TAKE_PROFIT_MARKET.

Enum values:

true

false

Example: true

priceProtect

string · enum

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

Enum values:

true

false

Example: true

Default: false

reduceOnly

string · enum

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

Enum values:

true

false

Example: true

Default: false

activatePrice

number · float

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

Example: 1.0

callbackRate

number · float · min: 0.1 · max: 10

Used with TRAILING_STOP_MARKET orders

Example: 1

clientAlgoId

string

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

Example: 1

newOrderRespType

string · enum

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

Enum values:

ACK

RESULT

Example: ACK

selfTradePreventionMode

string · enum

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

Enum values:

NONE

EXPIRE_TAKER

EXPIRE_BOTH

EXPIRE_MAKER

Example: EXPIRE_TAKER

goodTillDate

integer · int64

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

Example: 1770736694138

recvWindow

integer · int64

Recv Window.

Example: 5000

New Algo Order (TRADE) › Responses

Successful Response

New Algo Order

id

string

Example: 06c9dbd8-ccbf-4ecf-a29c-fe31495ac73f

status

integer · int64

Example: 200

object

algoId

integer · int64

Example: 3000000000003505

clientAlgoId

string

Example: 0Xkl1p621E4EryvufmYre1

algoType

string

Example: CONDITIONAL

orderType

string

Example: TAKE_PROFIT

symbol

string

Example: BTCUSDT

side

string

Example: SELL

positionSide

string

Example: SHORT

timeInForce

string

Example: GTC

quantity

string

Example: 1.000

algoStatus

string

Example: NEW

triggerPrice

string

Example: 120000.00

price

string

Example: 160000.00

icebergQuantity

string

Example: null

selfTradePreventionMode

string

Example: EXPIRE_MAKER

workingType

string

Example: CONTRACT_PRICE

priceMatch

string

Example: NONE

closePosition

boolean

Example: false

priceProtect

boolean

Example: false

reduceOnly

boolean

Example: false

createTime

integer · int64

Example: 1762507264142

updateTime

integer · int64

Example: 1762507264143

triggerTime

integer · int64

Example: 0

goodTillDate

integer · int64

Example: 0

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 1

WSSalgoOrder.place

wscat -c wss://ws-fapi.binance.com/ws-fapi/v1 -x '{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "algoOrder.place",
  "params": {
    "algoType": "CONDITIONAL",
    "symbol": "BTCUSDT",
    "side": "BUY",
    "type": "STOP_MARKET",
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}'

Example Request

{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "algoOrder.place",
  "params": {
    "algoType": "CONDITIONAL",
    "symbol": "BTCUSDT",
    "side": "BUY",
    "type": "STOP_MARKET",
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}

json

application/json

Example Responses

{
  "id": "06c9dbd8-ccbf-4ecf-a29c-fe31495ac73f",
  "status": 200,
  "result": {
    "algoId": 3000000000003505,
    "clientAlgoId": "0Xkl1p621E4EryvufmYre1",
    "algoType": "CONDITIONAL",
    "orderType": "TAKE_PROFIT",
    "symbol": "BTCUSDT",
    "side": "SELL",
    "positionSide": "SHORT",
    "timeInForce": "GTC",
    "quantity": "1.000",
    "algoStatus": "NEW",
    "triggerPrice": "120000.00",
    "price": "160000.00",
    "icebergQuantity": "null",
    "selfTradePreventionMode": "EXPIRE_MAKER",
    "workingType": "CONTRACT_PRICE",
    "priceMatch": "NONE",
    "closePosition": false,
    "priceProtect": false,
    "reduceOnly": false,
    "createTime": 1762507264142,
    "updateTime": 1762507264143,
    "triggerTime": 0,
    "goodTillDate": 0
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 1
    }
  ]
}

json

application/json

New Order (TRADE)

Send in a new order.

WSS

order.place

wss://ws-fapi.binance.com/ws-fapi/v1

New Order (TRADE) › Authorization

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

New Order (TRADE) › Request Weight

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

Learn more in the Rate limits section.

IP Weight0

New Order (TRADE) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

order.place

Example: order.place

object · required

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

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

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

timeInForce

string · enum

Time In Force.

Enum values:

GTC

IOC

FOK

GTX

GTD

RPI

Example: GTC

reduceOnly

string · enum

Cannot be sent in Hedge Mode

Enum values:

true

false

Example: false

Default: false

quantity

number · float

Example: 1.0

price

number · float

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

Example: 1

newOrderRespType

string · enum

Enum values:

ACK

RESULT

Example: ACK

Default: ACK

priceMatch

string · enum

only available for LIMIT order; Can't be passed together with price

Enum values:

OPPONENT

OPPONENT_5

OPPONENT_10

OPPONENT_20

QUEUE

QUEUE_5

QUEUE_10

QUEUE_20

Example: OPPONENT

selfTradePreventionMode

string · enum

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

Enum values:

NONE

EXPIRE_TAKER

EXPIRE_BOTH

EXPIRE_MAKER

Example: NONE

Default: NONE

goodTillDate

integer · int64

Example: 1770736694138

recvWindow

integer · int64

Recv Window.

Example: 5000

New Order (TRADE) › Responses

Successful Response

New Order

id

string

Example: 3f7df6e3-2df4-44b9-9919-d2f38f90a99a

status

integer · int64

Example: 200

object

orderId

integer · int64

Example: 325078477

symbol

string

Example: BTCUSDT

status

string

Example: NEW

clientOrderId

string

Example: iCXL1BywlBaf2sesNUrVl3

price

string

Example: 43187.00

origQty

string

Example: 0.100

executedQty

string

Example: 0.000

cumQty

string

Example: 0.000

timeInForce

string

Example: GTC

type

string

Example: LIMIT

reduceOnly

boolean

Example: false

closePosition

boolean

Example: false

side

string

Example: BUY

positionSide

string

Example: BOTH

stopPrice

string

Example: 0.00

workingType

string

Example: CONTRACT_PRICE

priceProtect

boolean

Example: false

origType

string

Example: LIMIT

priceMatch

string

Example: NONE

selfTradePreventionMode

string

Example: NONE

goodTillDate

integer · int64

Example: 0

updateTime

integer · int64

Example: 1702555534435

object[]

rateLimitType

string

Example: ORDERS

interval

string

Example: SECOND

intervalNum

integer · int64

Example: 10

limit

integer · int64

Example: 300

count

integer · int64

Example: 1

WSSorder.place

wscat -c wss://ws-fapi.binance.com/ws-fapi/v1 -x '{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "order.place",
  "params": {
    "symbol": "BTCUSDT",
    "side": "BUY",
    "type": "LIMIT",
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}'

Example Request

{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "order.place",
  "params": {
    "symbol": "BTCUSDT",
    "side": "BUY",
    "type": "LIMIT",
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}

json

application/json

Example Responses

{
  "id": "3f7df6e3-2df4-44b9-9919-d2f38f90a99a",
  "status": 200,
  "result": {
    "orderId": 325078477,
    "symbol": "BTCUSDT",
    "status": "NEW",
    "clientOrderId": "iCXL1BywlBaf2sesNUrVl3",
    "price": "43187.00",
    "origQty": "0.100",
    "executedQty": "0.000",
    "cumQty": "0.000",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "reduceOnly": false,
    "closePosition": false,
    "side": "BUY",
    "positionSide": "BOTH",
    "stopPrice": "0.00",
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "origType": "LIMIT",
    "priceMatch": "NONE",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0,
    "updateTime": 1702555534435
  },
  "rateLimits": [
    {
      "rateLimitType": "ORDERS",
      "interval": "SECOND",
      "intervalNum": 10,
      "limit": 300,
      "count": 1
    }
  ]
}

json

application/json

Position Information (USER_DATA)

Get current position information.

WSS

account.position

wss://ws-fapi.binance.com/ws-fapi/v1

Position Information (USER_DATA) › Authorization

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

Position Information (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight5

Position Information (USER_DATA) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

account.position

Example: account.position

object · required

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

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

symbol

string

Symbol.

Example: BTCUSDT

recvWindow

integer · int64

Recv Window.

Example: 5000

Position Information (USER_DATA) › Responses

Successful Response

Position Information

id

string

Example: 605a6d20-6588-4cb9-afa0-b0ab087507ba

status

integer · int64

Example: 200

object[]

entryPrice

string

Example: 0.00000

breakEvenPrice

string

Example: 0.0

marginType

string

Example: isolated

isAutoAddMargin

string

Example: false

isolatedMargin

string

Example: 0.00000000

leverage

string

Example: 10

liquidationPrice

string

Example: 0

markPrice

string

Example: 6679.50671178

maxNotionalValue

string

Example: 20000000

positionAmt

string

Example: 0.000

notional

string

Example: 0

isolatedWallet

string

Example: 0

symbol

string

Example: BTCUSDT

unRealizedProfit

string

Example: 0.00000000

positionSide

string

Example: BOTH

updateTime

integer · int64

Example: 1625474304765

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 20

WSSaccount.position

wscat -c wss://ws-fapi.binance.com/ws-fapi/v1 -x '{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "account.position",
  "params": {
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}'

Example Request

{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "account.position",
  "params": {
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}

json

application/json

Example Responses

{
  "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
  "status": 200,
  "result": [
    {
      "entryPrice": "0.00000",
      "breakEvenPrice": "0.0",
      "marginType": "isolated",
      "isAutoAddMargin": "false",
      "isolatedMargin": "0.00000000",
      "leverage": "10",
      "liquidationPrice": "0",
      "markPrice": "6679.50671178",
      "maxNotionalValue": "20000000",
      "positionAmt": "0.000",
      "notional": "0",
      "isolatedWallet": "0",
      "symbol": "BTCUSDT",
      "unRealizedProfit": "0.00000000",
      "positionSide": "BOTH",
      "updateTime": 1625474304765
    }
  ],
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 20
    }
  ]
}

json

application/json

Position Information V2 (USER_DATA)

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

WSS

v2/account.position

wss://ws-fapi.binance.com/ws-fapi/v1

Position Information V2 (USER_DATA) › Authorization

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

Position Information V2 (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight5

Position Information V2 (USER_DATA) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

v2/account.position

Example: v2/account.position

object · required

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

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

symbol

string

Symbol.

Example: BTCUSDT

recvWindow

integer · int64

Recv Window.

Example: 5000

Position Information V2 (USER_DATA) › Responses

Successful Response

Position Information V2

id

string

Example: 605a6d20-6588-4cb9-afa0-b0ab087507ba

status

integer · int64

Example: 200

object[]

symbol

string

Example: ADAUSDT

positionSide

string

Position Side

Example: BOTH

positionAmt

string

Example: 30

entryPrice

string

Example: 0.385

breakEvenPrice

string

Example: 0.385077

markPrice

string

Example: 0.41047590

unRealizedProfit

string

Unrealized Profit

Example: 0.76427700

liquidationPrice

string

Example: 0

isolatedMargin

string

Example: 0

notional

string

Example: 12.31427700

marginAsset

string

Example: USDT

isolatedWallet

string

Example: 0

initialMargin

string

Initial Margin

Example: 0.61571385

maintMargin

string

Maintainance Margin

Example: 0.08004280

positionInitialMargin

string

Position Initial Margin

Example: 0.61571385

openOrderInitialMargin

string

Open Order Initial Margin

Example: 0

adl

integer · int64

Example: 2

bidNotional

string

Example: 0

askNotional

string

Example: 0

updateTime

integer · int64

Update Time

Example: 1720736417660

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 20

WSSv2/account.position

wscat -c wss://ws-fapi.binance.com/ws-fapi/v1 -x '{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "v2/account.position",
  "params": {
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}'

Example Request

{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "v2/account.position",
  "params": {
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}

json

application/json

Example Responses

{
  "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
  "status": 200,
  "result": [
    {
      "symbol": "ADAUSDT",
      "positionSide": "BOTH",
      "positionAmt": "30",
      "entryPrice": "0.385",
      "breakEvenPrice": "0.385077",
      "markPrice": "0.41047590",
      "unRealizedProfit": "0.76427700",
      "liquidationPrice": "0",
      "isolatedMargin": "0",
      "notional": "12.31427700",
      "marginAsset": "USDT",
      "isolatedWallet": "0",
      "initialMargin": "0.61571385",
      "maintMargin": "0.08004280",
      "positionInitialMargin": "0.61571385",
      "openOrderInitialMargin": "0",
      "adl": 2,
      "bidNotional": "0",
      "askNotional": "0",
      "updateTime": 1720736417660
    }
  ],
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 20
    }
  ]
}

json

application/json

Query Order (USER_DATA)

Check an order's status.

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

WSS

order.status

wss://ws-fapi.binance.com/ws-fapi/v1

Query Order (USER_DATA) › Authorization

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

Query Order (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Query Order (USER_DATA) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

order.status

Example: order.status

object · required

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

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

orderId

integer · int64

Order Id.

Example: 1

origClientOrderId

string

Orig Client Order Id.

Example: 1

recvWindow

integer · int64

Recv Window.

Example: 5000

Query Order (USER_DATA) › Responses

Successful Response

Order Status

id

string

Example: 605a6d20-6588-4cb9-afa0-b0ab087507ba

status

integer · int64

Example: 200

object

avgPrice

string

Example: 0.00000

clientOrderId

string

Example: abc

cumQuote

string

Example: 0

executedQty

string

Example: 0

orderId

integer · int64

Example: 1573346959

origQty

string

Example: 0.40

origType

string

Example: TRAILING_STOP_MARKET

price

string

Example: 0

reduceOnly

boolean

Example: false

side

string

Example: BUY

positionSide

string

Example: SHORT

status

string

Example: NEW

stopPrice

string

please ignore when order type is TRAILING_STOP_MARKET

Example: 9300

closePosition

boolean

if Close-All

Example: false

symbol

string

Example: BTCUSDT

time

integer · int64

order time

Example: 1579276756075

timeInForce

string

Example: GTC

type

string

Example: TRAILING_STOP_MARKET

activatePrice

string

activation price, only return with TRAILING_STOP_MARKET order

Example: 9020

priceRate

string

callback rate, only return with TRAILING_STOP_MARKET order

Example: 0.3

updateTime

integer · int64

update time

Example: 1579276756075

workingType

string

Example: CONTRACT_PRICE

priceProtect

boolean

if conditional order trigger is protected

Example: false

priceMatch

string

Example: NONE

selfTradePreventionMode

string

Self-trade prevention mode

Example: NONE

goodTillDate

integer · int64

Order good till date timestamp

Example: 0

WSSorder.status

wscat -c wss://ws-fapi.binance.com/ws-fapi/v1 -x '{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "order.status",
  "params": {
    "symbol": "BTCUSDT",
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}'

Example Request

{
  "id": "e9d6b4349871b40611412680b3445fac",
  "method": "order.status",
  "params": {
    "symbol": "BTCUSDT",
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}

json

application/json

Example Responses

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

json

application/json