Account

Endpoint

Account Balance (USER_DATA)

Query account balance

GET

/papi/v1/balance

https://papi.binance.com

Account Balance (USER_DATA) › Authorization

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

Account Balance (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 Weight20

Account Balance (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Account Balance (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

asset

string

Example: USDT

recvWindow

integer · int64

Example: 5000

Account Balance (USER_DATA) › Responses

200

Account Balance

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = array
	type = object

Properties for Variant 1:

object

asset

string

asset name

Example: USDT

totalWalletBalance

string

Total Wallet Balance.

Example: 122607.35137903

crossMarginAsset

string

Cross Margin Asset.

Example: 92.27530794

crossMarginBorrowed

string

Cross Margin Borrowed.

Example: 10.00000000

crossMarginFree

string

Cross Margin Free.

Example: 100.00000000

crossMarginInterest

string

Cross Margin Interest.

Example: 0.72469206

crossMarginLocked

string

Cross Margin Locked.

Example: 3.00000000

umWalletBalance

string

Um Wallet Balance.

Example: 0.00000000

umUnrealizedPNL

string

Um Unrealized PNL.

Example: 23.72469206

cmWalletBalance

string

Cm Wallet Balance.

Example: 23.72469206

cmUnrealizedPNL

string

Cm Unrealized PNL.

Example:

updateTime

integer · int64

last update time

Example: 1617939110373

negativeBalance

string

negative balance amount

Example: 0

GET/papi/v1/balance

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

Example Responses

[
  {
    "asset": "USDT",
    "totalWalletBalance": "122607.35137903",
    "crossMarginAsset": "92.27530794",
    "crossMarginBorrowed": "10.00000000",
    "crossMarginFree": "100.00000000",
    "crossMarginInterest": "0.72469206",
    "crossMarginLocked": "3.00000000",
    "umWalletBalance": "0.00000000",
    "umUnrealizedPNL": "23.72469206",
    "cmWalletBalance": "23.72469206",
    "cmUnrealizedPNL": "",
    "updateTime": 1617939110373,
    "negativeBalance": "0"
  }
]

application/json

Account Information (USER_DATA)

Query account information

GET

/papi/v1/account

https://papi.binance.com

Account 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

Account 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 Weight20

Account Information (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Account Information (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

Account Information (USER_DATA) › Responses

200

Account Information

uniMMR

string

Portfolio margin account maintenance margin rate

Example: 5167.92171923

accountEquity

string

Account equity, in USD value

Example: 73.47428058

actualEquity

string

Account equity without collateral rate, in USD value

Example: 122607.35137903

accountInitialMargin

string

Account Initial Margin.

Example: 23.72469206

accountMaintMargin

string

Portfolio margin account maintenance margin, unit：USD

Example: 23.72469206

accountStatus

string

Portfolio margin account status:"NORMAL", "MARGIN_CALL", "SUPPLY_MARGIN", "REDUCE_ONLY", "ACTIVE_LIQUIDATION", "FORCE_LIQUIDATION", "BANKRUPTED"

Example: NORMAL

virtualMaxWithdrawAmount

string

Portfolio margin maximum amount for transfer out in USD

Example: 1627523.32459208

totalAvailableBalance

string

Total Available Balance.

Example:

totalMarginOpenLoss

string

in USD margin open order

Example:

updateTime

integer · int64

last update time

Example: 1657707212154

GET/papi/v1/account

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

Example Responses

{
  "uniMMR": "5167.92171923",
  "accountEquity": "73.47428058",
  "actualEquity": "122607.35137903",
  "accountInitialMargin": "23.72469206",
  "accountMaintMargin": "23.72469206",
  "accountStatus": "NORMAL",
  "virtualMaxWithdrawAmount": "1627523.32459208",
  "totalAvailableBalance": "",
  "totalMarginOpenLoss": "",
  "updateTime": 1657707212154
}

application/json

BNB transfer (TRADE)

Transfer BNB in and out of UM

POST

/papi/v1/bnb-transfer

https://papi.binance.com

BNB transfer (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

BNB transfer (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 Weight750

BNB transfer (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

BNB transfer (TRADE) › Request Body

amount

number · float · required

Example: 1.0

transferSide

string · enum · required

Enum values:

TO_UM

FROM_UM

Example: TO_UM

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

BNB transfer (TRADE) › Responses

200

BNB transfer

tranId

integer · int64

Transaction ID.

Example: 100000001

POST/papi/v1/bnb-transfer

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

Example Request Body

{
  "amount": "1.0",
  "transferSide": "TO_UM",
  "timestamp": 1770736694138
}

Example Responses

{
  "tranId": 100000001
}

application/json

Get Auto-repay-futures Status (USER_DATA)

Query Auto-repay-futures Status

GET

/papi/v1/repay-futures-switch

https://papi.binance.com

Get Auto-repay-futures 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 Auto-repay-futures 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 Auto-repay-futures 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 Auto-repay-futures 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 Auto-repay-futures Status (USER_DATA) › Responses

200

Get Auto-repay-futures Status

autoRepay

boolean

"true" for turn on the auto-repay futures; "false" for turn off the auto-repay futures

Example: true

GET/papi/v1/repay-futures-switch

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

Example Responses

{
  "autoRepay": true
}

application/json

Change Auto-repay-futures Status (TRADE)

Change Auto-repay-futures Status

POST

/papi/v1/repay-futures-switch

https://papi.binance.com

Change Auto-repay-futures Status (TRADE) › Authorization

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

Change Auto-repay-futures Status (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 Weight750

Change Auto-repay-futures Status (TRADE) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Change Auto-repay-futures Status (TRADE) › Request Body

autoRepay

string · enum · required

false for turn off the auto-repay futures negative balance function

Enum values:

true

false

Example: true

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

Change Auto-repay-futures Status (TRADE) › Responses

200

Change Auto-repay-futures Status

msg

string

Msg.

Example: success

POST/papi/v1/repay-futures-switch

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

Example Request Body

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

Example Responses

{
  "msg": "success"
}

application/json

Change CM Initial Leverage (TRADE)

Change user's initial leverage of specific symbol in CM.

POST

/papi/v1/cm/leverage

https://papi.binance.com

Change CM Initial Leverage (TRADE) › Authorization

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

Change CM Initial Leverage (TRADE) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Change CM Initial Leverage (TRADE) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Change CM Initial Leverage (TRADE) › Request Body

symbol

string · required

Example: BTCUSD_200925

leverage

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

target initial leverage

Example: 21

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

Change CM Initial Leverage (TRADE) › Responses

200

Change CM Initial Leverage

leverage

integer · int64

current initial leverage

Example: 21

maxQty

string

maximum quantity of base asset

Example: 1000

symbol

string

Trade symbol, if existing.

Example: BTCUSD_200925

POST/papi/v1/cm/leverage

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

Example Request Body

{
  "symbol": "BTCUSD_200925",
  "leverage": 21,
  "timestamp": 1770736694138
}

Example Responses

{
  "leverage": 21,
  "maxQty": "1000",
  "symbol": "BTCUSD_200925"
}

application/json

Get CM Current Position Mode (USER_DATA)

Get user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol in CM

GET

/papi/v1/cm/positionSide/dual

https://papi.binance.com

Get CM Current Position Mode (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 CM Current Position Mode (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 CM Current Position Mode (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 CM Current Position Mode (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 CM Current Position Mode (USER_DATA) › Responses

200

Get CM Current Position Mode

dualSidePosition

boolean

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

Example: true

GET/papi/v1/cm/positionSide/dual

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

Example Responses

{
  "dualSidePosition": true
}

application/json

Change CM Position Mode (TRADE)

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

POST

/papi/v1/cm/positionSide/dual

https://papi.binance.com

Change CM Position Mode (TRADE) › Authorization

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

Change CM Position Mode (TRADE) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Change CM Position Mode (TRADE) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Change CM Position Mode (TRADE) › Request Body

dualSidePosition

string · enum · required

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

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

Change CM Position Mode (TRADE) › Responses

200

Change CM Position Mode

code

integer · int64

Code.

Example: 200

msg

string

Msg.

Example: success

POST/papi/v1/cm/positionSide/dual

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

Example Request Body

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

Example Responses

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

application/json

Change UM Initial Leverage (TRADE)

Change user's initial leverage of specific symbol in UM.

POST

/papi/v1/um/leverage

https://papi.binance.com

Change UM Initial Leverage (TRADE) › Authorization

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

Change UM Initial Leverage (TRADE) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Change UM Initial Leverage (TRADE) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Change UM Initial Leverage (TRADE) › Request Body

symbol

string · required

Example: BTCUSDT

leverage

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

target initial leverage

Example: 21

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

Change UM Initial Leverage (TRADE) › Responses

200

Change UM Initial Leverage

leverage

integer · int64

current initial leverage

Example: 21

maxNotionalValue

string

Max Notional Value.

Example: 1000000

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

POST/papi/v1/um/leverage

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

Example Request Body

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

Example Responses

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

application/json

Get UM Current Position Mode (USER_DATA)

Get user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol in UM

GET

/papi/v1/um/positionSide/dual

https://papi.binance.com

Get UM Current Position Mode (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 Current Position Mode (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 Current Position Mode (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 Current Position Mode (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 Current Position Mode (USER_DATA) › Responses

200

Get UM Current Position Mode

dualSidePosition

boolean

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

Example: true

GET/papi/v1/um/positionSide/dual

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

Example Responses

{
  "dualSidePosition": true
}

application/json

Change UM Position Mode (TRADE)

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

POST

/papi/v1/um/positionSide/dual

https://papi.binance.com

Change UM Position Mode (TRADE) › Authorization

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

Change UM Position Mode (TRADE) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Change UM Position Mode (TRADE) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Change UM Position Mode (TRADE) › Request Body

dualSidePosition

string · enum · required

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

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

Change UM Position Mode (TRADE) › Responses

200

Change UM Position Mode

code

integer · int64

Code.

Example: 200

msg

string

Msg.

Example: success

POST/papi/v1/um/positionSide/dual

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

Example Request Body

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

Example Responses

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

application/json

CM Notional and Leverage Brackets (USER_DATA)

Query CM notional and leverage brackets

GET

/papi/v1/cm/leverageBracket

https://papi.binance.com

CM Notional and Leverage Brackets (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 Notional and Leverage Brackets (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

CM Notional and Leverage Brackets (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 Notional and Leverage Brackets (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_PERP

recvWindow

integer · int64

Example: 5000

CM Notional and Leverage Brackets (USER_DATA) › Responses

200

CM Notional and Leverage Brackets

object

symbol

string

Trade symbol, if existing.

Example: BTCUSD_PERP

object[]

Brackets.

GET/papi/v1/cm/leverageBracket

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

Example Responses

[
  {
    "symbol": "BTCUSD_PERP",
    "brackets": [
      {
        "bracket": 1,
        "initialLeverage": 125,
        "qtyCap": 50,
        "qtyFloor": 0,
        "maintMarginRatio": 0.004,
        "cum": 0
      }
    ]
  }
]

application/json

Fund Auto-collection (TRADE)

Fund collection for Portfolio Margin

POST

/papi/v1/auto-collection

https://papi.binance.com

Fund Auto-collection (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

Fund Auto-collection (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 Weight750

Fund Auto-collection (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

Fund Auto-collection (TRADE) › 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

Fund Auto-collection (TRADE) › Responses

200

Fund Auto-collection

msg

string

Msg.

Example: success

POST/papi/v1/auto-collection

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

Example Request Body

{
  "timestamp": 1770736694138
}

Example Responses

{
  "msg": "success"
}

application/json

Fund Collection by Asset (TRADE)

Transfers specific asset from Futures Account to Margin account

POST

/papi/v1/asset-collection

https://papi.binance.com

Fund Collection by Asset (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

Fund Collection by Asset (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 Weight30

Fund Collection by Asset (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

Fund Collection by Asset (TRADE) › Request Body

asset

string · required

Example: BTC

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

Fund Collection by Asset (TRADE) › Responses

200

Fund Collection by Asset

msg

string

Msg.

Example: success

POST/papi/v1/asset-collection

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

Example Request Body

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

Example Responses

{
  "msg": "success"
}

application/json

Get CM Account Detail (USER_DATA)

Get current CM account asset and position information.

GET

/papi/v1/cm/account

https://papi.binance.com

Get CM Account Detail (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 CM Account Detail (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

Get CM Account Detail (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 CM Account Detail (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 CM Account Detail (USER_DATA) › Responses

200

Get CM Account Detail

object[]

Assets.

object[]

positions of all symbols in the market are returned

GET/papi/v1/cm/account

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

Example Responses

{
  "assets": [
    {
      "asset": "BTC",
      "crossWalletBalance": "0.00241969",
      "crossUnPnl": "0.00000000",
      "maintMargin": "0.00000000",
      "initialMargin": "0.00000000",
      "positionInitialMargin": "0.00000000",
      "openOrderInitialMargin": "0.00000000",
      "updateTime": 1625474304765
    }
  ],
  "positions": [
    {
      "symbol": "BTCUSD_201225",
      "positionAmt": "0",
      "initialMargin": "0",
      "maintMargin": "0",
      "unrealizedProfit": "0.00000000",
      "positionInitialMargin": "0",
      "openOrderInitialMargin": "0",
      "leverage": "125",
      "positionSide": "BOTH",
      "entryPrice": "0.0",
      "maxQty": "50",
      "updateTime": 0
    }
  ]
}

application/json

Get CM Income History (USER_DATA)

Get CM Income History.

GET

/papi/v1/cm/income

https://papi.binance.com

Get CM Income History (USER_DATA) › Authorization

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

Get CM Income 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 Weight30

Get CM Income History (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Get CM Income History (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

incomeType

string · enum

Enum values:

TRANSFER

WELCOME_BONUS

FUNDING_FEE

REALIZED_PNL

COMMISSION

INSURANCE_CLEAR

DELIVERED_SETTELMENT

Example: TRANSFER

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

page

integer · int64

Example: 1

limit

integer · int64 · max: 1000

Number of results returned.

Example: 100

Default: 100

recvWindow

integer · int64

Example: 5000

Get CM Income History (USER_DATA) › Responses

200

Get CM Income History

object

symbol

string

Trade symbol, if existing.

Example:

incomeType

string

Income type.

Example: TRANSFER

income

string

Income amount.

Example: -0.37500000

asset

string

Income asset.

Example: BTC

info

string

Extra information.

Example: WITHDRAW

time

integer · int64

Event time.

Example: 1570608000000

tranId

string

Transaction ID.

Example: 9689322392

tradeId

string

Trade ID, if existing.

Example:

GET/papi/v1/cm/income

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

Example Responses

[
  {
    "symbol": "",
    "incomeType": "TRANSFER",
    "income": "-0.37500000",
    "asset": "BTC",
    "info": "WITHDRAW",
    "time": 1570608000000,
    "tranId": "9689322392",
    "tradeId": ""
  }
]

application/json

Get Download Id For UM Futures Order History (USER_DATA)

Get download id for UM futures order history

GET

/papi/v1/um/order/asyn

https://papi.binance.com

Get Download Id For UM Futures 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

Get Download Id For UM Futures 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 Weight1500

Get Download Id For UM Futures 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

Get Download Id For UM Futures Order History (USER_DATA) › Query Parameters

startTime

integer · int64 · required

Timestamp in ms

Example: 1623319461670

endTime

integer · int64 · required

Timestamp in ms

Example: 1641782889000

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 Download Id For UM Futures Order History (USER_DATA) › Responses

200

Get Download Id For UM Futures Order History

avgCostTimestampOfLast30d

integer · int64

Average time taken for data download in the past 30 days

Example: 7241837

downloadId

string

Download ID.

Example: 546975389218332672

GET/papi/v1/um/order/asyn

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

Example Responses

{
  "avgCostTimestampOfLast30d": 7241837,
  "downloadId": "546975389218332672"
}

application/json

Get Download Id For UM Futures Trade History (USER_DATA)

Get download id for UM futures trade history

GET

/papi/v1/um/trade/asyn

https://papi.binance.com

Get Download Id For UM Futures Trade History (USER_DATA) › Authorization

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

Get Download Id For UM Futures Trade 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 Weight1500

Get Download Id For UM Futures Trade History (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Get Download Id For UM Futures Trade History (USER_DATA) › Query Parameters

startTime

integer · int64 · required

Timestamp in ms

Example: 1623319461670

endTime

integer · int64 · required

Timestamp in ms

Example: 1641782889000

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 Download Id For UM Futures Trade History (USER_DATA) › Responses

200

Get Download Id For UM Futures Trade History

avgCostTimestampOfLast30d

integer · int64

Average time taken for data download in the past 30 days

Example: 7241837

downloadId

string

Download ID.

Example: 546975389218332672

GET/papi/v1/um/trade/asyn

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

Example Responses

{
  "avgCostTimestampOfLast30d": 7241837,
  "downloadId": "546975389218332672"
}

application/json

Get Download Id For UM Futures Transaction History (USER_DATA)

Get download id for UM futures transaction history

GET

/papi/v1/um/income/asyn

https://papi.binance.com

Get Download Id For UM Futures Transaction History (USER_DATA) › Authorization

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

Get Download Id For UM Futures Transaction 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 Weight1500

Get Download Id For UM Futures Transaction History (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Get Download Id For UM Futures Transaction History (USER_DATA) › Query Parameters

startTime

integer · int64 · required

Timestamp in ms

Example: 1623319461670

endTime

integer · int64 · required

Timestamp in ms

Example: 1641782889000

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 Download Id For UM Futures Transaction History (USER_DATA) › Responses

200

Get Download Id For UM Futures Transaction History

avgCostTimestampOfLast30d

integer · int64

Average time taken for data download in the past 30 days

Example: 7241837

downloadId

string

Download ID.

Example: 546975389218332672

GET/papi/v1/um/income/asyn

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

Example Responses

{
  "avgCostTimestampOfLast30d": 7241837,
  "downloadId": "546975389218332672"
}

application/json

Get Margin Borrow/Loan Interest History (USER_DATA)

Get Margin Borrow/Loan Interest History

GET

/papi/v1/margin/marginInterestHistory

https://papi.binance.com

Get Margin Borrow/Loan Interest History (USER_DATA) › Authorization

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

Get Margin Borrow/Loan Interest History (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Get Margin Borrow/Loan Interest History (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Get Margin Borrow/Loan Interest History (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

asset

string

Example: USDT

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

Current page number.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results returned.

Example: 10

Default: 10

archived

string · enum

Set to true to query archived data from 6 months ago.

Enum values:

true

false

Example: true

Default: false

recvWindow

integer · int64

The value cannot be greater than 60000

Example: 5000

Get Margin Borrow/Loan Interest History (USER_DATA) › Responses

200

Get Margin Borrow/Loan Interest History

object[]

Rows.

total

integer · int64

Total.

Example: 1

GET/papi/v1/margin/marginInterestHistory

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

Example Responses

{
  "rows": [
    {
      "txId": 1352286576452864800,
      "interestAccuredTime": 1672160400000,
      "asset": "USDT",
      "rawAsset": "USDT",
      "principal": "45.3313",
      "interest": "0.00024995",
      "interestRate": "0.00013233",
      "type": "ON_BORROW"
    }
  ],
  "total": 1
}

application/json

Get UM Account Detail (USER_DATA)

Get current UM account asset and position information.

GET

/papi/v1/um/account

https://papi.binance.com

Get UM Account Detail (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 Account Detail (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

Get UM Account Detail (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 Account Detail (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 Account Detail (USER_DATA) › Responses

200

Get UM Account Detail

object[]

Assets.

object[]

positions of all symbols in the market are returned

GET/papi/v1/um/account

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

Example Responses

{
  "assets": [
    {
      "asset": "USDT",
      "crossWalletBalance": "23.72469206",
      "crossUnPnl": "0.00000000",
      "maintMargin": "0.00000000",
      "initialMargin": "0.00000000",
      "positionInitialMargin": "0.00000000",
      "openOrderInitialMargin": "0.00000000",
      "updateTime": 1625474304765
    }
  ],
  "positions": [
    {
      "symbol": "BTCUSDT",
      "initialMargin": "0",
      "maintMargin": "0",
      "unrealizedProfit": "0.00000000",
      "positionInitialMargin": "0",
      "openOrderInitialMargin": "0",
      "leverage": "100",
      "entryPrice": "0.00000",
      "maxNotional": "250000",
      "bidNotional": "0",
      "askNotional": "0",
      "positionSide": "BOTH",
      "positionAmt": "0",
      "updateTime": 0
    }
  ]
}

application/json

Get UM Account Detail V2 (USER_DATA)

Get current UM account asset and position information.

GET

/papi/v2/um/account

https://papi.binance.com

Get UM Account Detail 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

Get UM Account Detail 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

Get UM Account Detail V2 (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Get UM Account Detail V2 (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

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

Example: 1770736694138

recvWindow

integer · int64

Example: 5000

Get UM Account Detail V2 (USER_DATA) › Responses

200

Get UM Account Detail V2

object[]

Assets.

object[]

positions of all symbols in the market are returned

GET/papi/v2/um/account

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

Example Responses

{
  "assets": [
    {
      "asset": "USDT",
      "crossWalletBalance": "23.72469206",
      "crossUnPnl": "0.00000000",
      "maintMargin": "0.00000000",
      "initialMargin": "0.00000000",
      "positionInitialMargin": "0.00000000",
      "openOrderInitialMargin": "0.00000000",
      "updateTime": 1625474304765
    }
  ],
  "positions": [
    {
      "symbol": "BTCUSDT",
      "initialMargin": "0",
      "maintMargin": "0",
      "unrealizedProfit": "0.00000000",
      "positionSide": "BOTH",
      "positionAmt": "0",
      "updateTime": 0,
      "notional": "86.98650000"
    }
  ]
}

application/json

Get UM Futures Order Download Link by Id (USER_DATA)

Get UM futures order download link by Id

GET

/papi/v1/um/order/asyn/id

https://papi.binance.com

Get UM Futures Order Download Link by Id (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 Order Download Link by Id (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

Get UM Futures Order Download Link by Id (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 Order Download Link by Id (USER_DATA) › Query Parameters

downloadId

string · required

get by download id api

Example: 545923594199212032

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 Order Download Link by Id (USER_DATA) › Responses

200

Get UM Futures Order Download Link by Id

downloadId

string

Download ID.

Example: 545923594199212032

status

string

Enum：completed，processing

Example: processing

url

string

The link is mapped to download id

Example:

s3Link

string

S3 Link.

Example: null

notified

boolean

ignore

Example: false

expirationTimestamp

integer · int64

The link would expire after this timestamp

Example: -1

isExpired

string

Is Expired.

Example: null

GET/papi/v1/um/order/asyn/id

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

Example Responses

{
  "downloadId": "545923594199212032",
  "status": "processing",
  "url": "",
  "s3Link": "null",
  "notified": false,
  "expirationTimestamp": -1,
  "isExpired": "null"
}

application/json

Get UM Futures Trade Download Link by Id (USER_DATA)

Get UM futures trade download link by Id

GET

/papi/v1/um/trade/asyn/id

https://papi.binance.com

Get UM Futures Trade Download Link by Id (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 Trade Download Link by Id (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

Get UM Futures Trade Download Link by Id (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 Trade Download Link by Id (USER_DATA) › Query Parameters

downloadId

string · required

get by download id api

Example: 545923594199212032

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 Trade Download Link by Id (USER_DATA) › Responses

200

Get UM Futures Trade Download Link by Id

downloadId

string

Download ID.

Example: 545923594199212032

status

string

Enum：completed，processing

Example: processing

url

string

The link is mapped to download id

Example:

s3Link

string

S3 Link.

Example: null

notified

boolean

ignore

Example: false

expirationTimestamp

integer · int64

The link would expire after this timestamp

Example: -1

isExpired

string

Is Expired.

Example: null

GET/papi/v1/um/trade/asyn/id

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

Example Responses

{
  "downloadId": "545923594199212032",
  "status": "processing",
  "url": "",
  "s3Link": "null",
  "notified": false,
  "expirationTimestamp": -1,
  "isExpired": "null"
}

application/json

Get UM Futures Transaction Download Link by Id (USER_DATA)

Get UM futures Transaction download link by Id

GET

/papi/v1/um/income/asyn/id

https://papi.binance.com

Get UM Futures Transaction Download Link by Id (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 Transaction Download Link by Id (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

Get UM Futures Transaction Download Link by Id (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 Transaction Download Link by Id (USER_DATA) › Query Parameters

downloadId

string · required

get by download id api

Example: 1

timestamp

integer · int64 · required

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

Example: 1770736694138

recvWindow

integer · int64

Example: 5000

Get UM Futures Transaction Download Link by Id (USER_DATA) › Responses

200

Get UM Futures Transaction Download Link by Id

downloadId

string

Download ID.

Example: 545923594199212032

status

string

Enum：completed，processing

Example: processing

url

string

The link is mapped to download id

Example:

s3Link

string

S3 Link.

Example: null

notified

boolean

ignore

Example: false

expirationTimestamp

integer · int64

The link would expire after this timestamp

Example: -1

isExpired

string

Is Expired.

Example: null

GET/papi/v1/um/income/asyn/id

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

Example Responses

{
  "downloadId": "545923594199212032",
  "status": "processing",
  "url": "",
  "s3Link": "null",
  "notified": false,
  "expirationTimestamp": -1,
  "isExpired": "null"
}

application/json

Get UM Income History (USER_DATA)

Get UM Income History.

GET

/papi/v1/um/income

https://papi.binance.com

Get UM Income History (USER_DATA) › Authorization

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

Get UM Income 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 Weight30

Get UM Income History (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Get UM Income History (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: null

incomeType

string · enum

Income type.

Enum values:

TRANSFER

WELCOME_BONUS

REALIZED_PNL

FUNDING_FEE

COMMISSION

INSURANCE_CLEAR

REFERRAL_KICKBACK

COMMISSION_REBATE

Example: TRANSFER

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

page

integer · int64

Page number.

Example: 1

Default: 1

limit

integer · int64 · max: 1000

Number of results returned.

Example: 100

Default: 100

recvWindow

integer · int64

Example: 5000

Get UM Income History (USER_DATA) › Responses

200

Get UM Income History

object

symbol

string

Trade symbol, if existing.

Example:

incomeType

string

Income type.

Example: TRANSFER

income

string

Income amount.

Example: -0.37500000

asset

string

Income asset.

Example: USDT

info

string

Extra information.

Example: TRANSFER

time

integer · int64

Event time.

Example: 1570608000000

tranId

string

Transaction ID.

Example: 9689322392

tradeId

string

Trade ID, if existing.

Example:

GET/papi/v1/um/income

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

Example Responses

[
  {
    "symbol": "",
    "incomeType": "TRANSFER",
    "income": "-0.37500000",
    "asset": "USDT",
    "info": "TRANSFER",
    "time": 1570608000000,
    "tranId": "9689322392",
    "tradeId": ""
  }
]

application/json

Get User Commission Rate for CM (USER_DATA)

Get User Commission Rate for CM

GET

/papi/v1/cm/commissionRate

https://papi.binance.com

Get User Commission Rate for CM (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 User Commission Rate for CM (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 Weight20

Get User Commission Rate for CM (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 User Commission Rate for CM (USER_DATA) › Query Parameters

symbol

string · required

Symbol

Example: BTCUSD_PERP

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 User Commission Rate for CM (USER_DATA) › Responses

200

Get User Commission Rate for CM

symbol

string

Trade symbol, if existing.

Example: BTCUSD_PERP

makerCommissionRate

string

0.015%

Example: 0.00015

takerCommissionRate

string

0.040%

Example: 0.00040

GET/papi/v1/cm/commissionRate

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

Example Responses

{
  "symbol": "BTCUSD_PERP",
  "makerCommissionRate": "0.00015",
  "takerCommissionRate": "0.00040"
}

application/json

Get User Commission Rate for UM (USER_DATA)

Get User Commission Rate for UM

GET

/papi/v1/um/commissionRate

https://papi.binance.com

Get User Commission Rate for UM (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 User Commission Rate for UM (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 Weight20

Get User Commission Rate for UM (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 User Commission Rate for UM (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

Example: 5000

Get User Commission Rate for UM (USER_DATA) › Responses

200

Get User Commission Rate for UM

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

makerCommissionRate

string

0.02%

Example: 0.0002

takerCommissionRate

string

0.04%

Example: 0.0004

GET/papi/v1/um/commissionRate

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

Example Responses

{
  "symbol": "BTCUSDT",
  "makerCommissionRate": "0.0002",
  "takerCommissionRate": "0.0004"
}

application/json

Margin Max Borrow (USER_DATA)

Query margin max borrow

GET

/papi/v1/margin/maxBorrowable

https://papi.binance.com

Margin Max Borrow (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 Max Borrow (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 Max Borrow (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 Max Borrow (USER_DATA) › Query Parameters

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

recvWindow

integer · int64

The value cannot be greater than 60000

Example: 5000

Margin Max Borrow (USER_DATA) › Responses

200

Margin Max Borrow

amount

string

account's currently max borrowable amount with sufficient system availability

Example: 1.69248805

borrowLimit

string

max borrowable amount limited by the account level

Example: 60

GET/papi/v1/margin/maxBorrowable

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

Example Responses

{
  "amount": "1.69248805",
  "borrowLimit": "60"
}

application/json

Portfolio Margin UM Trading Quantitative Rules Indicators (USER_DATA)

Portfolio Margin UM Trading Quantitative Rules Indicators

GET

/papi/v1/um/apiTradingStatus

https://papi.binance.com

Portfolio Margin UM Trading Quantitative Rules Indicators (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

Portfolio Margin UM Trading Quantitative Rules Indicators (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
10 when symbol is omitted

Portfolio Margin UM Trading Quantitative Rules Indicators (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

Portfolio Margin UM Trading Quantitative Rules Indicators (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

Portfolio Margin UM Trading Quantitative Rules Indicators (USER_DATA) › Responses

200

Portfolio Margin UM Trading Quantitative Rules Indicators

object

Indicators.

updateTime

integer · int64

last update time

Example: 1644913304748

GET/papi/v1/um/apiTradingStatus

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

Example Responses

{
  "indicators": {
    "BTCUSDT": [
      {
        "isLocked": true,
        "plannedRecoverTime": 1545741270000,
        "indicator": "UFR",
        "value": 0.05,
        "triggerValue": 0.995
      }
    ],
    "ACCOUNT": [
      {
        "indicator": "TMV",
        "value": 10,
        "triggerValue": 1,
        "plannedRecoverTime": 1644919865000,
        "isLocked": true
      }
    ]
  },
  "updateTime": 1644913304748
}

application/json

Query CM Position Information (USER_DATA)

Get current CM position information.

GET

/papi/v1/cm/positionRisk

https://papi.binance.com

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

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

Query CM Position Information (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 Position Information (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

marginAsset

string

Example: USDT

pair

string

Example: BTCUSD_201225

recvWindow

integer · int64

Example: 5000

Query CM Position Information (USER_DATA) › Responses

200

CM Position Information

object

symbol

string

Trade symbol, if existing.

Example: BTCUSD_201225

positionAmt

string

position amount

Example: 0

entryPrice

string

average entry price

Example: 0.0

markPrice

string

Mark Price.

Example: 0.00000000

unRealizedProfit

string

Un Realized Profit.

Example: 0.00000000

liquidationPrice

string

Liquidation Price.

Example: 6170.20509059

leverage

string

current initial leverage

Example: 125

positionSide

string

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

Example: BOTH

updateTime

integer · int64

last update time

Example: 0

maxQty

string

maximum quantity of base asset

Example: 50

notionalValue

string

Notional Value.

Example: 0.00084827

GET/papi/v1/cm/positionRisk

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

Example Responses

[
  {
    "symbol": "BTCUSD_201225",
    "positionAmt": "0",
    "entryPrice": "0.0",
    "markPrice": "0.00000000",
    "unRealizedProfit": "0.00000000",
    "liquidationPrice": "6170.20509059",
    "leverage": "125",
    "positionSide": "BOTH",
    "updateTime": 0,
    "maxQty": "50",
    "notionalValue": "0.00084827"
  }
]

application/json

Query Margin Loan Record (USER_DATA)

Query margin loan record

GET

/papi/v1/margin/marginLoan

https://papi.binance.com

Query Margin Loan Record (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 Loan Record (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 Loan Record (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 Loan Record (USER_DATA) › Query Parameters

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

txId

integer · int64

the tranId in POST/papi/v1/marginLoan

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

current

integer · int64 · min: 1

Current page number.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results returned.

Example: 10

Default: 10

archived

string · enum

Set to true to query archived data from 6 months ago.

Enum values:

true

false

Example: true

Default: false

recvWindow

integer · int64

The value cannot be greater than 60000

Example: 5000

Query Margin Loan Record (USER_DATA) › Responses

200

Margin Loan Record

object[]

Rows.

total

integer · int64

Total.

Example: 1

GET/papi/v1/margin/marginLoan

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

Example Responses

{
  "rows": [
    {
      "txId": 12807067523,
      "asset": "BNB",
      "principal": "0.84624403",
      "timestamp": 1555056425000,
      "status": "CONFIRMED"
    }
  ],
  "total": 1
}

application/json

Query Margin Max Withdraw (USER_DATA)

Query Margin Max Withdraw

GET

/papi/v1/margin/maxWithdraw

https://papi.binance.com

Query Margin Max Withdraw (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 Max Withdraw (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 Max Withdraw (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 Max Withdraw (USER_DATA) › Query Parameters

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

recvWindow

integer · int64 · max: 60000

Example: 5000

Query Margin Max Withdraw (USER_DATA) › Responses

200

Margin Max Withdraw

amount

string

account's currently max withdrawable amount with sufficient system availability

Example: 60

GET/papi/v1/margin/maxWithdraw

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

Example Responses

{
  "amount": "60"
}

application/json

Query Margin repay Record (USER_DATA)

Query margin repay record.

GET

/papi/v1/margin/repayLoan

https://papi.binance.com

Query Margin repay Record (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 repay Record (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 repay Record (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 repay Record (USER_DATA) › Query Parameters

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

txId

integer · int64

the tranId in POST /papi/v1/repayLoan

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

current

integer · int64 · min: 1

Current page number.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results returned.

Example: 10

Default: 10

archived

string · enum

Set to true to query archived data from 6 months ago.

Enum values:

true

false

Example: true

Default: false

recvWindow

integer · int64 · max: 60000

Example: 5000

Query Margin repay Record (USER_DATA) › Responses

200

Margin repay Record

object[]

Rows.

total

integer · int64

Total.

Example: 1

GET/papi/v1/margin/repayLoan

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

Example Responses

{
  "rows": [
    {
      "amount": "14.00000000",
      "asset": "BNB",
      "interest": "0.01866667",
      "principal": "13.98133333",
      "status": "CONFIRMED",
      "timestamp": 1563438204000,
      "txId": 2970933056
    }
  ],
  "total": 1
}

application/json

Query Portfolio Margin Negative Balance Interest History (USER_DATA)

Query interest history of negative balance for portfolio margin.

GET

/papi/v1/portfolio/interest-history

https://papi.binance.com

Query Portfolio Margin Negative Balance Interest 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 Portfolio Margin Negative Balance Interest 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 Weight50

Query Portfolio Margin Negative Balance Interest 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 Portfolio Margin Negative Balance Interest History (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

asset

string

Example: USDT

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

size

integer · int64 · max: 100

Number of results returned.

Example: 10

Default: 10

recvWindow

integer · int64

Example: 5000

Query Portfolio Margin Negative Balance Interest History (USER_DATA) › Responses

200

Portfolio Margin Negative Balance Interest History

object

asset

string

asset name

Example: USDT

interest

string

interest amount

Example: 24.4440

interestAccuredTime

integer · int64

Interest Accured Time.

Example: 1670227200000

interestRate

string

daily interest rate

Example: 0.0001164

principal

string

Principal repaid

Example: 210000

GET/papi/v1/portfolio/interest-history

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

Example Responses

[
  {
    "asset": "USDT",
    "interest": "24.4440",
    "interestAccuredTime": 1670227200000,
    "interestRate": "0.0001164",
    "principal": "210000"
  }
]

application/json

Query UM Position Information (USER_DATA)

Get current UM position information.

GET

/papi/v1/um/positionRisk

https://papi.binance.com

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

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

Query UM Position Information (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 Position Information (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 UM Position Information (USER_DATA) › Responses

200

UM Position Information

object

entryPrice

string

average entry price

Example: 0.00000

leverage

string

current initial leverage

Example: 10

markPrice

string

Mark Price.

Example: 6679.50671178

maxNotionalValue

string

Max Notional Value.

Example: 20000000

positionAmt

string

position amount

Example: 0.000

notional

string

Notional.

Example: 0

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

unRealizedProfit

string

Un Realized Profit.

Example: 0.00000000

liquidationPrice

string

Liquidation Price.

Example: 6170.20509059

positionSide

string

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

Example: BOTH

updateTime

integer · int64

last update time

Example: 1625474304765

GET/papi/v1/um/positionRisk

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

Example Responses

[
  {
    "entryPrice": "0.00000",
    "leverage": "10",
    "markPrice": "6679.50671178",
    "maxNotionalValue": "20000000",
    "positionAmt": "0.000",
    "notional": "0",
    "symbol": "BTCUSDT",
    "unRealizedProfit": "0.00000000",
    "liquidationPrice": "6170.20509059",
    "positionSide": "BOTH",
    "updateTime": 1625474304765
  }
]

application/json

Query User Negative Balance Auto Exchange Record (USER_DATA)

Query user negative balance auto exchange record

GET

/papi/v1/portfolio/negative-balance-exchange-record

https://papi.binance.com

Query User Negative Balance Auto Exchange Record (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 Negative Balance Auto Exchange Record (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 User Negative Balance Auto Exchange Record (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 Negative Balance Auto Exchange Record (USER_DATA) › Query Parameters

startTime

integer · int64 · required

Example: 1623319461670

endTime

integer · int64 · required

Example: 1641782889000

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

Query User Negative Balance Auto Exchange Record (USER_DATA) › Responses

200

User Negative Balance Auto Exchange Record

total

integer · int64

Total.

Example: 2

object[]

Rows.

GET/papi/v1/portfolio/negative-balance-exchange-record

curl --request GET \
  --url 'https://papi.binance.com/papi/v1/portfolio/negative-balance-exchange-record?startTime=%3Cnumber%3E&endTime=%3Cnumber%3E&timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "total": 2,
  "rows": [
    {
      "startTime": 1736263046841,
      "endTime": 1736263248179,
      "details": [
        {
          "asset": "ETH",
          "negativeBalance": 1.10264488,
          "negativeMaxThreshold": 5
        }
      ]
    }
  ]
}

application/json

Query User Rate Limit (USER_DATA)

Query User Rate Limit

GET

/papi/v1/rateLimit/order

https://papi.binance.com

Query User Rate Limit (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 Rate Limit (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 Rate Limit (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 Rate Limit (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

Query User Rate Limit (USER_DATA) › Responses

200

User Rate Limit

object

rateLimitType

string

Rate Limit Type.

Example: ORDERS

interval

string

Interval.

Example: MINUTE

intervalNum

integer · int64

Interval Num.

Example: 1

limit

integer · int64

Limit.

Example: 1200

GET/papi/v1/rateLimit/order

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

Example Responses

[
  {
    "rateLimitType": "ORDERS",
    "interval": "MINUTE",
    "intervalNum": 1,
    "limit": 1200
  }
]

application/json

Repay futures Negative Balance (USER_DATA)

Repay futures Negative Balance

POST

/papi/v1/repay-futures-negative-balance

https://papi.binance.com

Repay futures Negative Balance (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

Repay futures Negative Balance (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 Weight750

Repay futures Negative Balance (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

Repay futures Negative Balance (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

Example: 5000

Repay futures Negative Balance (USER_DATA) › Responses

200

Repay futures Negative Balance

msg

string

Msg.

Example: success

POST/papi/v1/repay-futures-negative-balance

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

Example Request Body

{
  "timestamp": 1770736694138
}

Example Responses

{
  "msg": "success"
}

application/json

UM Futures Account Configuration (USER_DATA)

Query UM Futures account configuration

GET

/papi/v1/um/accountConfig

https://papi.binance.com

UM Futures Account Configuration (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 Futures Account Configuration (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 Futures Account Configuration (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 Futures Account Configuration (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

UM Futures Account Configuration (USER_DATA) › Responses

200

UM Futures Account Configuration

feeTier

integer · int64

account commission tier

Example: 0

canTrade

boolean

if can trade

Example: true

canDeposit

boolean

if can transfer in asset

Example: true

canWithdraw

boolean

if can transfer out asset

Example: true

dualSidePosition

boolean

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

Example: true

updateTime

integer · int64

reserved property, please ignore

Example: 1724416653850

multiAssetsMargin

boolean

Multi Assets Margin.

Example: false

tradeGroupId

integer · int64

Trade Group ID.

Example: -1

GET/papi/v1/um/accountConfig

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

Example Responses

{
  "feeTier": 0,
  "canTrade": true,
  "canDeposit": true,
  "canWithdraw": true,
  "dualSidePosition": true,
  "updateTime": 1724416653850,
  "multiAssetsMargin": false,
  "tradeGroupId": -1
}

application/json

UM Futures Symbol Configuration (USER_DATA)

Get current UM account symbol configuration.

GET

/papi/v1/um/symbolConfig

https://papi.binance.com

UM Futures Symbol Configuration (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 Futures Symbol Configuration (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 Futures Symbol Configuration (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 Futures Symbol Configuration (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: BTCUSDT

recvWindow

integer · int64

Example: 5000

UM Futures Symbol Configuration (USER_DATA) › Responses

200

UM Futures Symbol Configuration

object

symbol

string

Trade symbol, if existing.

Example: BTCUSDT

marginType

string

Margin Type.

Example: CROSSED

isAutoAddMargin

string

Is Auto Add Margin.

Example: false

leverage

integer · int64

current initial leverage

Example: 21

maxNotionalValue

string

Max Notional Value.

Example: 1000000

GET/papi/v1/um/symbolConfig

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

Example Responses

[
  {
    "symbol": "BTCUSDT",
    "marginType": "CROSSED",
    "isAutoAddMargin": "false",
    "leverage": 21,
    "maxNotionalValue": "1000000"
  }
]

application/json

UM Notional and Leverage Brackets (USER_DATA)

Query UM notional and leverage brackets

GET

/papi/v1/um/leverageBracket

https://papi.binance.com

UM Notional and Leverage Brackets (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 Notional and Leverage Brackets (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

UM Notional and Leverage Brackets (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 Notional and Leverage Brackets (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: ETHUSDT

recvWindow

integer · int64

Example: 5000

UM Notional and Leverage Brackets (USER_DATA) › Responses

200

UM Notional and Leverage Brackets

object

symbol

string

Trade symbol, if existing.

Example: ETHUSDT

notionalCoef

string

Notional Coef.

Example: 4.0

object[]

Brackets.

GET/papi/v1/um/leverageBracket

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

Example Responses

[
  {
    "symbol": "ETHUSDT",
    "notionalCoef": "4.0",
    "brackets": [
      {
        "bracket": 1,
        "initialLeverage": 75,
        "notionalCap": 10000,
        "notionalFloor": 0,
        "maintMarginRatio": 0.0065,
        "cum": 0
      }
    ]
  }
]

application/json