Transactions
Node API v1.0.0 (Arrekta Node API).
| Method | Path | Summary |
|---|---|---|
| POST | /v1/txs | Submit Tx |
| GET | /v1/txs/{txid} | Get Tx |
| GET | /v1/txs/{txid}/proof | Get Tx Proof |
| GET | /v1/txs/{txid}/raw | Get Tx Raw |
| POST | /v1/txs/decode | Decode Tx |
| POST | /v1/txs/package | Submit Package |
POST /v1/txs
Submit Tx.
curl -s -X POST http://127.0.0.1:28332/v1/txs -H 'content-type: application/json' -d '{…}'Request body (application/json, required): HexBody
| Field | Type | Required | Notes |
|---|---|---|---|
hex | string | yes | Hex-encoded serialized object. max length 16000002 |
Response 202 (application/json): TxAccepted
| Field | Type | Required | Notes |
|---|---|---|---|
fee | string | yes | |
fee_per_kb | integer | yes | |
size | integer | yes | |
txid | 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: submit_tx_v1_txs_post
GET /v1/txs/{txid}
Get Tx.
curl -s http://127.0.0.1:28332/v1/txs/<txid>Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
txid | path | string | yes |
Response 200 (application/json): 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.
Errors 400, 404, 409, 422, 429: application/problem+json Problem with a stable code.
operationId: get_tx_v1_txs__txid__get
GET /v1/txs/{txid}/proof
Get Tx Proof.
Self-contained proof that the transaction is final under a signed checkpoint (§9.9), verifiable against the network's genesis checkpoint group.
curl -s http://127.0.0.1:28332/v1/txs/<txid>/proofParameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
txid | path | string | yes |
Response 200 (application/json): FinalityProof
A finality proof (PROTOCOL.md §9.9) and what it proves under the genesis signer group.
| Field | Type | Required | Notes |
|---|---|---|---|
block_hash | string | yes | |
checkpoint_height | integer | yes | |
handovers | integer | yes | |
headers | integer | yes | |
height | integer | yes | |
hex | string | yes | |
signer_set_id | string | yes | |
txid | 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_tx_proof_v1_txs__txid__proof_get
GET /v1/txs/{txid}/raw
Get Tx Raw.
curl -s http://127.0.0.1:28332/v1/txs/<txid>/rawParameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
txid | 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_tx_raw_v1_txs__txid__raw_get
POST /v1/txs/decode
Decode Tx.
curl -s -X POST http://127.0.0.1:28332/v1/txs/decode -H 'content-type: application/json' -d '{…}'Request body (application/json, required): HexBody
| Field | Type | Required | Notes |
|---|---|---|---|
hex | string | yes | Hex-encoded serialized object. max length 16000002 |
Response 200 (application/json): 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.
Errors 400, 404, 409, 422, 429: application/problem+json Problem with a stable code.
operationId: decode_tx_v1_txs_decode_post
POST /v1/txs/package
Submit Package.
Fee bumping: a low-fee parent plus the child that pays for it (§13.2).
curl -s -X POST http://127.0.0.1:28332/v1/txs/package -H 'content-type: application/json' -d '{…}'Request body (application/json, required): PackageBody
| Field | Type | Required | Notes |
|---|---|---|---|
hex | string[] | yes | [parent, child] raw transactions. min items 2, max items 2 |
Response 200 (application/json): PackageAccepted
| Field | Type | Required | Notes |
|---|---|---|---|
package_fee | string | yes | |
package_size | integer | yes | |
txids | 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: submit_package_v1_txs_package_post
Schemas
FinalityProof
A finality proof (PROTOCOL.md §9.9) and what it proves under the genesis signer group.
| Field | Type | Required | Notes |
|---|---|---|---|
block_hash | string | yes | |
checkpoint_height | integer | yes | |
handovers | integer | yes | |
headers | integer | yes | |
height | integer | yes | |
hex | string | yes | |
signer_set_id | string | yes | |
txid | 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.
HexBody
| Field | Type | Required | Notes |
|---|---|---|---|
hex | string | yes | Hex-encoded serialized object. max length 16000002 |
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.
PackageAccepted
| Field | Type | Required | Notes |
|---|---|---|---|
package_fee | string | yes | |
package_size | integer | yes | |
txids | string[] | yes |
Unknown fields may be added within v1; clients must ignore them.
PackageBody
| Field | Type | Required | Notes |
|---|---|---|---|
hex | string[] | yes | [parent, child] raw transactions. min items 2, max items 2 |
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.
TxAccepted
| Field | Type | Required | Notes |
|---|---|---|---|
fee | string | yes | |
fee_per_kb | integer | yes | |
size | integer | yes | |
txid | 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.