Chains

Lists block hashes

get

Lists block hashes from '', up to the last checkpoint, sorted with decreasing fitness. Without arguments it returns the head of the chain. Optional arguments allow to return the list of predecessors of a given block or of a set of blocks.

Authorizations
api-keystringRequired
Path parameters
chain_idstringRequired

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Query parameters
lengthstringOptional

The requested number of predecessors to return (per request; see next argument).

headstringOptional

block_hash (Base58Check-encoded) An empty argument requests blocks starting with the current head. A non empty list allows to request one or more specific fragments of the chain.

min_datestringOptional

A date in seconds from epoch When min_date is provided, blocks with a timestamp before min_date are filtered out. However, if the length parameter is also provided, then up to that number of predecessors will be returned regardless of their date.

Responses
chevron-right
200

Valid response

application/json
itemsone ofOptional
stringOptional
or
get
/chains/{chain_id}/blocks

Chain ID

get

The chain unique identifier.

Authorizations
api-keystringRequired
Path parameters
chain_idstringRequired

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses
chevron-right
200

Valid response

application/json
stringOptional
or
get
/chains/{chain_id}/chain_id

Checkpoint

get

DEPRECATED: use ../levels/{checkpoint, savepoint, caboose, history_mode} instead. The current checkpoint for this chain.

Authorizations
api-keystringRequired
Path parameters
chain_idstringRequired

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses
chevron-right
200

Valid response

application/json
savepointinteger · min: -2147483648 · max: 2147483647Required
cabooseinteger · min: -2147483648 · max: 2147483647Required
history_modeone ofRequired

Storage mode for the Tezos shell.

string · enumOptional

Archive mode retains every block and operations since the genesis block including their metadata and their associated contexts.

Possible values:
or
or
or
string · enumOptional

Full mode with default number of additional cycles.

Possible values:
get
/chains/{chain_id}/checkpoint

Invalid blocks

get

Lists blocks that have been declared invalid along with the errors that led to them being declared invalid.

Authorizations
api-keystringRequired
Path parameters
chain_idstringRequired

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses
chevron-right
200

Valid response

application/json
blockone ofRequired
stringOptional
or
levelinteger · min: -2147483648 · max: 2147483647Required
errorsanyRequired

The full list of errors is available with the global RPC GET errors

get
/chains/{chain_id}/invalid_blocks

The errors that appears during the block (in)validation.

get

The errors that appears during the block (in)validation.

Authorizations
api-keystringRequired
Path parameters
chain_idstringRequired

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

block_hashstringRequired

block_hash (Base58Check-encoded)

Responses
chevron-right
200

Valid response

application/json
blockone ofRequired
stringOptional
or
levelinteger · min: -2147483648 · max: 2147483647Required
errorsanyRequired

The full list of errors is available with the global RPC GET errors

get
/chains/{chain_id}/invalid_blocks/{block_hash}

Is bootstrapped

get

The bootstrap status of a chain

Authorizations
api-keystringRequired
Path parameters
chain_idstringRequired

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses
chevron-right
200

Valid response

application/json
bootstrappedbooleanRequired
sync_statestring · enumRequired

If 'unsynced', the node is not currently synchronized with of its peers (it is probably still bootstrapping and its head is lagging behind the chain's). If 'synced', the node considers itself synchronized with its peers and the current head timestamp is recent. If 'stuck', the node considers itself synchronized with its peers but the chain seems to be halted from its viewpoint.

Possible values:
get
/chains/{chain_id}/is_bootstrapped

Caboose

get

The current caboose for this chain.

Authorizations
api-keystringRequired
Path parameters
chain_idstringRequired

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses
chevron-right
200

Valid response

application/json
block_hashone ofRequired
stringOptional
or
levelinteger · min: -2147483648 · max: 2147483647Required
get
/chains/{chain_id}/levels/caboose

Checkpoint

get

The current checkpoint for this chain.

Authorizations
api-keystringRequired
Path parameters
chain_idstringRequired

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses
chevron-right
200

Valid response

application/json
block_hashone ofRequired
stringOptional
or
levelinteger · min: -2147483648 · max: 2147483647Required
get
/chains/{chain_id}/levels/checkpoint

Savepoint

get

The current savepoint for this chain.

Authorizations
api-keystringRequired
Path parameters
chain_idstringRequired

A chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.

Responses
chevron-right
200

Valid response

application/json
block_hashone ofRequired
stringOptional
or
levelinteger · min: -2147483648 · max: 2147483647Required
get
/chains/{chain_id}/levels/savepoint

Last updated