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 04, 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
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free