Chain

Node API v1.0.0 (Arrekta Node API).

Method	Path	Summary
GET	`/v1/chain`	Chain Info
GET	`/v1/checkpoints`	Checkpoints
POST	`/v1/checkpoints`	Submit Checkpoint
GET	`/v1/deployments`	Deployments State
GET	`/v1/supply`	Supply
GET	`/v1/supply/circulating`	Supply Circulating
GET	`/v1/supply/total`	Supply Total

GET `/v1/chain`

Chain Info.

curl -s http://127.0.0.1:28332/v1/chain

Response 200 (application/json): ChainInfo

Field	Type	Required	Notes
`address_prefix`	string	yes
`asset_issuance_fee`	string	yes
`bits`	string	yes
`chain_id`	integer \| null	no	merged-mining chain id (AuxPoW slot id, §9.6). may be `null`
`chainwork`	string	yes
`coinbase_maturity`	integer	yes
`commitment_delay`	integer \| null	no	blocks between a state and the coinbase that commits to it (§9.8). may be `null`
`difficulty`	number	yes
`genesis`	string	yes
`height`	integer	yes
`implementation`	string	yes	one of `python`, `rust`
`max_block_size`	integer	yes
`median_time_past`	integer	yes
`mempool`	MempoolCount	yes
`network`	string	yes
`next_bits`	string	yes
`peers`	integer	yes
`pruned_height`	integer \| null	no	highest height whose block body this node pruned (ARREKTA_PRUNE); null on archival nodes. may be `null`
`signature_schemes`	string[]	yes
`subsidy`	string	yes
`target_spacing`	integer	yes
`tip`	string	yes
`tip_time`	integer	yes
`version`	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: chain_info_v1_chain_get

GET `/v1/checkpoints`

Checkpoints.

curl -s http://127.0.0.1:28332/v1/checkpoints

Response 200 (application/json): Checkpoints

Field	Type	Required	Notes
`enabled`	boolean	yes
`finality_floor`	FinalityFloor \| null	yes	may be `null`
`latest`	CheckpointInfo \| null	yes	may be `null`
`pending`	CheckpointInfo[]	yes
`signers`	SignerGroup \| 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: checkpoints_v1_checkpoints_get

POST `/v1/checkpoints`

Submit Checkpoint.

curl -s -X POST http://127.0.0.1:28332/v1/checkpoints -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): CheckpointSubmitted

Field	Type	Required	Notes
`height`	integer	yes
`signatures`	integer	yes
`status`	string	yes	one of `final`, `partial`, `known`

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_checkpoint_v1_checkpoints_post

GET `/v1/deployments`

Deployments State.

curl -s http://127.0.0.1:28332/v1/deployments

Response 200 (application/json): Deployments

Field	Type	Required	Notes
`deployments`	Deployment[]	yes
`height`	integer	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: deployments_state_v1_deployments_get

GET `/v1/supply`

Supply.

ARRK supply: total, circulating, emission (the fields listing sites ask for).

curl -s http://127.0.0.1:28332/v1/supply

Response 200 (application/json): SupplyInfo

Field	Type	Required	Notes
`asset`	string	yes
`burned`	string	yes
`circulating_supply`	string	yes	total minus immature coinbase outputs and the disclosed non-circulating wallets
`decimals`	integer	yes
`emission`	Emission	yes
`height`	integer	yes
`immature`	string	yes	coinbase outputs not yet spendable (coinbase maturity)
`issued`	string	yes
`max_supply`	string \| null	yes	null: no hard cap (tail emission, §10). may be `null`
`non_circulating`	NonCirculating[]	yes	wallets the operator lists in ARREKTA_SUPPLY_NONCIRCULATING (foundation, locked, burn)
`ticker`	string	yes
`total_supply`	string	yes	every ARRK in existence: issued minus burned

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: supply_v1_supply_get

GET `/v1/supply/circulating`

Supply Circulating.

Circulating supply in whole ARRK as a plain number.

curl -s http://127.0.0.1:28332/v1/supply/circulating

Response 200 (text/plain)

Type: string.

Errors 400, 404, 409, 422, 429: application/problem+json Problem with a stable code.

operationId: supply_circulating_v1_supply_circulating_get

GET `/v1/supply/total`

Supply Total.

Total supply in whole ARRK as a plain number (CoinGecko / CoinMarketCap supply URL).

curl -s http://127.0.0.1:28332/v1/supply/total

Response 200 (text/plain)

Type: string.

Errors 400, 404, 409, 422, 429: application/problem+json Problem with a stable code.

operationId: supply_total_v1_supply_total_get

Schemas

ChainInfo

Field	Type	Required	Notes
`address_prefix`	string	yes
`asset_issuance_fee`	string	yes
`bits`	string	yes
`chain_id`	integer \| null	no	merged-mining chain id (AuxPoW slot id, §9.6). may be `null`
`chainwork`	string	yes
`coinbase_maturity`	integer	yes
`commitment_delay`	integer \| null	no	blocks between a state and the coinbase that commits to it (§9.8). may be `null`
`difficulty`	number	yes
`genesis`	string	yes
`height`	integer	yes
`implementation`	string	yes	one of `python`, `rust`
`max_block_size`	integer	yes
`median_time_past`	integer	yes
`mempool`	MempoolCount	yes
`network`	string	yes
`next_bits`	string	yes
`peers`	integer	yes
`pruned_height`	integer \| null	no	highest height whose block body this node pruned (ARREKTA_PRUNE); null on archival nodes. may be `null`
`signature_schemes`	string[]	yes
`subsidy`	string	yes
`target_spacing`	integer	yes
`tip`	string	yes
`tip_time`	integer	yes
`version`	string	yes

Unknown fields may be added within v1; clients must ignore them.

CheckpointInfo

Field	Type	Required	Notes
`hash`	string	yes
`height`	integer	yes
`hex`	string	yes
`next_set`	string \| null	yes	may be `null`
`signers`	integer[]	yes

Unknown fields may be added within v1; clients must ignore them.

CheckpointSubmitted

Field	Type	Required	Notes
`height`	integer	yes
`signatures`	integer	yes
`status`	string	yes	one of `final`, `partial`, `known`

Unknown fields may be added within v1; clients must ignore them.

Checkpoints

Field	Type	Required	Notes
`enabled`	boolean	yes
`finality_floor`	FinalityFloor \| null	yes	may be `null`
`latest`	CheckpointInfo \| null	yes	may be `null`
`pending`	CheckpointInfo[]	yes
`signers`	SignerGroup \| null	yes	may be `null`

Unknown fields may be added within v1; clients must ignore them.

Deployment

Field	Type	Required	Notes
`bit`	integer	yes
`lock_in_on_timeout`	boolean	yes
`min_activation_height`	integer	yes
`name`	string	yes
`period`	integer	yes
`start_height`	integer	yes
`state`	string \| null	yes	may be `null`
`threshold`	integer	yes
`timeout_height`	integer	yes

Unknown fields may be added within v1; clients must ignore them.

Deployments

Field	Type	Required	Notes
`deployments`	Deployment[]	yes
`height`	integer	yes

Unknown fields may be added within v1; clients must ignore them.

Emission

Field	Type	Required	Notes
`annual_inflation_pct`	number	yes	annual issuance over total supply, percent
`annual_issuance`	string	yes	at the current reward
`blocks_per_year`	integer	yes
`halving_interval`	integer	yes
`next_halving_height`	integer \| null	yes	null once the reward has reached the tail. may be `null`
`subsidy`	string	yes	reward of the next block
`tail_subsidy`	string	yes	the reward never falls below this (§10)

Unknown fields may be added within v1; clients must ignore them.

FinalityFloor

Field	Type	Required	Notes
`hash`	string	yes
`height`	integer	yes

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`

MempoolCount

Field	Type	Required	Notes
`bytes`	integer	yes
`count`	integer	yes

Unknown fields may be added within v1; clients must ignore them.

NonCirculating

Field	Type	Required	Notes
`address`	string	yes
`balance`	string	yes	spendable ARRK (its immature coinbase outputs count as immature)
`label`	string	yes

Unknown fields may be added within v1; clients must ignore them.

SignerGroup

Field	Type	Required
`keys`	string[]	yes
`set_id`	string	yes
`threshold`	integer	yes

Unknown fields may be added within v1; clients must ignore them.

SupplyInfo

Field	Type	Required	Notes
`asset`	string	yes
`burned`	string	yes
`circulating_supply`	string	yes	total minus immature coinbase outputs and the disclosed non-circulating wallets
`decimals`	integer	yes
`emission`	Emission	yes
`height`	integer	yes
`immature`	string	yes	coinbase outputs not yet spendable (coinbase maturity)
`issued`	string	yes
`max_supply`	string \| null	yes	null: no hard cap (tail emission, §10). may be `null`
`non_circulating`	NonCirculating[]	yes	wallets the operator lists in ARREKTA_SUPPLY_NONCIRCULATING (foundation, locked, burn)
`ticker`	string	yes
`total_supply`	string	yes	every ARRK in existence: issued minus burned

Unknown fields may be added within v1; clients must ignore them.

Chain

GET /v1/chain

GET /v1/checkpoints

POST /v1/checkpoints

GET /v1/deployments

GET /v1/supply

GET /v1/supply/circulating

GET /v1/supply/total

Schemas

ChainInfo

CheckpointInfo

CheckpointSubmitted

Checkpoints

Deployment

Deployments

Emission

FinalityFloor

HexBody

MempoolCount

NonCirculating

SignerGroup

SupplyInfo

GET `/v1/chain`

GET `/v1/checkpoints`

POST `/v1/checkpoints`

GET `/v1/deployments`

GET `/v1/supply`

GET `/v1/supply/circulating`

GET `/v1/supply/total`