Skip to main content
POST
/
api
/
v4
/
mining
/
rewards
Get Rewards
curl --request POST \
  --url https://whitebit.com/api/v4/mining/rewards \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "account": "miner123",
  "from": 1640995200,
  "to": 1641081600,
  "limit": 30,
  "offset": 0
}
'
{
  "offset": 123,
  "limit": 123,
  "data": [
    {
      "miningAccountName": "miner123",
      "payoutDestination": "external_address",
      "payoutTransactionHash": "0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098",
      "payoutAddress": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
      "payoutTime": 1641085200,
      "rewardCurrency": "BTC",
      "totalReward": "0.00125",
      "reward": "0.001",
      "fee": "0.00025",
      "fppsRate": "0.000125",
      "hashRate": "100",
      "date": 1641081600
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://whitebit-mintlify-fix-broken-links-1776643999.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-TXC-APIKEY
string
header
required

The public WhiteBIT API key.

​
X-TXC-PAYLOAD
string
header
required

Base64-encoded JSON request body.

​
X-TXC-SIGNATURE
string
header
required

HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, api_secret)).

Body

application/json
​
account
string

Mining pool account

Example:

"miner123"

​
from
integer

Date timestamp starting from which rewards are received

Example:

1640995200

​
to
integer

Date timestamp until which rewards are received

Example:

1641081600

​
limit
integer
default:30
Required range: 1 <= x <= 100
Example:

30

​
offset
integer
default:0
Required range: 0 <= x <= 10000
Example:

0

Response

Successful response

​
offset
integer
​
limit
integer
​
data
object[]