Proof Of Transfer

Endpoints to get information about the Proof of Transfer consensus mechanism

Get PoX transactions by burn block

get

Retrieves a list of PoX transactions confirmed by a specific burn block

Path parameters

height_or_hashany ofRequired

string · enumOptionalPossible values:

stringOptional

Burn block hash

Example: 0000000000000000000452773967cdd62297137cdaf79950c5e8bb0c62075133Pattern: ^(0x)?[a-fA-F0-9]{64}$

integerOptional

Burn block height

Example: 777678

Query parameters

limitinteger · max: 30Optional

Results per page

Default: 20

offsetintegerOptional

Result offset

Default: 0

Responses

200

Default Response

application/json

limitintegerRequiredExample: 20

offsetintegerRequiredExample: 0

totalintegerRequiredExample: 1

4XX

Default Response

application/json

get/extended/v2/burn-blocks/{height_or_hash}/pox-transactions

GET /extended/v2/burn-blocks/{height_or_hash}/pox-transactions HTTP/1.1
Host: api.hiro.so/
Accept: */*

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "burn_block_height": 1,
      "burn_block_hash": "text",
      "tx_id": "text",
      "recipient": "text",
      "utxo_idx": 1,
      "amount": "text"
    }
  ]
}

Get PoX cycles

get

Retrieves a list of PoX cycles

Query parameters

limitinteger · max: 60Optional

Results per page

Default: 20

offsetintegerOptional

Result offset

Default: 0

Responses

200

Default Response

application/json

limitintegerRequiredExample: 20

offsetintegerRequiredExample: 0

totalintegerRequiredExample: 1

4XX

Default Response

application/json

get/extended/v2/pox/cycles

GET /extended/v2/pox/cycles HTTP/1.1
Host: api.hiro.so/
Accept: */*

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "block_height": 1,
      "index_block_hash": "text",
      "cycle_number": 1,
      "total_weight": 1,
      "total_stacked_amount": "text",
      "total_signers": 1
    }
  ]
}

Get PoX cycle

get

Retrieves details for a PoX cycle

Path parameters

cycle_numberintegerRequired

PoX cycle number

Responses

200

Default Response

application/json

block_heightintegerRequired

index_block_hashstringRequired

cycle_numberintegerRequired

total_weightintegerRequired

total_stacked_amountstringRequired

total_signersintegerRequired

4XX

Default Response

application/json

get/extended/v2/pox/cycles/{cycle_number}

GET /extended/v2/pox/cycles/{cycle_number} HTTP/1.1
Host: api.hiro.so/
Accept: */*

{
  "block_height": 1,
  "index_block_hash": "text",
  "cycle_number": 1,
  "total_weight": 1,
  "total_stacked_amount": "text",
  "total_signers": 1
}

Get signers in PoX cycle

get

Retrieves a list of signers in a PoX cycle

Path parameters

cycle_numberintegerRequired

PoX cycle number

Query parameters

limitinteger · max: 250Optional

Results per page

Default: 100

offsetintegerOptional

Result offset

Default: 0

Responses

200

Default Response

application/json

limitintegerRequiredExample: 20

offsetintegerRequiredExample: 0

totalintegerRequiredExample: 1

4XX

Default Response

application/json

get/extended/v2/pox/cycles/{cycle_number}/signers

GET /extended/v2/pox/cycles/{cycle_number}/signers HTTP/1.1
Host: api.hiro.so/
Accept: */*

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "signing_key": "text",
      "signer_address": "text",
      "weight": 1,
      "stacked_amount": "text",
      "weight_percent": 1,
      "stacked_amount_percent": 1,
      "solo_stacker_count": 1,
      "pooled_stacker_count": 1
    }
  ]
}

Get signer in PoX cycle

get

Retrieves details for a signer in a PoX cycle

Path parameters

cycle_numberintegerRequired

PoX cycle number

signer_keystringRequired

Signer key

Example: 0x038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d

Responses

200

Default Response

application/json

signing_keystringRequired

signer_addressstringRequired

The Stacks address derived from the signing_key.

weightintegerRequired

stacked_amountstringRequired

weight_percentnumberRequired

stacked_amount_percentnumberRequired

solo_stacker_countintegerRequired

The number of solo stackers associated with this signer.

pooled_stacker_countintegerRequired

The number of pooled stackers associated with this signer.

4XX

Default Response

application/json

get/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}

GET /extended/v2/pox/cycles/{cycle_number}/signers/{signer_key} HTTP/1.1
Host: api.hiro.so/
Accept: */*

{
  "signing_key": "text",
  "signer_address": "text",
  "weight": 1,
  "stacked_amount": "text",
  "weight_percent": 1,
  "stacked_amount_percent": 1,
  "solo_stacker_count": 1,
  "pooled_stacker_count": 1
}

Get stackers for signer in PoX cycle

get

Retrieves a list of stackers for a signer in a PoX cycle

Path parameters

cycle_numberintegerRequired

PoX cycle number

signer_keystringRequired

Signer key

Example: 0x038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d

Query parameters

limitinteger · max: 200Optional

Results per page

Default: 100

offsetintegerOptional

Result offset

Default: 0

Responses

200

Default Response

application/json

limitintegerRequiredExample: 20

offsetintegerRequiredExample: 0

totalintegerRequiredExample: 1

4XX

Default Response

application/json

get/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers

GET /extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers HTTP/1.1
Host: api.hiro.so/
Accept: */*

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "stacker_address": "text",
      "stacked_amount": "text",
      "pox_address": "text",
      "stacker_type": "solo"
    }
  ]
}

Get PoX transactions for a burnchain address

get

Retrieves a list of PoX transactions

Path parameters

burnchain_addressstringRequired

Bitcoin Address

Example: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq

Query parameters

limitinteger · max: 30Optional

Results per page

Default: 20

offsetintegerOptional

Result offset

Default: 0

Responses

200

Default Response

application/json

limitintegerRequiredExample: 20

offsetintegerRequiredExample: 0

totalintegerRequiredExample: 1

4XX

Default Response

application/json

get/extended/v2/addresses/{burnchain_address}/pox-transactions

GET /extended/v2/addresses/{burnchain_address}/pox-transactions HTTP/1.1
Host: api.hiro.so/
Accept: */*

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "burn_block_height": 1,
      "burn_block_hash": "text",
      "tx_id": "text",
      "recipient": "text",
      "utxo_idx": 1,
      "amount": "text"
    }
  ]
}

PreviousMempool

NextStaking

Last updated 4 days ago

Was this helpful?