Skip to main content

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

Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address.

Updated on
Oct 4, 2023

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

Path Parameters

address
string
REQUIRED
Reward slot holder 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 items to fetch.
offset
integer
index of the first items to fetch.

Returns

GET request that returns reward slot holders
object
limit
integer
The number of items to return.
offset
integer
The number of items to skip (starting at 0).
total
integer
Total number of available items.
results
array
An array containing the reward slot holder 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.
address
string
The recipient address that validly received PoX commitments, in the format native to the burnchain (e.g., B58 encoded for Bitcoin).
slot_index
integer
The index position of the reward entry, useful for ordering when there's more than one slot per burnchain block.
Request
1
curl -X 'GET' \
2
    'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v1/burnchain/reward_slot_holders/1EbveiEWAQvaeyRW69QSjxrMkTLeNVPSn9' \
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