Mining REST API | Binance Developer Docs

Endpoint

Account List (USER_DATA)

Query Account List

GET

/sapi/v1/mining/statistics/user/list

https://api.binance.com

Account List (USER_DATA) › Authorization

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

Account List (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Account List (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Account List (USER_DATA) › Query Parameters

algo

string · required

Algorithm name.

Example: sha256

userName

string · required

Mining account

Example: test

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

Request validity window in milliseconds.

Example: 5000

Account List (USER_DATA) › Responses

200

Account List

code

integer · int64

Example: 0

msg

string

Example:

object[]

type

string

Type of hashrate bucket

Example: H_hashrate

userName

string

Mining account

Example: test

object[]

time

integer · int64

Time

Example: 1585267200000

hashrate

string

Hashrate

Example: 0.00000000

reject

string

Rejection rate

Example: 0.00000000

Acquiring Algorithm (MARKET_DATA)

Acquiring Algorithm

GET

/sapi/v1/mining/pub/algoList

https://api.binance.com

Acquiring Algorithm (MARKET_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

Acquiring Algorithm (MARKET_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

Acquiring Algorithm (MARKET_DATA) › Responses

200

Acquiring Algorithm

code

integer · int64

Example: 0

msg

string

Example:

object[]

algoName

string

Algorithm name

Example: SHA256-BTC

algoId

integer · int64

Algorithm ID

Example: 1

poolIndex

integer · int64

Sequence

Example: 100

unit

string

Unit

Example: h/s

Acquiring CoinName (MARKET_DATA)

Acquiring CoinName

GET

/sapi/v1/mining/pub/coinList

https://api.binance.com

Acquiring CoinName (MARKET_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

Acquiring CoinName (MARKET_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

Acquiring CoinName (MARKET_DATA) › Responses

200

Acquiring CoinName

code

integer · int64

Example: 0

msg

string

Example:

object[]

coinName

string

Currency name

Example: BTC

coinId

integer · int64

Example: 1

poolIndex

integer · int64

Sort

Example: 0

algoId

integer · int64

Algorithm

Example: 1

algoName

string

Name of algorithm

Example: SHA256-BTC

Cancel hashrate resale configuration (USER_DATA)

Cancel hashrate resale configuration

POST

/sapi/v1/mining/hash-transfer/config/cancel

https://api.binance.com

Cancel hashrate resale 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

Cancel hashrate resale 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 Weight1

Cancel hashrate resale 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

Cancel hashrate resale configuration (USER_DATA) › Request Body

configId

integer · int64 · required

Mining ID

Example: 168

userName

string · required

Mining Account

Example: test

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

Request validity window in milliseconds.

Example: 5000

Cancel hashrate resale configuration (USER_DATA) › Responses

200

Cancel hashrate resale configuration

code

integer · int64

Example: 0

msg

string

Example:

data

boolean

Example: true

Earnings List (USER_DATA)

Query Earnings List

GET

/sapi/v1/mining/payment/list

https://api.binance.com

Earnings List (USER_DATA) › Authorization

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

Earnings List (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Earnings List (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Earnings List (USER_DATA) › Query Parameters

algo

string · required

Algorithm name.

Example: sha256

userName

string · required

Mining account.

Example: test

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

coin

string

Coin name

Example: BTC

startDate

integer · int64

Search start time in milliseconds.

Example: 1770736694138

endDate

integer · int64

Search end time in milliseconds.

Example: 1770736694138

pageIndex

integer · int64

Page number, starting from 1.

Example: 1

Default: 1

pageSize

integer · int64 · min: 10 · max: 200

Number of rows per page.

Example: 10

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Earnings List (USER_DATA) › Responses

200

Earnings List

code

integer · int64

Example: 0

msg

string

Example:

object

object[]

time

integer · int64

Mining date

Example: 1586188800000

type

integer · int64

0: Mining Wallet, 5: Mining Address, 7: Pool Savings, 8: Transferred, 31: Income Transfer, 32: Hashrate Resale-Mining Wallet, 33: Hashrate Resale-Pool Savings

Example: 31

hashTransfer

integer · int64

Transferred hashrate

Example: 200000000000

transferAmount

number · float

Transferred income

Example: 0.02180958

dayHashRate

integer · int64

Daily hashrate

Example: 129129903378244

profitAmount

number · float

Earnings amount

Example: 8.6083060304

coinName

string

Coin type

Example: BTC

status

integer · int64

Status: 0 Unpaid, 1 Paying, 2 Paid

Example: 2

totalNum

integer · int64

Total rows

Example: 3

pageSize

integer · int64

Rows per page

Example: 20

Extra Bonus List (USER_DATA)

Extra Bonus List

GET

/sapi/v1/mining/payment/other

https://api.binance.com

Extra Bonus List (USER_DATA) › Authorization

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

Extra Bonus List (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Extra Bonus List (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Extra Bonus List (USER_DATA) › Query Parameters

algo

string · required

Transfer algorithm

Example: sha256

userName

string · required

Mining account

Example: test

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

coin

string

Coin name

Example: BTC

startDate

integer · int64

Search start time in milliseconds.

Example: 1770736694138

endDate

integer · int64

Search end time in milliseconds.

Example: 1770736694138

pageIndex

integer · int64

Page number, starting from 1.

Example: 1

Default: 1

pageSize

integer · int64 · min: 10 · max: 200

Number of rows per page.

Example: 10

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Extra Bonus List (USER_DATA) › Responses

200

Extra Bonus List

code

integer · int64

Example: 0

msg

string

Example:

object

object[]

time

integer · int64

Mining date

Example: 1607443200000

coinName

string

Coin name

Example: BTC

type

integer · int64

1: Merged Mining, 2: Activity Bonus, 3: Rebate, 4: Smart Pool, 6: Income Transfer, 7: Pool Savings

Example: 4

profitAmount

number · float

Amount

Example: 0.0011859

status

integer · int64

Status: 0 Unpaid, 1 Paying, 2 Paid

Example: 2

totalNum

integer · int64

Total rows

Example: 3

pageSize

integer · int64

Rows per page

Example: 20

Hashrate Resale Detail (USER_DATA)

Hashrate Resale Detail(USER_DATA)

GET

/sapi/v1/mining/hash-transfer/profit/details

https://api.binance.com

Hashrate Resale 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

Hashrate Resale 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 Weight1

Hashrate Resale 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

Hashrate Resale Detail (USER_DATA) › Query Parameters

configId

integer · int64 · required

Configuration ID.

Example: 168

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

pageIndex

integer · int64

Page number, starting from 1.

Example: 1

Default: 1

pageSize

integer · int64 · min: 10 · max: 200

Number of rows per page.

Example: 10

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Hashrate Resale Detail (USER_DATA) › Responses

200

Hashrate Resale Detail

code

integer · int64

Example: 0

msg

string

Example:

object

object[]

poolUsername

string

Transfer-out sub-account

Example: test4001

toPoolUsername

string

Transfer-in sub-account

Example: pop

algoName

string

Transfer algorithm name

Example: sha256

hashRate

integer · int64

Transferred hashrate

Example: 200000000000

day

integer · int64

Transfer date

Example: 20201213

amount

number · float

Transferred income

Example: 0.2256872

coinName

string

Income coin

Example: BTC

totalNum

integer · int64

Total rows

Example: 8

pageSize

integer · int64

Rows per page

Example: 200

Hashrate Resale List (USER_DATA)

Hashrate Resale List

GET

/sapi/v1/mining/hash-transfer/config/details/list

https://api.binance.com

Hashrate Resale List (USER_DATA) › Authorization

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

Hashrate Resale List (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Hashrate Resale List (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Hashrate Resale List (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

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

Example: 1770736694138

pageIndex

integer · int64

Page number, starting from 1.

Example: 1

Default: 1

pageSize

integer · int64 · min: 10 · max: 200

Number of rows per page.

Example: 10

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Hashrate Resale List (USER_DATA) › Responses

200

Hashrate Resale List

code

integer · int64

Example: 0

msg

string

Example:

object

object[]

configId

integer · int64

Configuration ID

Example: 168

poolUsername

string

Transfer-out sub-account

Example: 123

toPoolUsername

string

Transfer-in sub-account

Example: user1

algoName

string

Transfer algorithm name

Example: Ethash

hashRate

integer · int64

Transferred hashrate

Example: 5000000

startDay

integer · int64

Start date

Example: 20201210

endDay

integer · int64

End date

Example: 20210405

status

integer · int64

Status: 0 Processing, 1 Cancelled, 2 Terminated

Example: 1

type

integer · int64

Type: 0 Hashrate transfer record, 1 Hashrate receive record

Example: 0

totalNum

integer · int64

Total rows

Example: 21

pageSize

integer · int64

Rows per page

Example: 200

Hashrate Resale Request (USER_DATA)

Hashrate Resale Request

POST

/sapi/v1/mining/hash-transfer/config

https://api.binance.com

Hashrate Resale Request (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

Hashrate Resale Request (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

Hashrate Resale Request (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

Hashrate Resale Request (USER_DATA) › Request Body

userName

string · required

Mining Account

Example: test

algo

string · required

Transfer algorithm

Example: sha256

endDate

integer · int64 · required

Resale End Time (Millisecond timestamp)

Example: 1770736694138

startDate

integer · int64 · required

Resale Start Time(Millisecond timestamp)

Example: 1770736694138

toPoolUser

string · required

Mining Account

Example: S19pro

hashRate

integer · int64 · required

Resale hashrate h/s must be transferred (BTC is greater than 500000000000 ETH is greater than 500000)

Example: 100000000

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

Request validity window in milliseconds.

Example: 5000

Hashrate Resale Request (USER_DATA) › Responses

200

Hashrate Resale Request

code

integer · int64

Example: 0

msg

string

Example:

data

integer · int64

Configuration ID

Example: 171

Mining Account Earning (USER_DATA)

Mining Account Earning

GET

/sapi/v1/mining/payment/uid

https://api.binance.com

Mining Account Earning (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

Mining Account Earning (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

Mining Account Earning (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

Mining Account Earning (USER_DATA) › Query Parameters

algo

string · required

Algorithm

Example: sha256

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

startDate

integer · int64

Millisecond timestamp

Example: 1770736694138

endDate

integer · int64

Millisecond timestamp

Example: 1770736694138

pageIndex

integer · int64

Page number, starting from 1.

Example: 1

Default: 1

pageSize

integer · int64 · min: 10 · max: 200

Number of rows per page.

Example: 10

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Mining Account Earning (USER_DATA) › Responses

200

Mining Account Earning

code

integer · int64

Example: 0

msg

string

Example:

object

object[]

time

integer · int64

Time

Example: 1607443200000

coinName

string

Coin

Example: BTC

type

integer · int64

0: Referral, 1: Refund, 2: Rebate

Example: 2

puid

integer · int64

Mining sub-account ID

Example: 59985472

subName

string

Mining account

Example: vdvaghani

amount

number · float

Amount

Example: 0.09186957

totalNum

integer · int64

Total records

Example: 3

pageSize

integer · int64

Rows per page

Example: 20

Request for Detail Miner List (USER_DATA)

Request for Detail Miner List

GET

/sapi/v1/mining/worker/detail

https://api.binance.com

Request for Detail Miner List (USER_DATA) › Authorization

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

Request for Detail Miner List (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Request for Detail Miner List (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Request for Detail Miner List (USER_DATA) › Query Parameters

algo

string · required

Algorithm

Example: sha256

userName

string · required

Mining account

Example: test

workerName

string · required

Miner name.

Example: bhdc1.16A10404B

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

Request validity window in milliseconds.

Example: 5000

Request for Detail Miner List (USER_DATA) › Responses

200

Request for Detail Miner List

code

integer · int64

Example: 0

msg

string

Example:

object[]

workerName

string

Mining account name

Example: bhdc1.16A10404B

type

string

Type of hashrate bucket

Example: H_hashrate

object[]

time

integer · int64

Time

Example: 1587902400000

hashrate

string

Hashrate

Example: 0

reject

integer · int64

Rejection rate

Example: 0

Request for Miner List (USER_DATA)

Request for Miner List

GET

/sapi/v1/mining/worker/list

https://api.binance.com

Request for Miner List (USER_DATA) › Authorization

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

Request for Miner List (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Request for Miner List (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Request for Miner List (USER_DATA) › Query Parameters

algo

string · required

Algorithm

Example: sha256

userName

string · required

Mining account

Example: test

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

pageIndex

integer · int64

Page number, starting from 1.

Example: 1

Default: 1

sort

integer · int64

Sort order. 0 for ascending, 1 for descending.

Example: 0

Default: 0

sortColumn

integer · int64

Sort by: 1 miner name, 2 real-time hashrate, 3 daily average hashrate, 4 real-time rejection rate, 5 last submission time

Example: 1

Default: 1

workerStatus

integer · int64

Miner status. 0 all, 1 valid, 2 invalid, 3 failure.

Example: 0

Default: 0

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Request for Miner List (USER_DATA) › Responses

200

Request for Miner List

code

integer · int64

Example: 0

msg

string

Example:

object

object[]

workerId

string

Miner ID

Example: 1420554439452400131

workerName

string

Miner name

Example: 2X73

status

integer · int64

Status: 1 Valid, 2 Invalid, 3 No longer valid

Example: 3

hashRate

integer · int64

Real-time rate

Example: 0

dayHashRate

number · float

24H hashrate

Example: 12697781298013.66

rejectRate

integer · int64

Real-time rejection rate

Example: 0

lastShareTime

integer · int64

Last share time

Example: 1587712919000

totalNum

integer · int64

Total amount

Example: 18530

pageSize

integer · int64

Rows per page

Example: 20

Statistic List (USER_DATA)

Statistic List

GET

/sapi/v1/mining/statistics/user/status

https://api.binance.com

Statistic List (USER_DATA) › Authorization

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

Statistic List (USER_DATA) › Request Weight

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

Learn more in the Rate limits section.

IP Weight1

Statistic List (USER_DATA) › Headers

X-MBX-APIKEY

string · required

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

Example: API_KEY

Statistic List (USER_DATA) › Query Parameters

algo

string · required

Algorithm

Example: sha256

userName

string · required

Mining account

Example: test

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

Request validity window in milliseconds.

Example: 5000

Statistic List (USER_DATA) › Responses

200

Statistic List

code

integer · int64

Example: 0

msg

string

Example:

object

fifteenMinHashRate

string

15-minute hashrate

Example: 457835490067496409.00000000

dayHashRate

string

24H hashrate

Example: 214289268068874127.65000000

validNum

integer · int64

Effective quantity

Example: 0

invalidNum

integer · int64

Invalid quantity

Example: 17562

object

Today's estimate. Keys are coin symbols (e.g. BTC, BSV, BCH), values are earning amounts as strings.

Example: {"BTC":"0.00314332","BSV":"56.17055953","BCH":"106.61586001"}

Today's estimate. Keys are coin symbols (e.g. BTC, BSV, BCH), values are earning amounts as strings.

string

object

Yesterday's earnings. Keys are coin symbols (e.g. BTC, BSV, BCH), values are earning amounts as strings.

Example: {"BTC":"0.00314332","BSV":"56.17055953","BCH":"106.61586001"}

Yesterday's earnings. Keys are coin symbols (e.g. BTC, BSV, BCH), values are earning amounts as strings.

string

userName

string

Mining account

Example: test

unit

string

Unit

Example: h/s

algo

string

Algorithm

Example: sha256