v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
Mining Pool

Get 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>
post/api/v4/mining/rewards

Request body

accountstring

Mining pool account

frominteger

Date timestamp starting from which rewards are received

tointeger

Date timestamp until which rewards are received

limitinteger
offsetinteger

Example request

{
  "account": "miner123",
  "from": 1640995200,
  "to": 1641081600,
  "limit": 30
}

Response

Successful response

offsetinteger
limitinteger

Example response

{
  "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,
      "status": "pending"
    }
  ]
}