REST API endpoints supported on Tezos Mainnet and Tezos Shadownet through Tatum RPC Gateway, with base URLs and an example request.
Call Tezos REST endpoints through Tatum RPC Gateway. Append the endpoint path to the network's base URL and send your API key in the x-api-key header. See Authentication.
Base URLs
| Network | Base URL |
|---|---|
| Tezos Mainnet | https://tezos-mainnet.gateway.tatum.io |
| Tezos Shadownet | https://tezos-shadownet.gateway.tatum.io |
Example request
curl 'https://tezos-mainnet.gateway.tatum.io/chains/main/chain_id' \
--header 'x-api-key: {YOUR_API_KEY}'Endpoints
129 endpoints. Parameters and responses are described in the Octez RPC reference; linked method names go to their page there.
| Endpoint | Description |
|---|---|
GET /chains/{chain_id}/blocks | Lists block hashes, starting from the head, sorted by decreasing fitness. |
GET /chains/{chain_id}/blocks/{block_id} | Returns all information about a block, including its header, metadata and operations. |
GET /chains/{chain_id}/blocks/{block_id}/context/adaptive_issuance_launch_cycle | Returns the cycle at which Adaptive Issuance launches, or null if not yet set. |
GET /chains/{chain_id}/blocks/{block_id}/context/big_maps/{id} | Lists the values in a big map, with optional pagination. |
GET /chains/{chain_id}/blocks/{block_id}/context/big_maps/{id}/{key_hash} | Returns the value for a key in a big map. |
GET /chains/{chain_id}/blocks/{block_id}/context/constants | Returns all protocol constants. |
GET /chains/{chain_id}/blocks/{block_id}/context/constants/errors | Returns the schema of all RPC errors of the current protocol. |
GET /chains/{chain_id}/blocks/{block_id}/context/constants/parametric | Returns the parametric protocol constants. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts | Lists all existing contracts, excluding empty implicit accounts. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id} | Returns the complete status of a contract. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/balance | Returns the spendable balance of a contract, in mutez. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/balance_and_frozen_bonds | Returns the sum of a contract's spendable balance and frozen bonds, in mutez. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/counter | Returns the counter of a contract, if any. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/delegate | Returns the delegate of a contract, if any. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/entrypoints | Lists the entrypoints of a contract. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/frozen_bonds | Returns the frozen bonds of a contract. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/full_balance | Returns the full balance of a contract in mutez, including staked and frozen funds. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/manager_key | Returns the public key of an implicit account's manager. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/script | Returns the code and storage of a contract. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/staked_balance | Returns the staked balance of a contract, in mutez. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/storage | Returns the storage of a contract. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/storage/paid_space | Returns the paid storage space of a contract. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/storage/staking_numerator | Returns an abstract representation of the contract's delegated stake. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/storage/used_space | Returns the used storage space of a contract. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/unstake_requests | Returns the pending unstake requests of a contract. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/unstaked_finalizable_balance | Returns the unstaked balance of a contract that is no longer frozen and can be finalized. |
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/unstaked_frozen_balance | Returns the unstaked balance of a contract that is still frozen. |
GET /chains/{chain_id}/blocks/{block_id}/context/dal/shards | Returns the DAL shard assignment for a level and delegates. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh} | Returns all information about a delegate. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/active_staking_parameters | Returns the currently active staking parameters of a delegate. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/balance | Returns the full balance of a delegate. Legacy endpoint, not in the current protocol. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/companion_key | Returns the active and pending companion keys of a delegate. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/consensus_key | Returns the active and pending consensus keys of a delegate. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/current_frozen_deposits | Deprecated. Use total_staked instead. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/dal_participation | Returns the delegate's participation in DAL slot attestation during the current cycle. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/deactivated | Returns whether a delegate is deactivated. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/delegated_balance | Deprecated. Add the outputs of external_staked and external_delegated instead. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/delegated_contracts | Deprecated. Use delegators instead. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/frozen_balance | Returns the frozen balance of a delegate. Legacy endpoint, not in the current protocol. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/frozen_balance_by_cycle | Returns the frozen balances of a delegate per cycle. Legacy endpoint, not in the current protocol. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/frozen_deposits | Deprecated. Call total_staked on the last block of cycle current_cycle - 3 instead. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/frozen_deposits_limit | Deprecated. The frozen deposits limit has had no effect since the Paris protocol. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/full_balance | Deprecated. Use own_full_balance instead. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/grace_period | Returns the cycle by the end of which an inactive delegate may be deactivated. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/is_forbidden | Returns whether a delegate is forbidden from participating in consensus. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/min_delegated_in_current_cycle | Returns the minimum delegated tez of a delegate in the current cycle, with its level. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/participation | Returns a delegate's attestation participation in the current cycle. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/pending_staking_parameters | Returns the pending staking parameters of a delegate. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/stakers | Lists the accounts staking with a delegate and their share of the frozen deposits. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/staking_balance | Deprecated. Add the outputs of total_staked and total_delegated instead. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/staking_denominator | Returns an abstract representation of a delegate's total delegated stake. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/total_delegated_stake | Deprecated. Use external_staked instead. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/voting_info | Returns a delegate's voting info, such as voting power, for the current voting period. |
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/voting_power | Returns a delegate's voting power in the vote listings. |
GET /chains/{chain_id}/blocks/{block_id}/context/issuance/current_yearly_rate | Returns the current expected maximum yearly issuance rate, in percent. |
GET /chains/{chain_id}/blocks/{block_id}/context/issuance/current_yearly_rate_details | Returns the static and dynamic parts of the current expected maximum yearly issuance rate. |
GET /chains/{chain_id}/blocks/{block_id}/context/issuance/current_yearly_rate_exact | Returns the current expected maximum yearly issuance rate as an exact quotient. |
GET /chains/{chain_id}/blocks/{block_id}/context/issuance/expected_issuance | Returns the expected issuance for the block and the next consensus_rights_delay cycles, in mutez. |
GET /chains/{chain_id}/blocks/{block_id}/context/issuance/issuance_per_minute | Returns the current expected maximum issuance per minute, in mutez. |
GET /chains/{chain_id}/blocks/{block_id}/context/nonces/{block_level} | Returns information about the seed nonce of a previous block. |
GET /chains/{chain_id}/blocks/{block_id}/context/seed | Returns the random seed of the cycle the block belongs to. |
GET /chains/{chain_id}/blocks/{block_id}/context/seed_computation | Returns the status of the seed computation. |
GET /chains/{chain_id}/blocks/{block_id}/context/total_currently_staked | Returns the total amount of tez currently staked. |
GET /chains/{chain_id}/blocks/{block_id}/context/total_frozen_stake | Returns the total stake frozen on the chain, in mutez. |
GET /chains/{chain_id}/blocks/{block_id}/context/total_supply | Returns the total supply of tez on the chain, in mutez. |
GET /chains/{chain_id}/blocks/{block_id}/hash | Returns the hash of a block. |
GET /chains/{chain_id}/blocks/{block_id}/header | Returns the full header of a block. |
GET /chains/{chain_id}/blocks/{block_id}/header/protocol_data | Returns the protocol-specific part of a block header. |
GET /chains/{chain_id}/blocks/{block_id}/header/protocol_data/raw | Returns the protocol-specific part of a block header, unparsed. |
GET /chains/{chain_id}/blocks/{block_id}/header/raw | Returns the full header of a block, unparsed. |
GET /chains/{chain_id}/blocks/{block_id}/header/shell | Returns the shell-specific part of a block header. |
GET /chains/{chain_id}/blocks/{block_id}/helpers/attestation_rights | Lists the delegates allowed to attest a block, with their attestation power. |
GET /chains/{chain_id}/blocks/{block_id}/helpers/baking_rights | Lists the delegates allowed to bake a block, by round. |
GET /chains/{chain_id}/blocks/{block_id}/helpers/complete/{prefix} | Completes a prefix of a Base58Check-encoded hash, key or address. |
GET /chains/{chain_id}/blocks/{block_id}/helpers/current_level | Returns the level of a block, or of a block a given offset after it. |
GET /chains/{chain_id}/blocks/{block_id}/helpers/levels_in_current_cycle | Returns the first and last levels of the current cycle. |
GET /chains/{chain_id}/blocks/{block_id}/helpers/round | Returns the round of a block, or of a block a given offset away. |
GET /chains/{chain_id}/blocks/{block_id}/helpers/total_baking_power | Returns the total baking power for the current cycle. |
GET /chains/{chain_id}/blocks/{block_id}/helpers/tz4_staker_number_ratio | Returns the ratio of active bakers using a tz4 address. |
GET /chains/{chain_id}/blocks/{block_id}/helpers/validators | Lists the delegates allowed to attest at a level, with their slots and consensus keys. |
GET /chains/{chain_id}/blocks/{block_id}/live_blocks | Lists the recent ancestors of a block that operations can use as their branch. |
GET /chains/{chain_id}/blocks/{block_id}/metadata | Returns all metadata associated with a block. |
GET /chains/{chain_id}/blocks/{block_id}/operation_hashes | Returns the hashes of all operations in a block. |
GET /chains/{chain_id}/blocks/{block_id}/operation_hashes/{validation_pass} | Returns the hashes of the operations in a validation pass of a block. |
GET /chains/{chain_id}/blocks/{block_id}/operation_hashes/{validation_pass}/{operation_offset} | Returns the hash of an operation by its validation pass and offset in a block. |
GET /chains/{chain_id}/blocks/{block_id}/operations | Returns all operations included in a block. |
GET /chains/{chain_id}/blocks/{block_id}/protocols | Returns the current and next protocol of a block. |
GET /chains/{chain_id}/blocks/{block_id}/votes/ballot_list | Lists the ballots cast so far in the current voting period. |
GET /chains/{chain_id}/blocks/{block_id}/votes/ballots | Returns the sum of ballots cast so far in the current voting period. |
GET /chains/{chain_id}/blocks/{block_id}/votes/current_period | Returns the voting period of a block and its position in it. |
GET /chains/{chain_id}/blocks/{block_id}/votes/current_proposal | Returns the proposal currently under evaluation. |
GET /chains/{chain_id}/blocks/{block_id}/votes/current_quorum | Returns the current expected quorum. |
GET /chains/{chain_id}/blocks/{block_id}/votes/listings | Lists delegates with their voting power. |
GET /chains/{chain_id}/blocks/{block_id}/votes/proposals | Lists proposals with their number of supporters. |
GET /chains/{chain_id}/blocks/{block_id}/votes/successor_period | Returns the voting period of the next block and its position in it. |
GET /chains/{chain_id}/blocks/{block_id}/votes/total_voting_power | Returns the total voting power in the voting listings. |
GET /chains/{chain_id}/chain_id | Returns the unique identifier of a chain. |
GET /chains/{chain_id}/invalid_blocks | Lists blocks declared invalid, with the errors that caused it. |
GET /chains/{chain_id}/is_bootstrapped | Returns the bootstrap status of a chain. |
GET /chains/{chain_id}/levels/caboose | Returns the current caboose of a chain. |
GET /chains/{chain_id}/levels/checkpoint | Returns the current checkpoint of a chain. |
GET /chains/{chain_id}/levels/savepoint | Returns the current savepoint of a chain. |
GET /chains/{chain_id}/mempool/filter | Returns the mempool filter configuration. |
GET /chains/{chain_id}/mempool/pending_operations | Lists the operations in the mempool, grouped by validation status. |
GET /chains/main/chain_id | Returns the chain ID of the main chain. |
GET /config | Returns the node's runtime configuration. |
GET /config/history_mode | Returns the history mode of the node's storage. |
GET /config/network/dal | Returns the node's DAL configuration. |
GET /errors | Returns the schema of all RPC errors of the shell. |
GET /fetch_protocol/{protocol_hash} | Fetches a protocol from the network. |
GET /protocols | Lists the protocols supported by the node. |
GET /protocols/{protocol_hash} | Returns the interface of a protocol, grouped by module. |
GET /version | Returns the version of the node. |
GET /versions | Returns version information of the node. |
POST /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/all_ticket_balances | Lists all tickets owned by a contract. |
POST /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/big_map_get | Deprecated. Use the context/big_maps/{id}/{key_hash} endpoint instead. |
POST /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/ticket_balance | Returns a contract's balance of a ticket with a given ticketer, content type and content. |
POST /chains/{chain_id}/blocks/{block_id}/helpers/forge_block_header | Forges a block header. |
POST /chains/{chain_id}/blocks/{block_id}/helpers/forge/consensus_operations | Forges a consensus operation. |
POST /chains/{chain_id}/blocks/{block_id}/helpers/forge/operations | Forges an operation. |
POST /chains/{chain_id}/blocks/{block_id}/helpers/forge/signed_operations | Forges a signed operation. |
POST /chains/{chain_id}/blocks/{block_id}/helpers/parse/operations | Parses operations. |
POST /chains/{chain_id}/blocks/{block_id}/helpers/preapply/block | Simulates validating a block with the given operations and returns its fitness and context hash. |
POST /chains/{chain_id}/blocks/{block_id}/helpers/preapply/operations | Simulates the application of operations in the context of a block and returns the results. |
POST /chains/{chain_id}/blocks/{block_id}/helpers/scripts/event_address | Computes the address of a contract event from its type. |
POST /chains/{chain_id}/blocks/{block_id}/helpers/scripts/run_operation | Runs an operation without signature checks and returns the result, including consumed gas. |
POST /chains/{chain_id}/blocks/{block_id}/helpers/scripts/simulate_operation | Simulates an operation at a future block and returns the result, including estimated gas. |
POST /chains/{chain_id}/mempool/filter | Sets the mempool filter configuration. |
POST /injection/operation | Injects a signed operation into the node and broadcasts it. |
The gateway lists its supported endpoints at runtime:
Endpoint unavailable?If you need an endpoint we don't support yet, contact support.