Path Parameters
- bond_indexintegerREQUIRED
The index of the bond in the PoX-5 bond list
Returns
- indexinteger
The index of the bond in the PoX-5 bond list
- pox_versionstring
Proof-of-Transfer protocol version.
- statusstring
Current status of the transaction or record.
- parametersobject
Parameters that configure the stacking schedule.
- target_rate_bpsinteger
The target yield rate (APY) in basis points
- stx_value_ratiointeger
This is a representation of the STXBTC price. The value represents "uSTX per 100 sats"
- minimum_stx_ratiointeger
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_capacitystring
The total capacity of BTC that can be locked up for this bond
- registrationsobject
Stacker registrations associated with the bond.
- allowed_countinteger
The number of entries in the allowlist for this bond
- registered_countinteger
The number of registrations for this bond
- scheduleobject
Stacking reward or unlock schedule.
- activationobject
Bond activation details.
- bitcoin_heightinteger
The height at which the bond was activated
- pox_cycleinteger
The POX cycle at which the bond was activated
- unlockobject
Unlock details for the stacked funds.
- bitcoin_heightinteger
The height at which the bond can be unlocked
- pox_cycleinteger
The POX cycle at which the bond can be unlocked
- balancesobject
Asset balances for the principal.
- lockedobject
Locked STX balance or lock details.
- btcstring
The total amount of BTC that is locked up for this bond
- stxstring
The total amount of STX that is locked up for this bond
- paid_outobject
Whether the reward has been paid out.
- btcstring
The total amount of BTC that has been paid out for this bond
- transactionobject
Transaction associated with the record.
- tx_idstring
The transaction ID that created the bond
- blockobject
Stacks block containing the transaction.
- heightinteger
Height of the block this transactions was associated with
- hashstring
Hash of the blocked this transactions was associated with
- index_hashstring
Hash of the index block this transactions was associated with
- timenumber
Unix timestamp (in seconds) indicating when this block was mined.
- tx_indexinteger
Index of the transaction, indicating the order. Starts at
0and increases with each transaction
- bitcoin_blockobject
Bitcoin block that anchors the Stacks block.
- heightinteger
Height of the anchor burn block.
- timenumber
Unix timestamp (in seconds) indicating when this block was mined.
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}