Path Parameters
- principalstringREQUIRED
Stacks account or contract principal.
Returns
- stxobject
STX balance change details.
- lockedstring
The amount of uSTX currently locked in pox-5 STX staking
- 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)
- bondsobject
Stacking bonds associated with the principal.
- countinteger
Number of bonds this principal has a position in
- lockedobject
Locked STX balance or lock details.
- btcstring
Total BTC locked across all bond positions
- stxstring
Total STX locked across all bond positions
- 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"stx": {3"locked": "0",4"rewards": {5"btc": {6"accrued": "0",7"claimed": "0",8"claimable": "0"9}10}11},12"bonds": {13"count": 0,14"locked": {15"btc": "0",16"stx": "0"17},18"rewards": {19"btc": {20"accrued": "0",21"claimed": "0",22"claimable": "0"23}24}25}26}
1{2"stx": {3"locked": "0",4"rewards": {5"btc": {6"accrued": "0",7"claimed": "0",8"claimable": "0"9}10}11},12"bonds": {13"count": 0,14"locked": {15"btc": "0",16"stx": "0"17},18"rewards": {19"btc": {20"accrued": "0",21"claimed": "0",22"claimable": "0"23}24}25}26}