Skip to main content

/extended/v3/staking/bonds/{bond_index} REST API Endpoint

Get bond

Updated on
Aug 18, 2026

Path Parameters

bond_index
integer
REQUIRED

The index of the bond in the PoX-5 bond list

Returns

index
integer

The index of the bond in the PoX-5 bond list

pox_version
string

Proof-of-Transfer protocol version.

status
string

Current status of the transaction or record.

parameters
object

Parameters that configure the stacking schedule.

target_rate_bps
integer

The target yield rate (APY) in basis points

stx_value_ratio
integer

This is a representation of the STXBTC price. The value represents "uSTX per 100 sats"

minimum_stx_ratio
integer

The amount of STX that must be locked relative to BTC, in equal-valued terms (ie in USD terms). This value is represented in basis points.

btc_capacity
string

The total capacity of BTC that can be locked up for this bond

registrations
object

Stacker registrations associated with the bond.

allowed_count
integer

The number of entries in the allowlist for this bond

registered_count
integer

The number of registrations for this bond

schedule
object

Stacking reward or unlock schedule.

activation
object

Bond activation details.

bitcoin_height
integer

The height at which the bond was activated

pox_cycle
integer

The POX cycle at which the bond was activated

unlock
object

Unlock details for the stacked funds.

bitcoin_height
integer

The height at which the bond can be unlocked

pox_cycle
integer

The POX cycle at which the bond can be unlocked

balances
object

Asset balances for the principal.

locked
object

Locked STX balance or lock details.

btc
string

The total amount of BTC that is locked up for this bond

stx
string

The total amount of STX that is locked up for this bond

paid_out
object

Whether the reward has been paid out.

btc
string

The total amount of BTC that has been paid out for this bond

transaction
object

Transaction associated with the record.

tx_id
string

The transaction ID that created the bond

block
object

Stacks block containing the transaction.

height
integer

Height of the block this transactions was associated with

hash
string

Hash of the blocked this transactions was associated with

index_hash
string

Hash of the index block this transactions was associated with

time
number

Unix timestamp (in seconds) indicating when this block was mined.

tx_index
integer

Index of the transaction, indicating the order. Starts at 0 and increases with each transaction

bitcoin_block
object

Bitcoin block that anchors the Stacks block.

height
integer

Height of the anchor burn block.

time
number

Unix timestamp (in seconds) indicating when this block was mined.

Request
Response
1
{
2
"statusCode": 404,
3
"error": "Not Found",
4
"message": "Bond not found"
5
}
1
{
2
"statusCode": 404,
3
"error": "Not Found",
4
"message": "Bond not found"
5
}
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free