Blocks
Node API v1.0.0 (Arrekta Node API).
| Method | Path | Summary |
|---|---|---|
| GET | /v1/blocks | List Blocks |
| GET | /v1/blocks/{block_id} | Get Block |
| GET | /v1/blocks/{block_id}/raw | Get Block Raw |
| GET | /v1/blocks/tip | Block Tip |
GET /v1/blocks
List Blocks.
curl -s http://127.0.0.1:28332/v1/blocksParameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
limit | query | integer | no | min 1, max 100, default 20 |
before_height | query | integer | null | no |
Response 200 (application/json): BlockPage
| Field | Type | Required | Notes |
|---|---|---|---|
items | BlockSummary[] | yes | |
next_before_height | integer | null | yes | may be null |
Unknown fields may be added within v1; clients must ignore them.
Errors 400, 404, 409, 422, 429: application/problem+json Problem with a stable code.
operationId: list_blocks_v1_blocks_get
GET /v1/blocks/{block_id}
Get Block.
curl -s http://127.0.0.1:28332/v1/blocks/<block_id>Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
block_id | path | string | yes | |
txs | query | string | no | pattern `^(none |
Response 200 (application/json): BlockDetail
| Field | Type | Required | Notes |
|---|---|---|---|
auxpow | AuxPowSummary | null | no | may be null |
bits | string | yes | |
chainwork | string | yes | |
confirmations | integer | yes | |
difficulty | number | yes | |
final | boolean | null | no | at or below the latest signed checkpoint. may be null |
hash | string | yes | |
height | integer | yes | |
in_active_chain | boolean | yes | |
merkle_root | string | yes | |
next_hash | string | null | no | may be null |
nonce | string | yes | |
prev_hash | string | yes | |
size | integer | yes | |
status | string | yes | |
timestamp | integer | yes | |
tx_count | integer | yes | |
txids | string[] | null | no | may be null |
txs | Tx[] | null | no | may be null |
version | integer | yes | |
witness_root | string | yes |
Unknown fields may be added within v1; clients must ignore them.
Errors 400, 404, 409, 422, 429: application/problem+json Problem with a stable code.
operationId: get_block_v1_blocks__block_id__get
GET /v1/blocks/{block_id}/raw
Get Block Raw.
curl -s http://127.0.0.1:28332/v1/blocks/<block_id>/rawParameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
block_id | path | string | yes |
Response 200 (application/json): RawHex
| Field | Type | Required | Notes |
|---|---|---|---|
hash | string | null | no | may be null |
hex | string | null | yes | may be null |
txid | string | null | no | may be null |
Unknown fields may be added within v1; clients must ignore them.
Errors 400, 404, 409, 422, 429: application/problem+json Problem with a stable code.
operationId: get_block_raw_v1_blocks__block_id__raw_get
GET /v1/blocks/tip
Block Tip.
curl -s http://127.0.0.1:28332/v1/blocks/tipResponse 200 (application/json): BlockDetail
| Field | Type | Required | Notes |
|---|---|---|---|
auxpow | AuxPowSummary | null | no | may be null |
bits | string | yes | |
chainwork | string | yes | |
confirmations | integer | yes | |
difficulty | number | yes | |
final | boolean | null | no | at or below the latest signed checkpoint. may be null |
hash | string | yes | |
height | integer | yes | |
in_active_chain | boolean | yes | |
merkle_root | string | yes | |
next_hash | string | null | no | may be null |
nonce | string | yes | |
prev_hash | string | yes | |
size | integer | yes | |
status | string | yes | |
timestamp | integer | yes | |
tx_count | integer | yes | |
txids | string[] | null | no | may be null |
txs | Tx[] | null | no | may be null |
version | integer | yes | |
witness_root | string | yes |
Unknown fields may be added within v1; clients must ignore them.
Errors 400, 404, 409, 422, 429: application/problem+json Problem with a stable code.
operationId: block_tip_v1_blocks_tip_get
Schemas
AuxPowSummary
Merged mining (§9.6): the parent-chain block whose work secured this block.
| Field | Type | Required | Notes |
|---|---|---|---|
chain_index | integer | yes | this chain's slot in the merged-mining tree |
chain_merkle_size | integer | yes | number of slots in the merged-mining tree |
coinbase_branch | integer | yes | Merkle branch length from the parent coinbase to its root |
coinbase_size | integer | yes | |
parent_hash | string | yes | parent-chain block hash, as committed in the AuxPoW |
parent_time | integer | yes | timestamp in the parent block header |
Unknown fields may be added within v1; clients must ignore them.
BlockDetail
| Field | Type | Required | Notes |
|---|---|---|---|
auxpow | AuxPowSummary | null | no | may be null |
bits | string | yes | |
chainwork | string | yes | |
confirmations | integer | yes | |
difficulty | number | yes | |
final | boolean | null | no | at or below the latest signed checkpoint. may be null |
hash | string | yes | |
height | integer | yes | |
in_active_chain | boolean | yes | |
merkle_root | string | yes | |
next_hash | string | null | no | may be null |
nonce | string | yes | |
prev_hash | string | yes | |
size | integer | yes | |
status | string | yes | |
timestamp | integer | yes | |
tx_count | integer | yes | |
txids | string[] | null | no | may be null |
txs | Tx[] | null | no | may be null |
version | integer | yes | |
witness_root | string | yes |
Unknown fields may be added within v1; clients must ignore them.
BlockPage
| Field | Type | Required | Notes |
|---|---|---|---|
items | BlockSummary[] | yes | |
next_before_height | integer | null | yes | may be null |
Unknown fields may be added within v1; clients must ignore them.
BlockSummary
| Field | Type | Required | Notes |
|---|---|---|---|
bits | string | yes | |
difficulty | number | yes | |
hash | string | yes | |
height | integer | yes | |
merkle_root | string | yes | |
nonce | string | yes | |
prev_hash | string | yes | |
size | integer | yes | |
timestamp | integer | yes | |
tx_count | integer | yes | |
version | integer | yes | |
witness_root | string | yes |
Unknown fields may be added within v1; clients must ignore them.
Freeze
| Field | Type | Required | Notes |
|---|---|---|---|
address | string | null | yes | may be null |
asset | string | yes | |
authority_for | string | null | no | may be null |
control_for | string | null | no | may be null |
decimals | integer | yes | |
frozen | boolean | yes | |
ticker | string | null | yes | may be null |
Unknown fields may be added within v1; clients must ignore them.
Issuance
| Field | Type | Required | Notes |
|---|---|---|---|
amount | string | yes | |
asset | string | yes | |
authority_asset | string | null | yes | may be null |
clawback | boolean | yes | |
control_asset | string | null | yes | may be null |
decimals | integer | yes | |
freezable | boolean | yes | |
max_supply | string | yes | |
metadata_hash | string | yes | |
mintable | boolean | yes | |
name | string | yes | |
ticker | string | yes |
Unknown fields may be added within v1; clients must ignore them.
Mint
| Field | Type | Required | Notes |
|---|---|---|---|
amount | string | yes | |
asset | string | yes | |
authority_for | string | null | no | may be null |
control_for | string | null | no | may be null |
decimals | integer | yes | |
ticker | string | null | yes | may be null |
Unknown fields may be added within v1; clients must ignore them.
RawHex
| Field | Type | Required | Notes |
|---|---|---|---|
hash | string | null | no | may be null |
hex | string | null | yes | may be null |
txid | string | null | no | may be null |
Unknown fields may be added within v1; clients must ignore them.
Tx
| Field | Type | Required | Notes |
|---|---|---|---|
clawback_inputs | integer[] | yes | |
coinbase | boolean | yes | |
fee | string | null | no | may be null |
freezes | Freeze[] | yes | |
inputs | TxInput[] | yes | |
issuances | Issuance[] | yes | |
lock_time | integer | yes | |
memo | string | yes | |
mints | Mint[] | yes | |
outputs | TxOutput[] | yes | |
size | integer | yes | |
status | TxStatus | null | no | may be null |
txid | string | yes | |
valid_until | integer | null | no | may be null |
version | integer | yes | |
wtxid | string | yes |
Unknown fields may be added within v1; clients must ignore them.
TxInput
| Field | Type | Required | Notes |
|---|---|---|---|
address | string | null | no | may be null |
amount | string | null | no | may be null |
asset | string | null | no | may be null |
decimals | integer | null | no | may be null |
sequence | integer | yes | |
ticker | string | null | no | may be null |
txid | string | yes | |
vout | integer | yes |
Unknown fields may be added within v1; clients must ignore them.
TxOutput
| Field | Type | Required | Notes |
|---|---|---|---|
address | string | null | yes | may be null |
amount | string | yes | |
asset | string | yes | |
authority_for | string | null | no | may be null |
burn_data | string | null | no | may be null |
control_for | string | null | no | may be null |
decimals | integer | yes | |
lock | string | yes | one of burn, pubkey_hash, multisig_hash, policy, reserved |
n | integer | yes | |
ticker | string | null | yes | may be null |
Unknown fields may be added within v1; clients must ignore them.
TxStatus
| Field | Type | Required | Notes |
|---|---|---|---|
block_hash | string | null | no | may be null |
block_height | integer | null | no | may be null |
confirmations | integer | null | no | may be null |
confirmed | boolean | yes | |
fee_per_kb | integer | null | no | may be null |
final | boolean | null | no | confirmed at or below the latest signed checkpoint: can never be reorganised. may be null |
first_seen | integer | null | no | may be null |
in_mempool | boolean | null | no | may be null |
replaced_by | string | null | no | evicted from the mempool by this fee-bump replacement (kept for recent replacements). may be null |
Unknown fields may be added within v1; clients must ignore them.