---
title: "Get Rewards"
method: POST
path: "/api/v4/mining/rewards"
tags: ["Mining Pool"]
---

# Get Rewards

`POST /api/v4/mining/rewards`

The endpoint returns rewards received from mining.
Results are ordered by reward date, newest first.

The response does not include a `total` field. Detect the last page when
`data.length < limit`.

The `offset` parameter is capped at 10000. To paginate reward histories
beyond that, window the request by `from` and `to` (Unix timestamps).

<Note>
The `account` filter is not validated at the request layer. An unknown or
not-owned account name is treated as an empty filter and returns HTTP `200`
with an empty `data` array — the same response as a valid account with no
rewards in the requested window. An account without mining access also
returns empty data, so an empty response does not distinguish "no mining
access" from "no rewards in range."
</Note>

<Warning>
Rate limit: 1000 requests/10 sec.
</Warning>

<Note>
The API does not cache the response.
</Note>

## Request body

- object
  - `account` string — Mining pool account
  - `from` integer — Date timestamp starting from which rewards are received
  - `to` integer — Date timestamp until which rewards are received
  - `limit` integer
  - `offset` integer

## Response `200`

Successful response

- object
  - `offset` integer
  - `limit` integer
  - `data` MiningReward[]
    - `miningAccountName` string — Mining account name
    - `payoutDestination` 'main_balance' | 'external_address' — Payout destination
    - `payoutTransactionHash` string, nullable — Payout transaction hash. null in case payout destination is main_balance, blockchain transaction hash in case payout destination is external_address
    - `payoutAddress` string, nullable — Payout address. External wallet address in case payout destination is external_address, null in case payout destination is main_balance
    - `payoutTime` integer, nullable — Timestamp when the external transaction is completed. null in case payout destination is main_balance
    - `rewardCurrency` string — Reward currency
    - `totalReward` string — Total reward amount
    - `reward` string — Reward amount (without fee)
    - `fee` string — Fee amount
    - `fppsRate` string — FPPS rate
    - `hashRate` string — Hash rate (H/s)
    - `date` integer — Reward date timestamp
    - `status` 'pending' | 'successful' | 'canceled' — Current status of the mining reward. Possible values: - `pending` — the reward is not finalized yet. May mean either "waiting for block confirmations / batch accumulation" or "ready for payout, but the onchain transaction hasn't gone through". No user action needed — just wait. - `successful` — the reward is finalized. For `main_balance` payout, funds are credited to the main balance. For `external_address` payout, the onchain transaction is confirmed. - `canceled` — the reward was canceled.

## Other responses

- `400` — Pagination validation failed. The `errors` values are translation keys that may render as localized strings.
- `422` — Request validation failed

---

[API](https://skmtc.net/whitebit/apis/whitebit-private-http-api-v4.md) · [All operations](https://skmtc.net/whitebit/apis/whitebit-private-http-api-v4/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/whitebit/whitebit-private-http-api-v4/versions/76c9def9942f/schema)