Skip to main content

/v2/pox REST API Endpoint

Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking.

Updated on
Jun 13, 2025

Parameters

This method does not accept any parameters

Returns

object

GET request to retrieve Proof of Transfer (PoX) information

contract_id
string

The contract ID associated with the current active Proof of Transfer (PoX) contract

pox_activation_threshold_ustx
integer

The threshold of uSTX that must be stacked to activate PoX for a cycle

first_burnchain_block_height
integer

The block height of the first burnchain block

current_burnchain_block_height
integer

The current height of the burnchain (Bitcoin)

prepare_phase_block_length
integer

The length of the prepare phase in blocks

reward_phase_block_length
integer

The length of the reward phase in blocks

reward_slots
integer

The maximum number of reward slots available per cycle

rejection_fraction
integer

The fraction of miners required to reject a block for it to be considered invalid, or null if not applicable

total_liquid_supply_ustx
integer

The total liquid supply of microstacks (uSTX)

current_cycle
object

Information about the current reward cycle

id
integer

The ID of the current reward cycle

min_threshold_ustx
integer

The minimum threshold of uSTX required to participate in the current cycle

stacked_ustx
integer

The total amount of uSTX stacked in the current cycle

is_pox_active
boolean

Indicates whether PoX is active for the current cycle

next_cycle
object

Information about the upcoming reward cycle

id
integer

The ID of the next reward cycle

min_threshold_ustx
integer

The minimum threshold of uSTX required to participate in the next cycle

min_increment_ustx
integer

The minimum increment of uSTX that can be stacked

stacked_ustx
integer

The total amount of uSTX currently stacked for the next cycle

prepare_phase_start_block_height
integer

The burnchain block height at which the prepare phase for the next cycle begins

blocks_until_prepare_phase
integer

The number of blocks until the prepare phase of the next cycle begins

reward_phase_start_block_height
integer

The burnchain block height at which the reward phase for the next cycle begins

blocks_until_reward_phase
integer

The number of blocks until the reward phase of the next cycle begins

ustx_until_pox_rejection
integer

The amount of uSTX needed to reach the rejection threshold, or null if not applicable

epochs
array

Array of epoch information defining protocol parameters at different block heights

epoch_id
string

The identifier of the epoch

start_height
integer

The starting block height of this epoch

end_height
integer

The ending block height of this epoch

block_limit
object

The block resource limits for this epoch

write_length
integer

The maximum write length limit for blocks in this epoch

write_count
integer

The maximum write count limit for blocks in this epoch

read_length
integer

The maximum read length limit for blocks in this epoch

read_count
integer

The maximum read count limit for blocks in this epoch

runtime
integer

The maximum runtime limit for blocks in this epoch

network_epoch
integer

The network epoch number

min_amount_ustx
integer

The minimum amount of microstacks (uSTX) required for PoX participation

prepare_cycle_length
integer

The length of the prepare cycle in blocks

reward_cycle_id
integer

The ID of the current reward cycle

reward_cycle_length
integer

The total length of a reward cycle in blocks (prepare + reward phases)

rejection_votes_left_required
integer

The number of rejection votes required to invalidate a block, or null if not applicable

next_reward_cycle_in
integer

The number of blocks until the next reward cycle begins

contract_versions
array

History of PoX contract versions and their activation details

contract_id
string

The contract ID of this PoX version

activation_burnchain_block_height
integer

The burnchain block height at which this contract version was activated

first_reward_cycle_id
integer

The ID of the first reward cycle that used this contract version

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free