Get Yield Data For Cycle
API function to get the top participants for a given cycle.
Endpoint Requirements
GET
<api>/yield-leaderboard?network=<network>&cycle_id=<cycle>&limit=<limit>&address=<address>
Parameters
Name
Value
Required
Description
network
Network (devnet/testnet/mainnet
)
true
The network to fetch data for.
cycle_id
Number (0/1/...
)
true
The cycle to fetch data for.
address
Stacks Address (ST2TFVBMRPS5SSNP98DQKQ5JNB2B6NZM91C4K3P7B
)
false
If set, also returns data for this address if it isn't existent in the list, but is enrolled in the cycle.
limit
Number (100/200/1000
)
false
If set, returns only the X top participants (ordered descending by total holdings).
Headers
Name
Value
Content-Type
"application/json"
ngrok-skip-browser-warning
"1"
Example Request
Example Response
Last updated