Futures

Endpoint

Get User Customize Id (PAPI)

GET

/papi/v1/apiReferral/userCustomization

https://api.binance.com

Get User Customize Id (PAPI) › 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 Customize Id (PAPI) › 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

Get User Customize Id (PAPI) › Query Parameters

brokerId

string · required

Example: 1

timestamp

integer · int64 · required

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

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Example: 5000

Get User Customize Id (PAPI) › Responses

200

Get User’s Customize Id

brokerId

string

Example: ABCD1234

customerId

string

Example: abc123

Customize Id For PAPI Client

POST

/papi/v1/apiReferral/userCustomization

https://api.binance.com

Customize Id For PAPI Client › 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

Customize Id For PAPI Client › 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

Customize Id For PAPI Client › 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

Customize Id For PAPI Client › Request Body

customerId

string · required

Example: 1

brokerId

string · required

Example: 1

timestamp

integer · int64 · required

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

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Example: 5000

Customize Id For PAPI Client › Responses

200

Customize Id For Client

brokerId

string

Example: ABCD1234

customerId

string

Example: abc123

Get User's Customize Id (Futures)

GET

/fapi/v1/apiReferral/userCustomization

https://api.binance.com

Get User's Customize Id (Futures) › 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's Customize Id (Futures) › 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

Get User's Customize Id (Futures) › 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's Customize Id (Futures) › Query Parameters

brokerId

string · required

Example: 1

timestamp

integer · int64 · required

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

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Example: 5000

Get User's Customize Id (Futures) › Responses

200

Get User's Customize Id

brokerId

string

Example: ABCD1234

customerId

string

Example: abc123

Customize Id For Futures Client

POST

/fapi/v1/apiReferral/userCustomization

https://api.binance.com

Customize Id For Futures Client › 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

Customize Id For Futures Client › 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

Customize Id For Futures Client › 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

Customize Id For Futures Client › Request Body

customerId

string · required

Example: 1

brokerId

string · required

Example: 1

timestamp

integer · int64 · required

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

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Example: 5000

Customize Id For Futures Client › Responses

200

Customize Id For Client

brokerId

string

Example: ABCD1234

customerId

string

Example: abc123

Get Futures Client Email Customized Id

GET

/fapi/v1/apiReferral/customization

https://api.binance.com

Get Futures Client Email Customized Id › 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 Futures Client Email Customized Id › 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

Get Futures Client Email Customized Id › 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 Futures Client Email Customized Id › 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

customerId

string

Example: 1

email

string

Example: null

page

integer · int64

Example: null

Default: 1

limit

integer · int64 · max: 1000

Example: 100

Default: 100

recvWindow

integer · int64 · max: 60000

Example: 5000

Get Futures Client Email Customized Id › Responses

200

Get Client Email Customized Id

object

customerId

string

Example: abc123

email

string

Example: test12345@126.com

Partner Customize Id For Futures Client

POST

/fapi/v1/apiReferral/customization

https://api.binance.com

Partner Customize Id For Futures Client › 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

Partner Customize Id For Futures Client › 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

Partner Customize Id For Futures Client › 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

Partner Customize Id For Futures Client › Request Body

customerId

string · required

Example: 1

email

string · required

Example: null

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

Partner Customize Id For Futures Client › Responses

200

Customize Id For Client

customerId

string

Example: abc123

email

string

Example: test12345@126.com

Get Income History

GET

/fapi/v1/income

https://api.binance.com

Get Income History › 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 Income History › 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

Get Income History › 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 Income History › 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

incomeType

string · enum

Enum values:

TRANSFER

WELCOME_BONUS

REALIZED_PNL

FUNDING_FEE

COMMISSION

INSURANCE_CLEAR

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

limit

integer · int64 · max: 1000

Example: 100

Default: 100

recvWindow

integer · int64 · max: 60000

Example: 5000

Get Income History › Responses

200

Get Income History

object

symbol

string

Example: BTCUSDT

incomeType

string

Example: TRANSFER

income

string

Example: -0.37500000

asset

string

Example: USDT

info

string

Example:

time

integer · int64

Example: 1570608000000

Get Rebate Data Overview

GET

/fapi/v1/apiReferral/overview

https://api.binance.com

Get Rebate Data Overview › 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 Rebate Data Overview › 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

Get Rebate Data Overview › 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 Rebate Data Overview › 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

type

integer · int64

1: USDT-margined Futures, 2: Coin-margined Futures

Example: 1

Default: 1

recvWindow

integer · int64 · max: 60000

Example: 5000

Get Rebate Data Overview › Responses

200

Get Rebate Data Overview

brokerId

string

Example: ABCD1234

newTraderRebateCommission

string

Example: 0.30000000

oldTraderRebateCommission

string

Example: 0.20000000

totalTradeUser

integer · int64

Example: 13

unit

string

Example: USDT

totalTradeVol

string

Example: 405.54379000

totalRebateVol

string

Example: 0.01833800

time

integer · int64

Example: 1597708800000

Get Rebate Volume

GET

/fapi/v1/apiReferral/rebateVol

https://api.binance.com

Get Rebate Volume › 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 Rebate Volume › 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

Get Rebate Volume › 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 Rebate Volume › 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

type

integer · int64

1: USDT-margined Futures, 2: Coin-margined Futures

Example: 1

Default: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 1000

Example: 100

Default: 500

recvWindow

integer · int64 · max: 60000

Example: 5000

Get Rebate Volume › Responses

200

Get Rebate Volume

object

unit

string

Example: USDT

rebateVol

string

Example: 0.00023200

time

integer · int64

Example: 1586736000000

Get Trader Detail

GET

/fapi/v1/apiReferral/traderSummary

https://api.binance.com

Get Trader Detail › 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 Trader Detail › 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

Get Trader Detail › 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 Trader Detail › 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

customerId

string

Example: 1

type

integer · int64

1: USDT-margined Futures, 2: Coin-margined Futures

Example: 1

Default: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 1000

Example: 100

Default: 500

recvWindow

integer · int64 · max: 60000

Example: 5000

Get Trader Detail › Responses

200

Get Trader Detail

object

customerId

string

Example: sde001

unit

string

Example: USDT

tradeVol

string

Example: 9.57083000

rebateVol

string

Example: 0.00035400

time

integer · int64

Example: 1586736000000

Get Trader Number

GET

/fapi/v1/apiReferral/traderNum

https://api.binance.com

Get Trader Number › 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 Trader Number › 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

Get Trader Number › 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 Trader Number › 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

type

integer · int64

1: USDT-margined Futures, 2: Coin-margined Futures

Example: 1

Default: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 1000

Example: 100

Default: 500

recvWindow

integer · int64 · max: 60000

Example: 5000

Get Trader Number › Responses

200

Get Trader Number

object

newTrader

string

Example: 1

oldTrader

string

Example: 2

time

integer · int64

Example: 1586736000000

Get User Trade Volume

GET

/fapi/v1/apiReferral/tradeVol

https://api.binance.com

Get User Trade Volume › 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 Trade Volume › 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

Get User Trade Volume › 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 Trade Volume › 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

type

integer · int64

1: USDT-margined Futures, 2: Coin-margined Futures

Example: 1

Default: 1

startTime

integer · int64

Timestamp in ms to get funding from INCLUSIVE.

Example: 1623319461670

endTime

integer · int64

Timestamp in ms to get funding until INCLUSIVE.

Example: 1641782889000

limit

integer · int64 · max: 1000

Example: 500

Default: 500

recvWindow

integer · int64 · max: 60000

Example: 5000

Get User Trade Volume › Responses

200

Get User Trade Volume

object

unit

string

Example: USDT

tradeVol

string

Example: 53.60756000

time

integer · int64

Example: 1586736000000

Query PAPI Client New User Status

GET

/papi/v1/apiReferral/ifNewUser

https://api.binance.com

Query PAPI Client New User Status › 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 PAPI Client New User Status › 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 PAPI Client New User Status › 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 PAPI Client New User Status › Query Parameters

brokerId

string · required

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

type

integer · int64

1: USDT-margined Futures, 2: Coin-margined Futures

Example: 1

Default: 1

recvWindow

integer · int64 · max: 60000

Example: 5000

Query PAPI Client New User Status › Responses

200

Client If The New User

brokerId

string

Example: ABCD1234

rebateWorking

boolean

Example: false

ifNewUser

boolean

Example: true

Query Futures Client New User Status

GET

/fapi/v1/apiReferral/ifNewUser

https://api.binance.com

Query Futures Client New User Status › 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 Futures Client New User Status › 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 Futures Client New User Status › 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 Futures Client New User Status › Query Parameters

brokerId

string · required

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

type

integer · int64

1: USDT-margined Futures, 2: Coin-margined Futures

Example: 1

Default: 1

recvWindow

integer · int64 · max: 60000

Example: 5000

Query Futures Client New User Status › Responses

200

Client If The New User

brokerId

string

Example: ABCD1234

rebateWorking

boolean

Example: false

ifNewUser

boolean

Example: true