Skip to main content

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

Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`.

Updated on
Oct 4, 2023

/extended/v1/burnchain/rewards/{address}/total 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.

Returns

object
Total burnchain rewards made to a recipient
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 total amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g. satoshis for Bitcoin)
Request
1
curl -X 'GET' \
2
    'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v1/burnchain/rewards/1MoQF9nKga5RsCXPR3QYYurp5cRgUiDbM9/total' \
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