Tezos - REST API

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

NetworkBase URL
Tezos Mainnethttps://tezos-mainnet.gateway.tatum.io
Tezos Shadownethttps://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.

EndpointDescription
GET /chains/{chain_id}/blocksLists 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_cycleReturns 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/constantsReturns all protocol constants.
GET /chains/{chain_id}/blocks/{block_id}/context/constants/errorsReturns the schema of all RPC errors of the current protocol.
GET /chains/{chain_id}/blocks/{block_id}/context/constants/parametricReturns the parametric protocol constants.
GET /chains/{chain_id}/blocks/{block_id}/context/contractsLists 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}/balanceReturns the spendable balance of a contract, in mutez.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/balance_and_frozen_bondsReturns the sum of a contract's spendable balance and frozen bonds, in mutez.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/counterReturns the counter of a contract, if any.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/delegateReturns the delegate of a contract, if any.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/entrypointsLists the entrypoints of a contract.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/frozen_bondsReturns the frozen bonds of a contract.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/full_balanceReturns 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_keyReturns the public key of an implicit account's manager.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/scriptReturns the code and storage of a contract.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/staked_balanceReturns the staked balance of a contract, in mutez.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/storageReturns the storage of a contract.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/storage/paid_spaceReturns the paid storage space of a contract.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/storage/staking_numeratorReturns an abstract representation of the contract's delegated stake.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/storage/used_spaceReturns the used storage space of a contract.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/unstake_requestsReturns the pending unstake requests of a contract.
GET /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/unstaked_finalizable_balanceReturns 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_balanceReturns the unstaked balance of a contract that is still frozen.
GET /chains/{chain_id}/blocks/{block_id}/context/dal/shardsReturns 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_parametersReturns the currently active staking parameters of a delegate.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/balanceReturns the full balance of a delegate. Legacy endpoint, not in the current protocol.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/companion_keyReturns the active and pending companion keys of a delegate.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/consensus_keyReturns the active and pending consensus keys of a delegate.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/current_frozen_depositsDeprecated. Use total_staked instead.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/dal_participationReturns the delegate's participation in DAL slot attestation during the current cycle.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/deactivatedReturns whether a delegate is deactivated.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/delegated_balanceDeprecated. Add the outputs of external_staked and external_delegated instead.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/delegated_contractsDeprecated. Use delegators instead.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/frozen_balanceReturns 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_cycleReturns 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_depositsDeprecated. 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_limitDeprecated. The frozen deposits limit has had no effect since the Paris protocol.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/full_balanceDeprecated. Use own_full_balance instead.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/grace_periodReturns the cycle by the end of which an inactive delegate may be deactivated.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/is_forbiddenReturns whether a delegate is forbidden from participating in consensus.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/min_delegated_in_current_cycleReturns the minimum delegated tez of a delegate in the current cycle, with its level.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/participationReturns a delegate's attestation participation in the current cycle.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/pending_staking_parametersReturns the pending staking parameters of a delegate.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/stakersLists the accounts staking with a delegate and their share of the frozen deposits.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/staking_balanceDeprecated. Add the outputs of total_staked and total_delegated instead.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/staking_denominatorReturns an abstract representation of a delegate's total delegated stake.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/total_delegated_stakeDeprecated. Use external_staked instead.
GET /chains/{chain_id}/blocks/{block_id}/context/delegates/{pkh}/voting_infoReturns 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_powerReturns a delegate's voting power in the vote listings.
GET /chains/{chain_id}/blocks/{block_id}/context/issuance/current_yearly_rateReturns the current expected maximum yearly issuance rate, in percent.
GET /chains/{chain_id}/blocks/{block_id}/context/issuance/current_yearly_rate_detailsReturns 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_exactReturns the current expected maximum yearly issuance rate as an exact quotient.
GET /chains/{chain_id}/blocks/{block_id}/context/issuance/expected_issuanceReturns 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_minuteReturns 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/seedReturns the random seed of the cycle the block belongs to.
GET /chains/{chain_id}/blocks/{block_id}/context/seed_computationReturns the status of the seed computation.
GET /chains/{chain_id}/blocks/{block_id}/context/total_currently_stakedReturns the total amount of tez currently staked.
GET /chains/{chain_id}/blocks/{block_id}/context/total_frozen_stakeReturns the total stake frozen on the chain, in mutez.
GET /chains/{chain_id}/blocks/{block_id}/context/total_supplyReturns the total supply of tez on the chain, in mutez.
GET /chains/{chain_id}/blocks/{block_id}/hashReturns the hash of a block.
GET /chains/{chain_id}/blocks/{block_id}/headerReturns the full header of a block.
GET /chains/{chain_id}/blocks/{block_id}/header/protocol_dataReturns the protocol-specific part of a block header.
GET /chains/{chain_id}/blocks/{block_id}/header/protocol_data/rawReturns the protocol-specific part of a block header, unparsed.
GET /chains/{chain_id}/blocks/{block_id}/header/rawReturns the full header of a block, unparsed.
GET /chains/{chain_id}/blocks/{block_id}/header/shellReturns the shell-specific part of a block header.
GET /chains/{chain_id}/blocks/{block_id}/helpers/attestation_rightsLists the delegates allowed to attest a block, with their attestation power.
GET /chains/{chain_id}/blocks/{block_id}/helpers/baking_rightsLists 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_levelReturns 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_cycleReturns the first and last levels of the current cycle.
GET /chains/{chain_id}/blocks/{block_id}/helpers/roundReturns the round of a block, or of a block a given offset away.
GET /chains/{chain_id}/blocks/{block_id}/helpers/total_baking_powerReturns the total baking power for the current cycle.
GET /chains/{chain_id}/blocks/{block_id}/helpers/tz4_staker_number_ratioReturns the ratio of active bakers using a tz4 address.
GET /chains/{chain_id}/blocks/{block_id}/helpers/validatorsLists the delegates allowed to attest at a level, with their slots and consensus keys.
GET /chains/{chain_id}/blocks/{block_id}/live_blocksLists the recent ancestors of a block that operations can use as their branch.
GET /chains/{chain_id}/blocks/{block_id}/metadataReturns all metadata associated with a block.
GET /chains/{chain_id}/blocks/{block_id}/operation_hashesReturns 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}/operationsReturns all operations included in a block.
GET /chains/{chain_id}/blocks/{block_id}/protocolsReturns the current and next protocol of a block.
GET /chains/{chain_id}/blocks/{block_id}/votes/ballot_listLists the ballots cast so far in the current voting period.
GET /chains/{chain_id}/blocks/{block_id}/votes/ballotsReturns the sum of ballots cast so far in the current voting period.
GET /chains/{chain_id}/blocks/{block_id}/votes/current_periodReturns the voting period of a block and its position in it.
GET /chains/{chain_id}/blocks/{block_id}/votes/current_proposalReturns the proposal currently under evaluation.
GET /chains/{chain_id}/blocks/{block_id}/votes/current_quorumReturns the current expected quorum.
GET /chains/{chain_id}/blocks/{block_id}/votes/listingsLists delegates with their voting power.
GET /chains/{chain_id}/blocks/{block_id}/votes/proposalsLists proposals with their number of supporters.
GET /chains/{chain_id}/blocks/{block_id}/votes/successor_periodReturns the voting period of the next block and its position in it.
GET /chains/{chain_id}/blocks/{block_id}/votes/total_voting_powerReturns the total voting power in the voting listings.
GET /chains/{chain_id}/chain_idReturns the unique identifier of a chain.
GET /chains/{chain_id}/invalid_blocksLists blocks declared invalid, with the errors that caused it.
GET /chains/{chain_id}/is_bootstrappedReturns the bootstrap status of a chain.
GET /chains/{chain_id}/levels/cabooseReturns the current caboose of a chain.
GET /chains/{chain_id}/levels/checkpointReturns the current checkpoint of a chain.
GET /chains/{chain_id}/levels/savepointReturns the current savepoint of a chain.
GET /chains/{chain_id}/mempool/filterReturns the mempool filter configuration.
GET /chains/{chain_id}/mempool/pending_operationsLists the operations in the mempool, grouped by validation status.
GET /chains/main/chain_idReturns the chain ID of the main chain.
GET /configReturns the node's runtime configuration.
GET /config/history_modeReturns the history mode of the node's storage.
GET /config/network/dalReturns the node's DAL configuration.
GET /errorsReturns the schema of all RPC errors of the shell.
GET /fetch_protocol/{protocol_hash}Fetches a protocol from the network.
GET /protocolsLists the protocols supported by the node.
GET /protocols/{protocol_hash}Returns the interface of a protocol, grouped by module.
GET /versionReturns the version of the node.
GET /versionsReturns version information of the node.
POST /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/all_ticket_balancesLists all tickets owned by a contract.
POST /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/big_map_getDeprecated. Use the context/big_maps/{id}/{key_hash} endpoint instead.
POST /chains/{chain_id}/blocks/{block_id}/context/contracts/{contract_id}/ticket_balanceReturns 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_headerForges a block header.
POST /chains/{chain_id}/blocks/{block_id}/helpers/forge/consensus_operationsForges a consensus operation.
POST /chains/{chain_id}/blocks/{block_id}/helpers/forge/operationsForges an operation.
POST /chains/{chain_id}/blocks/{block_id}/helpers/forge/signed_operationsForges a signed operation.
POST /chains/{chain_id}/blocks/{block_id}/helpers/parse/operationsParses operations.
POST /chains/{chain_id}/blocks/{block_id}/helpers/preapply/blockSimulates validating a block with the given operations and returns its fitness and context hash.
POST /chains/{chain_id}/blocks/{block_id}/helpers/preapply/operationsSimulates the application of operations in the context of a block and returns the results.
POST /chains/{chain_id}/blocks/{block_id}/helpers/scripts/event_addressComputes the address of a contract event from its type.
POST /chains/{chain_id}/blocks/{block_id}/helpers/scripts/run_operationRuns an operation without signature checks and returns the result, including consumed gas.
POST /chains/{chain_id}/blocks/{block_id}/helpers/scripts/simulate_operationSimulates an operation at a future block and returns the result, including estimated gas.
POST /chains/{chain_id}/mempool/filterSets the mempool filter configuration.
POST /injection/operationInjects 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.