VeChain - REST API

REST API endpoints supported on VeChain Mainnet and VeChain Testnet through Tatum RPC Gateway, with base URLs and an example request.

Call VeChain 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
VeChain Mainnethttps://vechain-mainnet.gateway.tatum.io
VeChain Testnethttps://vechain-testnet.gateway.tatum.io

Example request

curl 'https://vechain-mainnet.gateway.tatum.io/fees/priority' \
  --header 'x-api-key: {YOUR_API_KEY}'

Endpoints

21 endpoints. Parameters and responses are described in the VeChainThor REST API reference.

EndpointDescription
GET /accounts/{address}Returns the balance, energy (VTHO) and code flag of an account.
GET /accounts/{address}/codeReturns the bytecode of a contract.
GET /accounts/{address}/storage/{key}Returns the value at a storage position of a contract.
GET /blocks/{revision}Returns a block by ID, number or label such as best or finalized.
GET /fees/historyReturns historical base fees, gas used ratios and priority fee rewards.
GET /fees/priorityReturns a suggested priority fee for a new transaction.
GET /node/network/peersLists the peers connected to the node.
GET /node/txpoolLists the transactions in the transaction pool.
GET /node/txpool/statusReturns the status of the transaction pool.
GET /transactions/{id}Returns a transaction by ID.
GET /transactions/{id}/receiptReturns the receipt of a transaction.
POST /accounts/{address}Deprecated. Use POST /accounts/* instead.
POST /accounts/*Simulates a batch of clauses to read contract state or estimate gas.
POST /debug/storage-rangeReturns a range of storage entries of a contract.
POST /debug/tracersTraces the execution of a transaction clause.
POST /debug/tracers/callTraces a simulated contract call.
POST /eventsDeprecated. Use POST /logs/event instead.
POST /logs/eventReturns smart contract event logs that match a filter.
POST /logs/transferReturns VET transfer logs that match a filter.
POST /transactionsSubmits a signed raw transaction to the network.
POST /transfersDeprecated. Use POST /logs/transfer instead.

The gateway lists its supported endpoints at runtime:

Endpoint unavailable?

If you need an endpoint we don't support yet, contact support.