API docs by Redocly

Octez Protocol alpha RPC (Octez 1111.0~rc2+dev (958bc09e))

Download OpenAPI specification:

The RPC API for protocol alpha served by the Octez node.

/

All the information about a block. The associated metadata may not be present depending on the history mode and block's distance from the head.

query Parameters
version
required
string

Supported RPC versions are version "1" (default)

force_metadata
string

DEPRECATED: Forces to recompute the operations metadata if it was considered as too large.

metadata
string

defines the way metadata are queried Specifies whether or not if the operations metadata should be returned. To get the metadata, even if it is needed to recompute them, use "always". To avoid getting the metadata, use "never". By default, the metadata will be returned depending on the node's metadata size limit policy.

Responses

Response samples

Content type
application/json
{
  • "protocol": "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im",
  • "chain_id": "string",
  • "hash": "string",
  • "header": {
    },
  • "metadata": {
    },
  • "operations": [
    ]
}

/context/adaptive_issuance_launch_cycle

Returns the cycle at which the launch of the Adaptive Issuance feature is set to happen. A result of None means that the feature is not yet set to launch.

Responses

Response samples

Content type
application/json
0
0

/context/big_maps/{big_map_id}

Get the (optionally paginated) list of values in a big map. Order of values is unspecified, but is guaranteed to be consistent.

path Parameters
big_map_id
required
string

A big map identifier

query Parameters
offset
string

A non-negative integer (greater than or equal to 0). Skip the first [offset] values. Useful in combination with [length] for pagination.

length
string

A non-negative integer (greater than or equal to 0). Only retrieve [length] values. Useful in combination with [offset] for pagination.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/big_maps/{big_map_id}/{script_expr}

Access the value associated with a key in a big map.

path Parameters
big_map_id
required
string

A big map identifier

script_expr
required
string

script_expr (Base58Check-encoded)

Responses

Response samples

Content type
application/json
Example
{
  • "int": "string"
}

/context/big_maps/{big_map_id}/{script_expr}/normalized

Access the value associated with a key in a big map, normalize the output using the requested unparsing mode.

path Parameters
big_map_id
required
string

A big map identifier

script_expr
required
string

script_expr (Base58Check-encoded)

Request Body schema: application/json
required
Readable (string) or Optimized (string) or Optimized_legacy (string)

Responses

Request samples

Content type
application/json
{
  • "unparsing_mode": "Readable"
}

Response samples

Content type
application/json
Example
{
  • "int": "string"
}

/context/cache/contracts/all

Return the list of cached contracts

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

/context/cache/contracts/rank

Return the number of cached contracts older than the provided contract

Request Body schema: application/json
One of
One of
string (Universal string representation)

Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
0
0

/context/cache/contracts/size

Return the size of the contract cache

Responses

Response samples

Content type
application/json
-1073741824

/context/cache/contracts/size_limit

Return the size limit of the contract cache

Responses

Response samples

Content type
application/json
-1073741824

/context/constants

All constants

Responses

Response samples

Content type
application/json
{
  • "proof_of_work_nonce_size": 255,
  • "nonce_length": 255,
  • "max_anon_ops_per_block": 255,
  • "max_operation_data_length": -1073741824,
  • "max_proposals_per_delegate": 255,
  • "max_micheline_node_count": -1073741824,
  • "max_micheline_bytes_limit": -1073741824,
  • "max_allowed_global_constants_depth": -1073741824,
  • "cache_layout_size": 255,
  • "michelson_maximum_type_size": 65535,
  • "denunciation_period": 255,
  • "slashing_delay": 255,
  • "smart_rollup_max_wrapped_proof_binary_size": -1073741824,
  • "smart_rollup_message_size_limit": -1073741824,
  • "smart_rollup_max_number_of_messages_per_level": "string",
  • "consensus_rights_delay": 255,
  • "blocks_preservation_cycles": 255,
  • "delegate_parameters_activation_delay": 255,
  • "tolerated_inactivity_period": 255,
  • "blocks_per_cycle": -2147483648,
  • "blocks_per_commitment": -2147483648,
  • "nonce_revelation_threshold": -2147483648,
  • "cycles_per_voting_period": -2147483648,
  • "hard_gas_limit_per_operation": "string",
  • "hard_gas_limit_per_block": "string",
  • "proof_of_work_threshold": "string",
  • "minimal_stake": "string",
  • "minimal_frozen_stake": "string",
  • "vdf_difficulty": "string",
  • "origination_size": -1073741824,
  • "issuance_weights": {
    },
  • "cost_per_byte": "string",
  • "hard_storage_limit_per_operation": "string",
  • "quorum_min": -2147483648,
  • "quorum_max": -2147483648,
  • "min_proposal_quorum": -2147483648,
  • "liquidity_baking_subsidy": "string",
  • "liquidity_baking_toggle_ema_threshold": -2147483648,
  • "max_operations_time_to_live": -32768,
  • "minimal_block_delay": "string",
  • "delay_increment_per_round": "string",
  • "consensus_committee_size": -1073741824,
  • "consensus_threshold_size": -1073741824,
  • "minimal_participation_ratio": {
    },
  • "limit_of_delegation_over_baking": 255,
  • "percentage_of_frozen_deposits_slashed_per_double_baking": 65535,
  • "max_slashing_per_block": 65535,
  • "max_slashing_threshold": {
    },
  • "testnet_dictator": "string",
  • "initial_seed": "string",
  • "cache_script_size": -1073741824,
  • "cache_stake_distribution_cycles": -128,
  • "cache_sampler_state_cycles": -128,
  • "dal_parametric": {
    },
  • "smart_rollup_arith_pvm_enable": true,
  • "smart_rollup_origination_size": -1073741824,
  • "smart_rollup_challenge_window_in_blocks": -1073741824,
  • "smart_rollup_stake_amount": "string",
  • "smart_rollup_commitment_period_in_blocks": -1073741824,
  • "smart_rollup_max_lookahead_in_blocks": -2147483648,
  • "smart_rollup_max_active_outbox_levels": -2147483648,
  • "smart_rollup_max_outbox_messages_per_level": -1073741824,
  • "smart_rollup_number_of_sections_in_dissection": 255,
  • "smart_rollup_timeout_period_in_blocks": -1073741824,
  • "smart_rollup_max_number_of_cemented_commitments": -1073741824,
  • "smart_rollup_max_number_of_parallel_games": -1073741824,
  • "smart_rollup_reveal_activation_level": {
    },
  • "smart_rollup_private_enable": true,
  • "smart_rollup_riscv_pvm_enable": true,
  • "zk_rollup_enable": true,
  • "zk_rollup_origination_size": -1073741824,
  • "zk_rollup_min_pending_to_process": -1073741824,
  • "zk_rollup_max_ticket_payload_size": -1073741824,
  • "global_limit_of_staking_over_baking": 255,
  • "edge_of_staking_over_delegation": 255,
  • "adaptive_rewards_params": {
    },
  • "direct_ticket_spending_enable": true,
  • "aggregate_attestation": true,
  • "allow_tz4_delegate_enable": true,
  • "all_bakers_attest_activation_level": 2147483647,
  • "issuance_modification_delay": 255,
  • "consensus_key_activation_delay": 255,
  • "unstake_finalization_delay": 255
}

/context/constants/errors

Schema for all the RPC errors from this protocol version

Responses

Response samples

Content type
application/json
null

/context/constants/parametric

Parametric constants

Responses

Response samples

Content type
application/json
{
  • "consensus_rights_delay": 255,
  • "blocks_preservation_cycles": 255,
  • "delegate_parameters_activation_delay": 255,
  • "tolerated_inactivity_period": 255,
  • "blocks_per_cycle": -2147483648,
  • "blocks_per_commitment": -2147483648,
  • "nonce_revelation_threshold": -2147483648,
  • "cycles_per_voting_period": -2147483648,
  • "hard_gas_limit_per_operation": "string",
  • "hard_gas_limit_per_block": "string",
  • "proof_of_work_threshold": "string",
  • "minimal_stake": "string",
  • "minimal_frozen_stake": "string",
  • "vdf_difficulty": "string",
  • "origination_size": -1073741824,
  • "issuance_weights": {
    },
  • "cost_per_byte": "string",
  • "hard_storage_limit_per_operation": "string",
  • "quorum_min": -2147483648,
  • "quorum_max": -2147483648,
  • "min_proposal_quorum": -2147483648,
  • "liquidity_baking_subsidy": "string",
  • "liquidity_baking_toggle_ema_threshold": -2147483648,
  • "max_operations_time_to_live": -32768,
  • "minimal_block_delay": "string",
  • "delay_increment_per_round": "string",
  • "consensus_committee_size": -1073741824,
  • "consensus_threshold_size": -1073741824,
  • "minimal_participation_ratio": {
    },
  • "limit_of_delegation_over_baking": 255,
  • "percentage_of_frozen_deposits_slashed_per_double_baking": 65535,
  • "max_slashing_per_block": 65535,
  • "max_slashing_threshold": {
    },
  • "testnet_dictator": "string",
  • "initial_seed": "string",
  • "cache_script_size": -1073741824,
  • "cache_stake_distribution_cycles": -128,
  • "cache_sampler_state_cycles": -128,
  • "dal_parametric": {
    },
  • "smart_rollup_arith_pvm_enable": true,
  • "smart_rollup_origination_size": -1073741824,
  • "smart_rollup_challenge_window_in_blocks": -1073741824,
  • "smart_rollup_stake_amount": "string",
  • "smart_rollup_commitment_period_in_blocks": -1073741824,
  • "smart_rollup_max_lookahead_in_blocks": -2147483648,
  • "smart_rollup_max_active_outbox_levels": -2147483648,
  • "smart_rollup_max_outbox_messages_per_level": -1073741824,
  • "smart_rollup_number_of_sections_in_dissection": 255,
  • "smart_rollup_timeout_period_in_blocks": -1073741824,
  • "smart_rollup_max_number_of_cemented_commitments": -1073741824,
  • "smart_rollup_max_number_of_parallel_games": -1073741824,
  • "smart_rollup_reveal_activation_level": {
    },
  • "smart_rollup_private_enable": true,
  • "smart_rollup_riscv_pvm_enable": true,
  • "zk_rollup_enable": true,
  • "zk_rollup_origination_size": -1073741824,
  • "zk_rollup_min_pending_to_process": -1073741824,
  • "zk_rollup_max_ticket_payload_size": -1073741824,
  • "global_limit_of_staking_over_baking": 255,
  • "edge_of_staking_over_delegation": 255,
  • "adaptive_rewards_params": {
    },
  • "direct_ticket_spending_enable": true,
  • "aggregate_attestation": true,
  • "allow_tz4_delegate_enable": true,
  • "all_bakers_attest_activation_level": 2147483647
}

/context/contracts

All existing contracts (excluding empty implicit contracts).

Responses

Response samples

Content type
application/json
[
  • "string"
]

/context/contracts/{contract_id}

Access the complete status of a contract.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

query Parameters
normalize_types
string

Whether types should be normalized (annotations removed, combs flattened) or kept as they appeared in the original script.

Responses

Response samples

Content type
application/json
{
  • "balance": "string",
  • "delegate": "string",
  • "script": {
    },
  • "counter": "string",
  • "revealed": true
}

/context/contracts/{contract_id}/all_ticket_balances

Access the complete list of tickets owned by the given contract by scanning the contract's storage.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/contracts/{contract_id}/balance

The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'spendable' RPC.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/balance_and_frozen_bonds

The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'spendable_and_frozen_bonds' RPC.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/big_map_get

Access the value associated with a key in a big map of the contract (deprecated).

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)

Responses

Request samples

Content type
application/json
{
  • "key": {
    },
  • "type": {
    }
}

Response samples

Content type
application/json
{
  • "int": "string"
}

/context/contracts/{contract_id}/counter

Access the counter of a contract, if any.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/delegate

Access the delegate of a contract, if any.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/entrypoints

Return the list of entrypoints of the contract

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

query Parameters
normalize_types
string

Whether types should be normalized (annotations removed, combs flattened) or kept as they appeared in the original script.

Responses

Response samples

Content type
application/json
{
  • "unreachable": [
    ],
  • "entrypoints": {
    }
}

/context/contracts/{contract_id}/entrypoints/{entrypoint}

Return the type of the given entrypoint of the contract

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

entrypoint
required
string

A Michelson entrypoint (string of length < 32)

query Parameters
normalize_types
string

Whether types should be normalized (annotations removed, combs flattened) or kept as they appeared in the original script.

Responses

Response samples

Content type
application/json
Example
{
  • "int": "string"
}

/context/contracts/{contract_id}/estimated_own_pending_slashed_amount

Returns the estimated own pending slashed amount (in mutez) of a given contract.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/frozen_bonds

Access the frozen bonds of a contract.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/full_balance

The full balance (in mutez) of the contract. Includes its spendable balance, staked tez, unstake requests, and frozen bonds. Even if the contract is a delegate, it does not include any staked or delegated tez owned by external delegators.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/manager_key

Access the manager of an implicit contract.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/script

Access the code and data of the contract.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
{
  • "code": null,
  • "storage": null
}

/context/contracts/{contract_id}/script/normalized

Access the script of the contract and normalize it using the requested unparsing mode.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Request Body schema: application/json
required
Readable (string) or Optimized (string) or Optimized_legacy (string)
normalize_types
boolean

Responses

Request samples

Content type
application/json
{
  • "unparsing_mode": "Readable",
  • "normalize_types": true
}

Response samples

Content type
application/json
{
  • "code": null,
  • "storage": null
}

/context/contracts/{contract_id}/single_sapling_get_diff

Returns the root and a diff of a state starting from an optional offset which is zero by default.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

query Parameters
offset_commitment
string

Commitments and ciphertexts are returned from the specified offset up to the most recent.

offset_nullifier
string

Nullifiers are returned from the specified offset up to the most recent.

Responses

Response samples

Content type
application/json
{
  • "root": "string",
  • "commitments_and_ciphertexts": [
    ],
  • "nullifiers": [
    ]
}

/context/contracts/{contract_id}/spendable

The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'balance' RPC.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/spendable_and_frozen_bonds

The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'balance_and_frozen_bonds' RPC.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/staked_balance

Access the staked balance of a contract (in mutez). Returns None if the contract is originated, or neither delegated nor a delegate.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/staking_numerator

Returns an abstract representation of the contract's total_delegated_stake.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/storage

Access the data of the contract.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
Example
{
  • "int": "string"
}

/context/contracts/{contract_id}/storage/normalized

Access the data of the contract and normalize it using the requested unparsing mode.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Request Body schema: application/json
required
Readable (string) or Optimized (string) or Optimized_legacy (string)

Responses

Request samples

Content type
application/json
{
  • "unparsing_mode": "Readable"
}

Response samples

Content type
application/json
{
  • "int": "string"
}

/context/contracts/{contract_id}/storage/paid_space

Access the paid storage space of the contract.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/storage/used_space

Access the used storage space of the contract.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/ticket_balance

Access the contract's balance of ticket with specified ticketer, content type, and content.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Request Body schema: application/json
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash or a base58 originated contract hash.

required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)

Responses

Request samples

Content type
application/json
{
  • "ticketer": "string",
  • "content_type": {
    },
  • "content": {
    }
}

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/unstake_requests

Access the unstake requests of the contract. The requests that appear in the finalizable field can be finalized, which means that the contract can transfer these (no longer frozen) funds to their spendable balance with a [finalize_unstake] operation call. Returns None if there is no unstake request pending.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
{
  • "finalizable": [
    ],
  • "unfinalizable": {
    }
}

/context/contracts/{contract_id}/unstaked_finalizable_balance

Access the balance of a contract that was requested for an unstake operation, and is no longer frozen, which means it will appear in the spendable balance of the contract after any stake/unstake/finalize_unstake operation. Returns None if the contract is originated.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/contracts/{contract_id}/unstaked_frozen_balance

Access the balance of a contract that was requested for an unstake operation, but is still frozen for the duration of the slashing period. Returns None if the contract is originated.

path Parameters
contract_id
required
string

A contract identifier encoded in b58check.

Responses

Response samples

Content type
application/json
"string"

/context/dal/commitments_history

Returns the (currently last) DAL skip list cell if DAL is enabled, or [None] otherwise.

Responses

Response samples

Content type
application/json
{
  • "kind": "dal_skip_list_legacy",
  • "skip_list": "string"
}

/context/dal/published_slot_headers

Get the published slots headers for the given level

query Parameters
level
string

A level integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/dal/shards

Get the shards assignment for a given level (the default is the current level) and given delegates (the default is all delegates)

query Parameters
level
string

A level integer

delegates
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/dal/skip_list_cells_of_level

Returns the cells of the DAL skip list constructed during this targeted block and stored in the context. The cells ordering in the list is not specified (not relevant). The list is expected to be empty if the entry is not initialized in the context (yet), or to have a size that coincides with the number of DAL slots otherwise.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

/context/delegates

Lists all registered delegates by default. The arguments active, inactive, with_minimal_stake, and without_minimal_stake allow to enumerate only the delegates that are active, inactive, have at least a minimal stake to participate in consensus and in governance, or do not have such a minimal stake, respectively. Note, setting these arguments to false has no effect.

query Parameters
active
string
inactive
string
with_minimal_stake
string
without_minimal_stake
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

/context/delegates/{pkh}

Everything about a delegate. Gathers the outputs of all RPCs with the ../delegates/ prefix.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "deactivated": true,
  • "is_forbidden": true,
  • "participation": {
    },
  • "dal_participation": {
    },
  • "grace_period": -2147483648,
  • "active_staking_parameters": {
    },
  • "pending_staking_parameters": [
    ],
  • "baking_power": "string",
  • "total_staked": "string",
  • "total_delegated": "string",
  • "min_delegated_in_current_cycle": {
    },
  • "own_full_balance": "string",
  • "own_staked": "string",
  • "own_delegated": "string",
  • "external_staked": "string",
  • "external_delegated": "string",
  • "total_unstaked_per_cycle": [
    ],
  • "denunciations": [
    ],
  • "estimated_shared_pending_slashed_amount": "string",
  • "staking_denominator": "string",
  • "current_voting_power": "string",
  • "voting_power": "string",
  • "voting_info": {
    },
  • "consensus_key": {
    },
  • "companion_key": {
    },
  • "stakers": [
    ],
  • "delegators": [
    ]
}

/context/delegates/{pkh}/active_staking_parameters

Returns the currently active staking parameters for the given delegate.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "limit_of_staking_over_baking_millionth": -2147483648,
  • "edge_of_baking_over_staking_billionth": -2147483648
}

/context/delegates/{pkh}/baking_power

The current baking power of a delegate, using the current staked and delegated balances of the baker and its delegators. In other words, the baking rights that the baker would get for a future cycle if the current cycle ended right at the current block.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/companion_key

The active companion key (if set) for a given delegate and the pending companion keys.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "active": {
    },
  • "pendings": [
    ]
}

/context/delegates/{pkh}/consensus_key

The active consensus key for a given delegate and the pending consensus keys.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "active": {
    },
  • "pendings": [
    ]
}

/context/delegates/{pkh}/current_baking_power

DEPRECATED; use baking_power instead.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/current_frozen_deposits

DEPRECATED; use total_staked instead.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/current_voting_power

The voting power of a given delegate, as computed from its current stake.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/dal_participation

Returns information about the delegate's participation in the attestation of slots published into the Data Availability Layer (DAL) during the current cycle. The field 'expected_assigned_shards_per_slot' indicates the expected number of shards assigned to the delegate in the cycle per DAL slot. The field 'delegate_attested_dal_slots' represents the number of attested DAL slots which are also attested by the delegate, while 'delegate_attestable_dal_slots' provides the total number of DAL slots attested during the cycle for which the delegate had shards assigned. The 'expected_dal_rewards' field specifies the expected amount of rewards for the delegate based on DAL participation, provided the delegate meets the required participation. Whether this threshold is currently met is determined by the 'sufficient_dal_participation' flag, which is true if currently the delegate has sufficiently participated in attesting DAL slots declared to be attested by the protocol. Note that this flag may evolve during the cycle. Also note, in particular, that if no DAL slots have been globally attested during the cycle (i.e., when 'delegate_attestable_dal_slots' is zero), the flag is true; receipt of the DAL rewards is conditioned however on the receipt of the attestation rewards. The 'denounced' field specifies whether the delegate was denounced for not detecting traps during the current cycle.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "expected_assigned_shards_per_slot": -1073741824,
  • "delegate_attested_dal_slots": -1073741824,
  • "delegate_attestable_dal_slots": -1073741824,
  • "expected_dal_rewards": "string",
  • "sufficient_dal_participation": true,
  • "denounced": true
}

/context/delegates/{pkh}/deactivated

Tells whether the delegate is currently tagged as deactivated or not.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
true

/context/delegates/{pkh}/delegated_balance

DEPRECATED; to get this value, you can call RPCs external_staked and external_delegated, and add their outputs together.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/delegated_contracts

DEPRECATED; use delegators instead.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • "string"
]

/context/delegates/{pkh}/delegators

The list of all contracts that are currently delegating to the delegate. Includes both user accounts and smart contracts. Includes the delegate itself.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • "string"
]

/context/delegates/{pkh}/denunciations

Returns the pending denunciations for the given delegate.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/delegates/{pkh}/estimated_shared_pending_slashed_amount

Returns the estimated shared pending slashed amount (in mutez) of a given delegate.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/external_delegated

The sum (in mutez) of non-staked tokens that currently count as delegated to the baker, excluding those owned by the baker iself. Does not take limits such as overstaking or overdelegation into account. This includes the spendable balances and frozen bonds of all the baker's external delegators. It also includes unstake requests of contracts other than the baker, on the condition that the contract was delegating to the baker at the time of the unstake operation. So this includes most but not all unstake requests from current delegators, and might include some unstake requests from old delegators. Limits such as overstaking and overdelegation have not been applied yet.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/external_staked

The sum (in mutez) of all tokens currently staked by the baker's external delegators. This excludes the baker's own staked tokens.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/frozen_deposits

DEPRECATED; call RPC total_staked on the last block of (current_cycle - 3) instead. Returns the total amount (in mutez) that was staked for the baker by all stakers (including the baker itself) at the time the staking rights for the current cycle were computed.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/frozen_deposits_limit

DEPRECATED; the frozen deposits limit has no effects since the activation of Adaptive Issuance and Staking during the Paris protocol.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/full_balance

DEPRECATED; use own_full_balance instead.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/grace_period

Returns the cycle by the end of which the delegate might be deactivated if she fails to execute any delegate action. A deactivated delegate might be reactivated (without loosing any stake) by simply re-registering as a delegate. For deactivated delegates, this value contains the cycle at which they were deactivated.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
-2147483648

/context/delegates/{pkh}/is_forbidden

Returns true if the delegate is forbidden to participate in consensus.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
true

/context/delegates/{pkh}/min_delegated_in_current_cycle

Returns the minimum of delegated tez (in mutez) during the current cycle and the block level at the end of which the minimum was reached. This only takes into account the value of total_delegated at the end of each block, not in the middle of applying operations. This is the delegated amount that would be used to compute the delegate's future baking rights if the cycle ended at the current block. If the minimum was reached multiple times, the returned level is the earliest level of the current cycle that reached this minimum. For instance, if total_delegated hasn't changed at all since the beginning of the current cycle, returns the first level of the current cycle. (If the contract is not registered as a delegate, returns 0 mutez and omits the level.)

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "amount": "string",
  • "level": {
    }
}

/context/delegates/{pkh}/own_delegated

The amount (in mutez) currently owned by the baker itself and counting as delegated for the purpose of baking rights. This corresponds to all non-staked tokens owned by the baker: spendable balance, frozen bonds, and unstake requests. (Note: There is one exception: if the baker still has unstake requests created at a time when it was delegating to a different delegate, then these unstake requests still count as delegated to the former delegate. Any such unstake requests are excluded from the amount returned by the present RPC, despite being non-staked tokens owned by the baker.)

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/own_full_balance

The full balance (in mutez) of tokens owned by the delegate itself. Includes its spendable balance, staked tez, unstake requests, and frozen bonds. Does not include any tokens owned by external delegators. This RPC fails when the pkh is not a delegate. When it is a delegate, this RPC outputs the same amount as ..//context/contracts//full_balance.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/own_staked

The amount (in mutez) currently owned and staked by the baker itself. Returns the same value as ..//context/contracts//staked_balance (except for the fact that the present RPC fails if the public_key_hash in the path is not a delegate).

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/participation

Returns cycle and level participation information. In particular this indicates, in the field 'expected_cycle_activity', the number of slots the delegate is expected to have in the cycle based on its active stake. The field 'minimal_cycle_activity' indicates the minimal attesting slots in the cycle required to get attesting rewards. It is computed based on 'expected_cycle_activity. The fields 'missed_slots' and 'missed_levels' indicate the number of missed attesting slots and missed levels (for attesting) in the cycle so far. 'missed_slots' indicates the number of missed attesting slots in the cycle so far. The field 'remaining_allowed_missed_slots' indicates the remaining amount of attesting slots that can be missed in the cycle before forfeiting the rewards. Finally, 'expected_attesting_rewards' indicates the attesting rewards that will be distributed at the end of the cycle if activity at that point will be greater than the minimal required; if the activity is already known to be below the required minimum, then the rewards are zero.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "expected_cycle_activity": -1073741824,
  • "minimal_cycle_activity": -1073741824,
  • "missed_slots": -1073741824,
  • "missed_levels": -1073741824,
  • "remaining_allowed_missed_slots": -1073741824,
  • "expected_attesting_rewards": "string"
}

/context/delegates/{pkh}/pending_staking_parameters

Returns the pending values for the given delegate's staking parameters.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/delegates/{pkh}/stakers

Returns the list of accounts that stake to a given delegate together with their share of the frozen deposits.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/delegates/{pkh}/staking_balance

DEPRECATED; to get this value, you can call RPCs total_staked and total_delegated, and add their outputs together.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/staking_denominator

Returns an abstract representation of the total delegated stake.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/total_delegated

All tokens (in mutez) that currently count as delegated for the purpose of computing the baker's rights; they weigh half as much as staked tez in the rights. Limits such as overstaking and overdelegation have not been applied yet. This corresponds to all non-staked tez owned by the baker's delegators (including the baker itself): spendable balances, frozen bonds, and unstaked requests, except for any unstake requests that have been created before the delegator changed its delegate to the current baker (because they still count as delegated for the old delegate instead).

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/total_delegated_stake

DEPRECATED; use external_staked instead.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/total_staked

The total amount (in mutez) currently staked for the baker, both by the baker itself and by external stakers. This is the staked amount before applying the baker's 'limit_of_staking_over_baking'; in other words, it includes overstaked tez if there are any.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/delegates/{pkh}/total_unstaked_per_cycle

For each cycle, returns the total amount (in mutez) contained in all unstake requests created during this cycle by all delegators, including the baker itself. Note that these tokens count as delegated to the baker for the purpose of computing baking rights, and are included in the amount returned by the total_delegated RPC.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/delegates/{pkh}/unstaked_frozen_deposits

DEPRECATED; use total_unstaked_per_cycle instead.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/delegates/{pkh}/voting_info

Returns the delegate info (e.g. voting power) found in the listings of the current voting period.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "voting_power": "string",
  • "current_ballot": "nay",
  • "current_proposals": [
    ],
  • "remaining_proposals": -1073741824
}

/context/delegates/{pkh}/voting_power

The voting power in the vote listings for a given delegate.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/denunciations

Returns the denunciations for misbehavior in the current cycle.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/issuance/current_yearly_rate

Returns the current expected maximum yearly issuance rate (in %). The value only includes participation rewards (and does not include liquidity baking)

Responses

Response samples

Content type
application/json
{
  • "invalid_utf8_string": [
    ]
}

/context/issuance/current_yearly_rate_details

Returns the static and dynamic parts of the current expected maximum yearly issuance rate (in %). The value only includes participation rewards (and does not include liquidity baking)

Responses

Response samples

Content type
application/json
{
  • "static": {
    },
  • "dynamic": {
    }
}

/context/issuance/current_yearly_rate_exact

Returns the current expected maximum yearly issuance rate (exact quotient) (in %). The value only includes participation rewards (and does not include liquidity baking)

Responses

Response samples

Content type
application/json
{
  • "numerator": "string",
  • "denominator": "string"
}

/context/issuance/expected_issuance

Returns the expected issued tez for the provided block and the next 'consensus_rights_delay' cycles (in mutez)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/issuance/issuance_per_minute

Returns the current expected maximum issuance per minute (in mutez). The value only includes participation rewards (and does not include liquidity baking)

Responses

Response samples

Content type
application/json
"string"

/context/liquidity_baking/cpmm_address

Liquidity baking CPMM address

Responses

Response samples

Content type
application/json
"string"

/context/merkle_tree

Returns the merkle tree of a piece of context.

query Parameters
holey
string

Send only hashes, omit data of key

Responses

Response samples

Content type
application/json
[ ]

/context/merkle_tree_v2

Returns the Irmin merkle tree of a piece of context.

query Parameters
holey
string

Send only hashes, omit data of key

Responses

Response samples

Content type
application/json
{
  • "version": -32768,
  • "before": {
    },
  • "after": {
    },
  • "state": {
    }
}

/context/nonces/{block_level}

Info about the nonce of a previous block.

path Parameters
block_level
required
string

A level integer

Responses

Response samples

Content type
application/json
Example
{
  • "nonce": "string"
}

/context/protocol/first_level

Returns the level at which the current protocol was activated.

Responses

Response samples

Content type
application/json
2147483647

/context/raw/bytes

Returns the raw context.

query Parameters
depth
string

Responses

Response samples

Content type
application/json
Example
"string"

/context/sapling/{sapling_state_id}/get_diff

Returns the root and a diff of a state starting from an optional offset which is zero by default.

path Parameters
sapling_state_id
required
string

A sapling state identifier

query Parameters
offset_commitment
string

Commitments and ciphertexts are returned from the specified offset up to the most recent.

offset_nullifier
string

Nullifiers are returned from the specified offset up to the most recent.

Responses

Response samples

Content type
application/json
{
  • "root": "string",
  • "commitments_and_ciphertexts": [
    ],
  • "nullifiers": [
    ]
}

/context/seed

Seed of the cycle to which the block belongs.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"string"

/context/seed_computation

Seed computation status

Responses

Response samples

Content type
application/json
Example
{
  • "nonce_revelation_stage": null
}

/context/smart_rollups/all

List of all originated smart rollups

Responses

Response samples

Content type
application/json
[
  • "string"
]

/context/smart_rollups/all/inbox

Inbox for the smart rollups

Responses

Response samples

Content type
application/json
{
  • "level": 2147483647,
  • "old_levels_messages": {
    }
}

/context/smart_rollups/smart_rollup/{smart_rollup_address}/commitment/{smart_rollup_commitment_hash}

Commitment for a smart rollup from its hash

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

smart_rollup_commitment_hash
required
string

smart_rollup_commitment_hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "compressed_state": "string",
  • "inbox_level": 2147483647,
  • "predecessor": "string",
  • "number_of_ticks": "string"
}

/context/smart_rollups/smart_rollup/{smart_rollup_address}/commitment/{smart_rollup_commitment_hash}/can_be_cemented

Returns true if and only if the provided commitment can be cemented.

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

smart_rollup_commitment_hash
required
string

smart_rollup_commitment_hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
true

/context/smart_rollups/smart_rollup/{smart_rollup_address}/commitment/{smart_rollup_commitment_hash}/stakers_indexes

List of stakers indexes staking on a given commitment

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

smart_rollup_commitment_hash
required
string

smart_rollup_commitment_hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • "string"
]

/context/smart_rollups/smart_rollup/{smart_rollup_address}/consumed_outputs/{block_level}

Return the known consumed outputs of a smart rollup.

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

block_level
required
string

A level integer

Responses

Response samples

Content type
application/json
[
  • -1073741824
]

/context/smart_rollups/smart_rollup/{smart_rollup_address}/genesis_info

Genesis information (level and commitment hash) for a smart rollup

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "level": 2147483647,
  • "commitment_hash": "string"
}

/context/smart_rollups/smart_rollup/{smart_rollup_address}/inbox_level/{block_level}/commitments

List of commitments associated to a rollup for a given inbox level

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

block_level
required
string

A level integer

Responses

Response samples

Content type
application/json
[ ]

/context/smart_rollups/smart_rollup/{smart_rollup_address}/kind

Kind of smart rollup

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"wasm_2_0_0"

/context/smart_rollups/smart_rollup/{smart_rollup_address}/last_cemented_commitment_hash_with_level

Level and hash of the last cemented commitment for a smart rollup

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "hash": "string",
  • "level": 2147483647
}

/context/smart_rollups/smart_rollup/{smart_rollup_address}/last_whitelist_update

Last whitelist update for private smart rollups. If the output is None then the rollup is public.

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "message_index": "string",
  • "outbox_level": 2147483647
}

/context/smart_rollups/smart_rollup/{smart_rollup_address}/staker/{pkh}/conflicts

List of stakers in conflict with the given staker

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/smart_rollups/smart_rollup/{smart_rollup_address}/staker/{pkh}/games

Ongoing refutation games for a given staker

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/context/smart_rollups/smart_rollup/{smart_rollup_address}/staker/{pkh}/index

Staker index associated to a public key hash for a given rollup

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
"string"

/context/smart_rollups/smart_rollup/{smart_rollup_address}/staker/{pkh}/staked_on_commitment

The newest commitment on which the operator has staked on for a smart rollup. Note that is can return a commitment that is before the last cemented one.

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "hash": "string",
  • "compressed_state": "string",
  • "inbox_level": 2147483647,
  • "predecessor": "string",
  • "number_of_ticks": "string"
}

/context/smart_rollups/smart_rollup/{smart_rollup_address}/staker1/{staker1_pkh}/staker2/{staker2_pkh}/timeout

Returns the timeout of players.

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

staker1_pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

staker2_pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "alice": -1073741824,
  • "bob": -1073741824,
  • "last_turn_level": 2147483647
}

/context/smart_rollups/smart_rollup/{smart_rollup_address}/staker1/{staker1_pkh}/staker2/{staker2_pkh}/timeout_reached

Returns whether the timeout creates a result for the game.

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

staker1_pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

staker2_pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
{
  • "kind": "loser",
  • "reason": "conflict_resolved",
  • "player": "string"
}

/context/smart_rollups/smart_rollup/{smart_rollup_address}/stakers

List of active stakers' public key hashes of a rollup

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • "string"
]

/context/smart_rollups/smart_rollup/{smart_rollup_address}/ticket_balance

Access the smart rollup's balance of ticket with specified ticketer, content type, and content.

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

Request Body schema: application/json
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash or a base58 originated contract hash.

required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)

Responses

Request samples

Content type
application/json
{
  • "ticketer": "string",
  • "content_type": {
    },
  • "content": {
    }
}

Response samples

Content type
application/json
"string"

/context/smart_rollups/smart_rollup/{smart_rollup_address}/whitelist

Whitelist for private smart rollups. If the output is None then the rollup is public.

path Parameters
smart_rollup_address
required
string

smart_rollup_address (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[ ]

/context/total_currently_staked

Returns the amount of staked tez by delegates, delegators or overstaked.

Responses

Response samples

Content type
application/json
{
  • "delegates": "string",
  • "delegators": "string",
  • "overstaked": "string"
}

/context/total_frozen_stake

Returns the total stake (in mutez) frozen on the chain

Responses

Response samples

Content type
application/json
"string"

/context/total_supply

Returns the total supply (in mutez) available on the chain

Responses

Response samples

Content type
application/json
"string"

/hash

The block's hash, its unique identifier.

Responses

Response samples

Content type
application/json
"string"

/header

The whole block header.

Responses

Response samples

Content type
application/json
{
  • "protocol": "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im",
  • "chain_id": "string",
  • "hash": "string",
  • "level": -2147483648,
  • "proto": 255,
  • "predecessor": "string",
  • "timestamp": "string",
  • "validation_pass": 255,
  • "operations_hash": "string",
  • "fitness": [
    ],
  • "context": "string",
  • "content": {
    },
  • "signature": "string"
}

/header/protocol_data

The version-specific fragment of the block header.

Responses

Response samples

Content type
application/json
{
  • "protocol": "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im",
  • "content": {
    },
  • "signature": "string"
}

/header/protocol_data/raw

The version-specific fragment of the block header (unparsed).

Responses

Response samples

Content type
application/json
"string"

/header/raw

The whole block header (unparsed).

Responses

Response samples

Content type
application/json
"string"

/header/shell

The shell-specific fragment of the block header.

Responses

Response samples

Content type
application/json
{
  • "level": -2147483648,
  • "proto": 255,
  • "predecessor": "string",
  • "timestamp": "string",
  • "validation_pass": 255,
  • "operations_hash": "string",
  • "fitness": [
    ],
  • "context": "string"
}

/helpers/attestation_rights

Retrieves the delegates allowed to attest a block. By default, it gives the attestation power for delegates that have at least one attestation slot for the next block. Parameters level and cycle can be used to specify the (valid) level(s) in the past or future at which the attestation rights have to be returned. Parameter delegate can be used to restrict the results to the given delegates. Parameter consensus_key can be used to restrict the results to the given consensus_keys. Returns the smallest attestation slots and the attestation power. Also returns the minimal timestamp that corresponds to attestation at the given level. The timestamps are omitted for levels in the past, and are only estimates for levels higher that the next block's, based on the hypothesis that all predecessor blocks were baked at the first round.

query Parameters
level
string

A level integer

cycle
string

A cycle integer

delegate
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

consensus_key
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/helpers/baking_rights

Retrieves the list of delegates allowed to bake a block. By default, it gives the best baking opportunities (in terms of rounds) for bakers that have at least one opportunity below the 64th round for the next block. Parameters level and cycle can be used to specify the (valid) level(s) in the past or future at which the baking rights have to be returned. Parameter delegate can be used to restrict the results to the given delegates. Parameter consensus_key can be used to restrict the results to the given consensus_keys. If parameter all is set, all the baking opportunities for each baker at each level are returned, instead of just the first one. Returns the list of baking opportunities up to round 64. Also returns the minimal timestamps that correspond to these opportunities. The timestamps are omitted for levels in the past, and are only estimates for levels higher that the next block's, based on the hypothesis that all predecessor blocks were baked at the first round.

query Parameters
level
string

A level integer

cycle
string

A cycle integer

delegate
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

consensus_key
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

max_round
string
all
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/helpers/complete/{prefix}

Try to complete a prefix of a Base58Check-encoded data. This RPC is actually able to complete hashes of block, operations, public_keys and contracts.

path Parameters
prefix
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

/helpers/consecutive_round_zero

Returns the number of blocks consecutively baked at round zero.

Responses

Response samples

Content type
application/json
-2147483648

/helpers/current_level

Returns the level of the interrogated block, or the one of a block located offset blocks after it in the chain. For instance, the next block if offset is 1. The offset cannot be negative.

query Parameters
offset
required
string

Responses

Response samples

Content type
application/json
{
  • "level": 2147483647,
  • "level_position": -2147483648,
  • "cycle": -2147483648,
  • "cycle_position": -2147483648,
  • "expected_commitment": true
}

/helpers/forge/bls_consensus_operations

Forge a consensus operation in BLS mode

Request Body schema: application/json
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A block identifier (Base58Check-encoded))
required
Array of Attestation (object) or Attestation_with_dal (object) or Preattestation (object) or Attestations_aggregate (object) or Preattestations_aggregate (object) or Double_consensus_operation_evidence (object) or Seed_nonce_revelation (object) or Vdf_revelation (object) or Double_baking_evidence (object) or Dal_entrapment_evidence (object) or Activate_account (object) or Proposals (object) or Ballot (object) or Reveal (object) or Transaction (object) or Origination (object) or Delegation (object) or Set_deposits_limit (object) or Increase_paid_storage (object) or Update_consensus_key (object) or Update_companion_key (object) or Drain_delegate (object) or Failing_noop (object) or Register_global_constant (object) or Transfer_ticket (object) or Dal_publish_commitment (object) or Smart_rollup_originate (object) or Smart_rollup_add_messages (object) or Smart_rollup_cement (object) or Smart_rollup_publish (object) or Smart_rollup_refute (object) or Smart_rollup_timeout (object) or Smart_rollup_execute_outbox_message (object) or Smart_rollup_recover_bond (object) or Zk_rollup_origination (object) or Zk_rollup_publish (object) or Zk_rollup_update (object) (alpha.operation.alpha.contents)

Responses

Request samples

Content type
application/json
{
  • "branch": "string",
  • "contents": [
    ]
}

Response samples

Content type
application/json
{
  • "sign": "string",
  • "inject": "string"
}

/helpers/forge/operations

Forge an operation

Request Body schema: application/json
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A block identifier (Base58Check-encoded))
required
Array of Attestation (object) or Attestation_with_dal (object) or Preattestation (object) or Attestations_aggregate (object) or Preattestations_aggregate (object) or Double_consensus_operation_evidence (object) or Seed_nonce_revelation (object) or Vdf_revelation (object) or Double_baking_evidence (object) or Dal_entrapment_evidence (object) or Activate_account (object) or Proposals (object) or Ballot (object) or Reveal (object) or Transaction (object) or Origination (object) or Delegation (object) or Set_deposits_limit (object) or Increase_paid_storage (object) or Update_consensus_key (object) or Update_companion_key (object) or Drain_delegate (object) or Failing_noop (object) or Register_global_constant (object) or Transfer_ticket (object) or Dal_publish_commitment (object) or Smart_rollup_originate (object) or Smart_rollup_add_messages (object) or Smart_rollup_cement (object) or Smart_rollup_publish (object) or Smart_rollup_refute (object) or Smart_rollup_timeout (object) or Smart_rollup_execute_outbox_message (object) or Smart_rollup_recover_bond (object) or Zk_rollup_origination (object) or Zk_rollup_publish (object) or Zk_rollup_update (object) (alpha.operation.alpha.contents)

Responses

Request samples

Content type
application/json
{
  • "branch": "string",
  • "contents": [
    ]
}

Response samples

Content type
application/json
"string"

/helpers/forge/protocol_data

Forge the protocol-specific part of a block header

Request Body schema: application/json
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (Hash of a consensus value (Base58Check-encoded))
payload_round
required
integer [ -2147483648 .. 2147483647 ]
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A nonce hash (Base58Check-encoded))
proof_of_work_nonce
string^([a-zA-Z0-9][a-zA-Z0-9])*$
object (alpha.per_block_votes)

Responses

Request samples

Content type
application/json
{
  • "payload_hash": "string",
  • "payload_round": -2147483648,
  • "nonce_hash": "string",
  • "proof_of_work_nonce": "string",
  • "per_block_votes": {
    }
}

Response samples

Content type
application/json
{
  • "protocol_data": "string"
}

/helpers/forge/signed_operations

Forge a signed operation

Request Body schema: application/json
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A block identifier (Base58Check-encoded))
required
Array of Attestation (object) or Attestation_with_dal (object) or Preattestation (object) or Attestations_aggregate (object) or Preattestations_aggregate (object) or Double_consensus_operation_evidence (object) or Seed_nonce_revelation (object) or Vdf_revelation (object) or Double_baking_evidence (object) or Dal_entrapment_evidence (object) or Activate_account (object) or Proposals (object) or Ballot (object) or Reveal (object) or Transaction (object) or Origination (object) or Delegation (object) or Set_deposits_limit (object) or Increase_paid_storage (object) or Update_consensus_key (object) or Update_companion_key (object) or Drain_delegate (object) or Failing_noop (object) or Register_global_constant (object) or Transfer_ticket (object) or Dal_publish_commitment (object) or Smart_rollup_originate (object) or Smart_rollup_add_messages (object) or Smart_rollup_cement (object) or Smart_rollup_publish (object) or Smart_rollup_refute (object) or Smart_rollup_timeout (object) or Smart_rollup_execute_outbox_message (object) or Smart_rollup_recover_bond (object) or Zk_rollup_origination (object) or Zk_rollup_publish (object) or Zk_rollup_update (object) (alpha.operation.alpha.contents)
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Ed25519, Secp256k1, P256 or BLS signature (Base58Check-encoded))

Responses

Request samples

Content type
application/json
{
  • "branch": "string",
  • "contents": [
    ],
  • "signature": "string"
}

Response samples

Content type
application/json
"string"

/helpers/forge_block_header

Forge a block header

Request Body schema: application/json
level
required
integer [ -2147483648 .. 2147483647 ]
proto
required
integer [ 0 .. 255 ]
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A block identifier (Base58Check-encoded))
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (timestamp.protocol)

A timestamp as seen by the protocol: second-level precision, epoch based.

validation_pass
required
integer [ 0 .. 255 ]
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A list of list of operations (Base58Check-encoded))
fitness
required
Array of strings (Block fitness) [ items^([a-zA-Z0-9][a-zA-Z0-9])*$ ]

The fitness, or score, of a block, that allow the Tezos to decide which chain is the best. A fitness value is a list of byte sequences. They are compared as follows: shortest lists are smaller; lists of the same length are compared according to the lexicographical order.

required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A hash of context (Base58Check-encoded))
protocol_data
required
string^([a-zA-Z0-9][a-zA-Z0-9])*$

Responses

Request samples

Content type
application/json
{
  • "level": -2147483648,
  • "proto": 255,
  • "predecessor": "string",
  • "timestamp": "string",
  • "validation_pass": 255,
  • "operations_hash": "string",
  • "fitness": [
    ],
  • "context": "string",
  • "protocol_data": "string"
}

Response samples

Content type
application/json
{
  • "block": "string"
}

/helpers/levels_in_current_cycle

Levels of a cycle

query Parameters
offset
required
string

Responses

Response samples

Content type
application/json
{
  • "first": 2147483647,
  • "last": 2147483647
}

/helpers/parse/block

Parse a block

Request Body schema: application/json
level
required
integer [ -2147483648 .. 2147483647 ]
proto
required
integer [ 0 .. 255 ]
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A block identifier (Base58Check-encoded))
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (timestamp.protocol)

A timestamp as seen by the protocol: second-level precision, epoch based.

validation_pass
required
integer [ 0 .. 255 ]
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A list of list of operations (Base58Check-encoded))
fitness
required
Array of strings (Block fitness) [ items^([a-zA-Z0-9][a-zA-Z0-9])*$ ]

The fitness, or score, of a block, that allow the Tezos to decide which chain is the best. A fitness value is a list of byte sequences. They are compared as follows: shortest lists are smaller; lists of the same length are compared according to the lexicographical order.

required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A hash of context (Base58Check-encoded))
protocol_data
required
string^([a-zA-Z0-9][a-zA-Z0-9])*$

Responses

Request samples

Content type
application/json
{
  • "level": -2147483648,
  • "proto": 255,
  • "predecessor": "string",
  • "timestamp": "string",
  • "validation_pass": 255,
  • "operations_hash": "string",
  • "fitness": [
    ],
  • "context": "string",
  • "protocol_data": "string"
}

Response samples

Content type
application/json
{
  • "payload_hash": "string",
  • "payload_round": -2147483648,
  • "proof_of_work_nonce": "string",
  • "seed_nonce_hash": "string",
  • "liquidity_baking_toggle_vote": "on",
  • "adaptive_issuance_vote": "on",
  • "signature": "string"
}

/helpers/parse/operations

Parse operations

query Parameters
version
string

Supported RPC version is version '1'

Request Body schema: application/json
required
Array of objects or objects or objects (operation)
check_signature
boolean

Responses

Request samples

Content type
application/json
{
  • "operations": [
    ],
  • "check_signature": true
}

Response samples

Content type
application/json
[
  • {
    }
]

/helpers/preapply/block

Simulate the validation of a block that would contain the given operations and return the resulting fitness and context hash.

query Parameters
sort
string
timestamp
string

A date in seconds from epoch

Request Body schema: application/json
required
object
required
Array of objects (next_operation) [ items ]

Responses

Request samples

Content type
application/json
{
  • "protocol_data": {
    },
  • "operations": [
    ]
}

Response samples

Content type
application/json
{
  • "shell_header": {
    },
  • "operations": [
    ]
}

/helpers/preapply/operations

Simulate the application of the operations with the context of the given block and return the result of each operation application.

query Parameters
version
required
string

Supported RPC versions are version "1" (default)

Request Body schema: application/json
Array
protocol
required
string
Value: "ProtoALphaALphaALphaALphaALphaALphaALphaALphaDdp3zK"
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A block identifier (Base58Check-encoded))
required
Array of Attestation (object) or Attestation_with_dal (object) or Preattestation (object) or Attestations_aggregate (object) or Preattestations_aggregate (object) or Double_consensus_operation_evidence (object) or Seed_nonce_revelation (object) or Vdf_revelation (object) or Double_baking_evidence (object) or Dal_entrapment_evidence (object) or Activate_account (object) or Proposals (object) or Ballot (object) or Reveal (object) or Transaction (object) or Origination (object) or Delegation (object) or Set_deposits_limit (object) or Increase_paid_storage (object) or Update_consensus_key (object) or Update_companion_key (object) or Drain_delegate (object) or Failing_noop (object) or Register_global_constant (object) or Transfer_ticket (object) or Dal_publish_commitment (object) or Smart_rollup_originate (object) or Smart_rollup_add_messages (object) or Smart_rollup_cement (object) or Smart_rollup_publish (object) or Smart_rollup_refute (object) or Smart_rollup_timeout (object) or Smart_rollup_execute_outbox_message (object) or Smart_rollup_recover_bond (object) or Zk_rollup_origination (object) or Zk_rollup_publish (object) or Zk_rollup_update (object) (alpha.operation.alpha.contents)
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A Ed25519, Secp256k1, P256 or BLS signature (Base58Check-encoded))

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

/helpers/round

Returns the round of the interrogated block, or the one of a block located offset blocks after in the chain (or before when negative). For instance, the next block if offset is 1.

Responses

Response samples

Content type
application/json
-2147483648

/helpers/scripts/entrypoint

Return the type of the given entrypoint

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
Universal string representation (string) or Universal string representation (object) (Universal string representation)

Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.

Responses

Request samples

Content type
application/json
{
  • "script": {
    },
  • "entrypoint": "string"
}

Response samples

Content type
application/json
{
  • "entrypoint_type": {
    }
}

/helpers/scripts/entrypoints

Return the list of entrypoints of the given script

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)

Responses

Request samples

Content type
application/json
{
  • "script": {
    }
}

Response samples

Content type
application/json
{
  • "unreachable": [
    ],
  • "entrypoints": {
    }
}

/helpers/scripts/normalize_data

Normalizes some data expression using the requested unparsing mode

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Readable (string) or Optimized (string) or Optimized_legacy (string)
legacy
boolean
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "type": {
    },
  • "unparsing_mode": "Readable",
  • "legacy": true,
  • "other_contracts": [
    ],
  • "extra_big_maps": [
    ]
}

Response samples

Content type
application/json
{
  • "normalized": {
    }
}

/helpers/scripts/normalize_script

Normalizes a Michelson script using the requested unparsing mode

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Readable (string) or Optimized (string) or Optimized_legacy (string)

Responses

Request samples

Content type
application/json
{
  • "script": {
    },
  • "unparsing_mode": "Readable"
}

Response samples

Content type
application/json
{
  • "normalized": {
    }
}

/helpers/scripts/normalize_stack

Normalize a Michelson stack using the requested unparsing mode

Request Body schema: application/json
required
Array of objects
required
Readable (string) or Optimized (string) or Optimized_legacy (string)
legacy
boolean
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "input": [
    ],
  • "unparsing_mode": "Readable",
  • "legacy": true,
  • "other_contracts": [
    ],
  • "extra_big_maps": [
    ]
}

Response samples

Content type
application/json
{
  • "output": [
    ]
}

/helpers/scripts/normalize_type

Normalizes some Michelson type by expanding pair a b c as `pair a (pair b c)

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)

Responses

Request samples

Content type
application/json
{
  • "type": {
    }
}

Response samples

Content type
application/json
{
  • "normalized": {
    }
}

/helpers/scripts/pack_data

Computes the serialized version of some data expression using the same algorithm as script instruction PACK

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
gas
string (Big number)

Decimal representation of a big number

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "type": {
    },
  • "gas": "string"
}

Response samples

Content type
application/json
{
  • "packed": "string",
  • "gas": "string"
}

/helpers/scripts/run_code

Run a Michelson script in the current context

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
amount
required
string (Positive big number)

Decimal representation of a positive big number

balance
string (Positive big number)

Decimal representation of a positive big number

required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (Network identifier (Base58Check-encoded))
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash or a base58 originated contract hash.

(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle -- implicit account)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash.

(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle -- originated account)

A contract notation as given to an RPC or inside scripts. Can be a base58 originated contract hash.

Universal string representation (string) or Universal string representation (object) (Universal string representation)

Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.

Readable (string) or Optimized (string) or Optimized_legacy (string)
gas
string (Big number)

Decimal representation of a big number

now
string (Big number)

Decimal representation of a big number

level
string (Positive big number)

Decimal representation of a positive big number

Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "script": {
    },
  • "storage": {
    },
  • "input": {
    },
  • "amount": "string",
  • "balance": "string",
  • "chain_id": "string",
  • "source": "string",
  • "payer": "string",
  • "self": "string",
  • "entrypoint": "string",
  • "unparsing_mode": "Readable",
  • "gas": "string",
  • "now": "string",
  • "level": "string",
  • "other_contracts": [
    ],
  • "extra_big_maps": [
    ]
}

Response samples

Content type
application/json
{
  • "storage": {
    },
  • "operations": [
    ],
  • "lazy_storage_diff": [
    ]
}

/helpers/scripts/run_instruction

Run a single Michelson instruction

Request Body schema: application/json
required
Array of objects
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (Network identifier (Base58Check-encoded))
gas
string (Big number)

Decimal representation of a big number

now
string (Big number)

Decimal representation of a big number

level
string (Positive big number)

Decimal representation of a positive big number

(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash or a base58 originated contract hash.

(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle -- implicit account)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash.

(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle -- originated account)

A contract notation as given to an RPC or inside scripts. Can be a base58 originated contract hash.

Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
amount
required
string (Positive big number)

Decimal representation of a positive big number

balance
string (Positive big number)

Decimal representation of a positive big number

Array of objects
Array of objects
Readable (string) or Optimized (string) or Optimized_legacy (string)
legacy
boolean

Responses

Request samples

Content type
application/json
{
  • "input": [
    ],
  • "code": {
    },
  • "chain_id": "string",
  • "gas": "string",
  • "now": "string",
  • "level": "string",
  • "sender": "string",
  • "source": "string",
  • "self": "string",
  • "parameter": {
    },
  • "amount": "string",
  • "balance": "string",
  • "other_contracts": [
    ],
  • "big_maps": [
    ],
  • "unparsing_mode": "Readable",
  • "legacy": true
}

Response samples

Content type
application/json
{
  • "output": [
    ],
  • "gas": "string"
}

/helpers/scripts/run_operation

Run an operation with the context of the given block and without signature checks. Return the operation application result, including the consumed gas. This RPC does not support consensus operations.

query Parameters
version
string

Supported RPC version is version '1'

Request Body schema: application/json
required
object

An operation's shell header.

required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (Network identifier (Base58Check-encoded))

Responses

Request samples

Content type
application/json
{
  • "operation": {
    },
  • "chain_id": "string"
}

Response samples

Content type
application/json
Example
{
  • "contents": [
    ],
  • "signature": "string"
}

/helpers/scripts/run_script_view

Simulate a call to a michelson view

Request Body schema: application/json
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle -- originated account)

A contract notation as given to an RPC or inside scripts. Can be a base58 originated contract hash.

required
Universal string representation (string) or Universal string representation (object) (Universal string representation)

Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.

required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
unlimited_gas
boolean
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (Network identifier (Base58Check-encoded))
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash or a base58 originated contract hash.

(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle -- implicit account)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash.

gas
string (Big number)

Decimal representation of a big number

required
Readable (string) or Optimized (string) or Optimized_legacy (string)
now
string (Big number)

Decimal representation of a big number

level
string (Positive big number)

Decimal representation of a positive big number

Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "contract": "string",
  • "view": "string",
  • "input": {
    },
  • "unlimited_gas": true,
  • "chain_id": "string",
  • "source": "string",
  • "payer": "string",
  • "gas": "string",
  • "unparsing_mode": "Readable",
  • "now": "string",
  • "level": "string",
  • "other_contracts": [
    ],
  • "extra_big_maps": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/helpers/scripts/run_view

Simulate a call to a view following the TZIP-4 standard. See https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-4/tzip-4.md#view-entrypoints.

Request Body schema: application/json
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle -- originated account)

A contract notation as given to an RPC or inside scripts. Can be a base58 originated contract hash.

required
Universal string representation (string) or Universal string representation (object) (Universal string representation)

Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.

required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (Network identifier (Base58Check-encoded))
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash or a base58 originated contract hash.

(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle -- implicit account)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash.

gas
string (Big number)

Decimal representation of a big number

required
Readable (string) or Optimized (string) or Optimized_legacy (string)
now
string (Big number)

Decimal representation of a big number

level
string (Positive big number)

Decimal representation of a positive big number

Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "contract": "string",
  • "entrypoint": "string",
  • "input": {
    },
  • "chain_id": "string",
  • "source": "string",
  • "payer": "string",
  • "gas": "string",
  • "unparsing_mode": "Readable",
  • "now": "string",
  • "level": "string",
  • "other_contracts": [
    ],
  • "extra_big_maps": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/helpers/scripts/script_size

Compute the size of a script in the current context

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
gas
string (Big number)

Decimal representation of a big number

legacy
boolean

Responses

Request samples

Content type
application/json
{
  • "program": {
    },
  • "storage": {
    },
  • "gas": "string",
  • "legacy": true
}

Response samples

Content type
application/json
{
  • "script_size": -1073741824
}

/helpers/scripts/simulate_operation

Simulate running an operation at some future moment (based on the number of blocks given in the latency argument), and return the operation application result. The result is the same as run_operation except for the consumed gas, which depends on the contents of the cache at that future moment. This RPC estimates future gas consumption by trying to predict the state of the cache using some heuristics.

query Parameters
version
string

Supported RPC version is version '1'

successor_level
string

If true, the simulation is done on the successor level of the current context.

Request Body schema: application/json
blocks_before_activation
integer [ -2147483648 .. 2147483647 ]
required
object

An operation's shell header.

required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (Network identifier (Base58Check-encoded))
latency
integer [ -32768 .. 32767 ]

Responses

Request samples

Content type
application/json
{
  • "blocks_before_activation": -2147483648,
  • "operation": {
    },
  • "chain_id": "string",
  • "latency": -32768
}

Response samples

Content type
application/json
Example
{
  • "contents": [
    ],
  • "signature": "string"
}

/helpers/scripts/trace_code

Run a Michelson script in the current context, keeping a trace

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
amount
required
string (Positive big number)

Decimal representation of a positive big number

balance
string (Positive big number)

Decimal representation of a positive big number

required
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (Network identifier (Base58Check-encoded))
(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash or a base58 originated contract hash.

(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle -- implicit account)

A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash.

(Universal string representation (Universal string representation (string) or Universal string representation (object))) (A contract handle -- originated account)

A contract notation as given to an RPC or inside scripts. Can be a base58 originated contract hash.

Universal string representation (string) or Universal string representation (object) (Universal string representation)

Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.

Readable (string) or Optimized (string) or Optimized_legacy (string)
gas
string (Big number)

Decimal representation of a big number

now
string (Big number)

Decimal representation of a big number

level
string (Positive big number)

Decimal representation of a positive big number

Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "script": {
    },
  • "storage": {
    },
  • "input": {
    },
  • "amount": "string",
  • "balance": "string",
  • "chain_id": "string",
  • "source": "string",
  • "payer": "string",
  • "self": "string",
  • "entrypoint": "string",
  • "unparsing_mode": "Readable",
  • "gas": "string",
  • "now": "string",
  • "level": "string",
  • "other_contracts": [
    ],
  • "extra_big_maps": [
    ]
}

Response samples

Content type
application/json
{
  • "storage": {
    },
  • "operations": [
    ],
  • "trace": [
    ],
  • "lazy_storage_diff": [
    ]
}

/helpers/scripts/typecheck_code

Typecheck a piece of code in the current context

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
gas
string (Big number)

Decimal representation of a big number

legacy
boolean
show_types
boolean

Responses

Request samples

Content type
application/json
{
  • "program": {
    },
  • "gas": "string",
  • "legacy": true,
  • "show_types": true
}

Response samples

Content type
application/json
{
  • "type_map": [
    ],
  • "gas": "string"
}

/helpers/scripts/typecheck_data

Check that some data expression is well formed and of a given type in the current context

Request Body schema: application/json
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
required
Int (object) or String (object) or Bytes (object) or Array of Sequence (any) or Prim__generic (object) (micheline.alpha.michelson_v1.expression)
gas
string (Big number)

Decimal representation of a big number

legacy
boolean

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "type": {
    },
  • "gas": "string",
  • "legacy": true
}

Response samples

Content type
application/json
{
  • "gas": "string"
}

/helpers/total_baking_power

Returns the total baking power for the current cycle

Responses

Response samples

Content type
application/json
"string"

/helpers/validators

Retrieves the level, the attestation slots and the public key hash of each delegate allowed to attest a block. Also returns each delegate's current consensus key, and current companion key when needed for crafting and validating attestations at this level. By default, it provides this information for the next level. Parameter level can be used to specify the (valid) level(s) in the past or future at which the attestation rights have to be returned. Parameter delegate can be used to restrict the results results to the given delegates. Parameter consensus_key can be used to restrict the results to the given consensus_keys.

query Parameters
level
string

A level integer

delegate
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

consensus_key
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/live_blocks

List the ancestors of the given block which, if referred to as the branch in an operation header, are recent enough for that operation to be included in the current block.

Responses

Response samples

Content type
application/json
[
  • "string"
]

/metadata

All the metadata associated to the block.

query Parameters
version
required
string

Supported RPC versions are version "1" (default)

Responses

Response samples

Content type
application/json
{
  • "protocol": "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im",
  • "next_protocol": "ProtoALphaALphaALphaALphaALphaALphaALphaALphaDdp3zK",
  • "test_chain_status": {
    },
  • "max_operations_ttl": -1073741824,
  • "max_operation_data_length": -1073741824,
  • "max_block_header_length": -1073741824,
  • "max_operation_list_length": [
    ],
  • "property1": null,
  • "property2": null
}

/metadata_hash

Hash of the metadata associated to the block. This is only set on blocks starting from environment V1.

Responses

Response samples

Content type
application/json
"string"

/operation_hashes

The hashes of all the operations included in the block.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

/operation_hashes/{list_offset}

All the operations included in n-th validation pass of the block.

path Parameters
list_offset
required
string

Index n of the requested validation pass.

Responses

Response samples

Content type
application/json
[
  • "string"
]

/operation_hashes/{list_offset}/{operation_offset}

The hash of then m-th operation in the n-th validation pass of the block.

path Parameters
list_offset
required
string

Index n of the requested validation pass.

operation_offset
required
string

Index m of the requested operation in its validation pass.

Responses

Response samples

Content type
application/json
"string"

/operation_metadata_hashes

The hashes of all the operation metadata included in the block. This is only set on blocks starting from environment V1.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

/operation_metadata_hashes/{list_offset}

All the operation metadata included in n-th validation pass of the block. This is only set on blocks starting from environment V1.

path Parameters
list_offset
required
string

Index n of the requested validation pass.

Responses

Response samples

Content type
application/json
[
  • "string"
]

/operation_metadata_hashes/{list_offset}/{operation_offset}

The hash of then m-th operation metadata in the n-th validation pass of the block. This is only set on blocks starting from environment V1.

path Parameters
list_offset
required
string

Index n of the requested validation pass.

operation_offset
required
string

Index m of the requested operation in its validation pass.

Responses

Response samples

Content type
application/json
"string"

/operations

All the operations included in the block.

query Parameters
version
required
string

Supported RPC versions are version "1" (default)

force_metadata
string

DEPRECATED: Forces to recompute the operations metadata if it was considered as too large.

metadata
string

defines the way metadata are queried Specifies whether or not if the operations metadata should be returned. To get the metadata, even if it is needed to recompute them, use "always". To avoid getting the metadata, use "never". By default, the metadata will be returned depending on the node's metadata size limit policy.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

/operations/{list_offset}

All the operations included in n-th validation pass of the block.

path Parameters
list_offset
required
string

Index n of the requested validation pass.

query Parameters
version
required
string

Supported RPC versions are version "1" (default)

force_metadata
string

DEPRECATED: Forces to recompute the operations metadata if it was considered as too large.

metadata
string

defines the way metadata are queried Specifies whether or not if the operations metadata should be returned. To get the metadata, even if it is needed to recompute them, use "always". To avoid getting the metadata, use "never". By default, the metadata will be returned depending on the node's metadata size limit policy.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/operations/{list_offset}/{operation_offset}

The m-th operation in the n-th validation pass of the block.

path Parameters
list_offset
required
string

Index n of the requested validation pass.

operation_offset
required
string

Index m of the requested operation in its validation pass.

query Parameters
version
required
string

Supported RPC versions are version "1" (default)

force_metadata
string

DEPRECATED: Forces to recompute the operations metadata if it was considered as too large.

metadata
string

defines the way metadata are queried Specifies whether or not if the operations metadata should be returned. To get the metadata, even if it is needed to recompute them, use "always". To avoid getting the metadata, use "never". By default, the metadata will be returned depending on the node's metadata size limit policy.

Responses

Response samples

Content type
application/json
{
  • "protocol": "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im",
  • "chain_id": "string",
  • "hash": "string",
  • "branch": "string",
  • "property1": null,
  • "property2": null
}

/operations_metadata_hash

The root hash of the operations metadata from the block. This is only set on blocks starting from environment V1.

Responses

Response samples

Content type
application/json
"string"

/protocols

Current and next protocol.

Responses

Response samples

Content type
application/json
{
  • "protocol": "string",
  • "next_protocol": "string"
}

/resulting_context_hash

Context hash resulting of the block application.

Responses

Response samples

Content type
application/json
"string"

/votes/ballot_list

Ballots casted so far during a voting period.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/votes/ballots

Sum of ballots casted so far during a voting period.

Responses

Response samples

Content type
application/json
{
  • "yay": "string",
  • "nay": "string",
  • "pass": "string"
}

/votes/current_period

Returns the voting period (index, kind, starting position) and related information (position, remaining) of the interrogated block.

Responses

Response samples

Content type
application/json
{
  • "voting_period": {
    },
  • "position": -2147483648,
  • "remaining": -2147483648
}

/votes/current_proposal

Current proposal under evaluation.

Responses

Response samples

Content type
application/json
"string"

/votes/current_quorum

Current expected quorum.

Responses

Response samples

Content type
application/json
-2147483648

/votes/listings

List of delegates with their voting power.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/votes/proposal_count/{pkh}

Number of votes casted during the current period.

path Parameters
pkh
required
string

A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)

Responses

Response samples

Content type
application/json
-1073741824

/votes/proposals

List of proposals with number of supporters.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

/votes/successor_period

Returns the voting period (index, kind, starting position) and related information (position, remaining) of the next block.Useful to craft operations that will be valid in the next block.

Responses

Response samples

Content type
application/json
{
  • "voting_period": {
    },
  • "position": -2147483648,
  • "remaining": -2147483648
}

/votes/total_voting_power

Total voting power in the voting listings.

Responses

Response samples

Content type
application/json
"string"