Skip to main content

/extended/v3/principals/{principal}/staking REST API Endpoint

A one-call overview of a principal's staking: its pox-5 STX-staking position (locked STX and its sBTC rewards) plus aggregate totals across all of its bond positions. The per-bond breakdown is paginated at /principals/:principal/staking/bonds.

Updated on
Aug 18, 2026

Path Parameters

principal
string
REQUIRED

Stacks account or contract principal.

Returns

stx
object

STX balance change details.

locked
string

The amount of uSTX currently locked in pox-5 STX staking

rewards
object

Stacking reward details.

btc
object

Bitcoin lockup and reward details.

accrued
string

The lifetime sBTC reward sats accrued to this position

claimed
string

The lifetime sBTC reward sats already claimed against this position

claimable
string

The sBTC reward sats currently claimable (accrued minus claimed)

bonds
object

Stacking bonds associated with the principal.

count
integer

Number of bonds this principal has a position in

locked
object

Locked STX balance or lock details.

btc
string

Total BTC locked across all bond positions

stx
string

Total STX locked across all bond positions

rewards
object

Stacking reward details.

btc
object

Bitcoin lockup and reward details.

accrued
string

The lifetime sBTC reward sats accrued to this position

claimed
string

The lifetime sBTC reward sats already claimed against this position

claimable
string

The sBTC reward sats currently claimable (accrued minus claimed)

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