Skip to main content

/extended/v1/burnchain/rewards/{address} REST API Endpoint

Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info.

Updated on
Oct 4, 2023

/extended/v1/burnchain/rewards/{address} REST API Endpoint

Path Parameters

address
string
REQUIRED
Reward recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format.

Query Parameters

limit
integer
max number of rewards to fetch.
offset
integer
index of first reward to fetch.

Returns

object
object
GET request that returns blocks
limit
integer
The number of burnchain rewards to return.
offset
integer
The number of burnchain rewards to skip (starting at 0).
results
array
An array containing the block details.
canonical
boolean
Set to true if the block corresponds to the canonical burnchain tip.
burn_block_hash
string
The hash representing the burnchain block.
burn_block_height
integer
Height of the burnchain block.
burn_amount
string
The total amount of burnchain tokens burned for this burnchain block, in the smallest unit (e.g., satoshis for Bitcoin).
reward_recipient
string
The recipient address that received the burnchain rewards, in the format native to the burnchain (e.g., B58 encoded for Bitcoin).
reward_amount
string
The amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g., satoshis for Bitcoin).
reward_index
integer
The index position of the reward entry, useful for ordering when there's more than one recipient per burnchain block.
Request
1
curl -X 'GET' \
2
    'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v1/burnchain/rewards/1MoQF9nKga5RsCXPR3QYYurp5cRgUiDbM9' \
3
    -H 'Content-Type: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free