Path Parameters
- principalstringREQUIRED
Stacks account or contract principal.
Query Parameters
- limitinteger
Number of results per page
- cursorstring
(Optional) Cursor for paginating bonds. Format: bond_index
Returns
- totalinteger
Total number of matching records.
- limitinteger
Number of results per page
- cursorobject
Cursor metadata for this page of results.
- nextstring | null
Cursor for the next page, or null when there is no next page.
- previousstring | null
Cursor for the previous page, or null when there is no previous page.
- currentstring
Cursor identifying the current page.
- resultsarray
Items returned for the current page.
- bond_indexinteger
The index of the bond in the PoX-5 bond list
- statusstring
Current status of the transaction or record.
- activeboolean
Whether the position is active
- enrollmentobject
Signer enrollment details.
- tx_idstring
Transaction ID
- btc_lockupobject
Bitcoin lockup details for the bond.
- amountstring
The amount of BTC that is locked up for this principal
- lockedobject
Locked STX balance or lock details.
- btcstring
The amount of BTC locked in this bond position
- stxstring
The amount of STX locked in this bond position
- rewardsobject
Stacking reward details.
- btcobject
Bitcoin lockup and reward details.
- accruedstring
The lifetime sBTC reward sats accrued to this position
- claimedstring
The lifetime sBTC reward sats already claimed against this position
- claimablestring
The sBTC reward sats currently claimable (accrued minus claimed)
1{2"total": 0,3"limit": 1,4"cursor": {5"next": null,6"previous": null,7"current": null8},9"results": []10}
1{2"total": 0,3"limit": 1,4"cursor": {5"next": null,6"previous": null,7"current": null8},9"results": []10}