triangle-exclamation Couldn't generate the PDF for 1308 pages, generation stopped at 100.
1 of 100
Node API The ultimate solution for your web3 infrastructure needs.
Welcome to the Future of Crypto Node Infrastructure
Enterprises and experienced developers seeking a robust and powerful solution for their web3 needs, look no further. Validation Cloud's Node API is the answer to all your crypto node infrastructure requirements.
Our cutting-edge platform offers:
A comprehensive suite of API endpoints, meticulously categorized by crypto network, to ensure seamless integration and interoperability across the web3 ecosystem.
Exceptional performance and reliability for your business-critical applications.
Globally resilient infrastructure network employs state-of-the-art Smart Routing technology, which intelligently directs your requests to the closest set of nodes, guaranteeing lightning-fast response times and minimal latency.
Extensive API Suite & Archive Access
Our diverse collection of API endpoints caters to a wide range of crypto networks, simplifying your workflow and enabling you to harness the full potential of web3. Depending on the blockchain, we aim to support debug and other advanced methods to aid developers.
We aim to provide archive/full history access on each blockchain we support. You will be able to see on the Overview page of each chain if archive access is currently available.
If there is a particular blockchain you are interested in where archive/full history doesn't seem to be available, let us know as we may not have rolled it out to the entire platform yet.
Our Node API's Smart Routing technology ensures optimal performance by selecting the nearest nodes, providing unmatched speed and reliability for your web3 applications.
Enterprise-Grade Security
Validation Cloud adheres to strict security standards, safeguarding your infrastructure and sensitive data while maintaining maximum uptime.
Scalability and Flexibility
Our Node API infrastructure is designed to scale effortlessly with your growing needs, offering unmatched versatility to support your business’s dynamic web3 demands.
Rate Limits - as much as we can, outside of DDoS protections, we try not to rate limit RPC or API requests through Node API.
If we notice very high amounts of requests from your account, we may contact you to understand what you are trying to do so we can provide the best solution.
Where a particular method or endpoint has a rate limit or request per second (rps) limit, that will be specified on the page.
24/7 Availability
Our dedicated team of experts is available around the clock to assist you with any technical concerns or queries, ensuring a seamless experience with our infrastructure.
As you explore the limitless possibilities of Validation Cloud's crypto node service, we invite you to familiarize yourself with our competitive and flexible billing options, designed to accommodate businesses of all sizes. In the next section, you’ll find all the information you need to choose the perfect plan for your organization’s unique requirements.
Let’s revolutionize the world of decentralized applications together.
Submit Transaction This endpoint accepts transaction submissions in two formats.
This method will use 350 Compute Units .
eth_gasPrice Returns the current price per gas in wei.
This method will use 40 Compute Units .
None
String - hex string value representing an integer of the current price per gas in WEI.
eth_getUncleCountByBlockNumber Returns the number of uncles in a block from a block matching the given block hash.
This method will use 40 Compute Units .
QUANTITY|TAG - integer of a block number, or the string "latest", "earliest" or "pending", see the
QUANTITY - integer of the number of uncles in this block.
eth_gasPrice Returns the current price per gas in wei.
This method will use 20 Compute Units .
None
String - hex string value representing an integer of the current price per gas in WEI.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X POST \
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_gasPrice","params":[],"id":73} '
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X POST \
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_gasPrice","params":[],"id":73} '
Copy curl https://mainnet.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
-X POST \
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_gasPrice","params":[],"id":73} '
Copy curl https://fuji.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
-X POST \
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_gasPrice","params":[],"id":73} '
Copy //Result
{
"jsonrpc":"2.0",
"id":73,
"result":"0xffc1dc"//16761308 wei
}
Copy params: [
"0xe8", // 232
]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockNumber","params":["0xe8"],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockNumber","params":["0xe8"],"id":1}'
Copy //Result
{
"jsonrpc":"2.0",
"id":73,
"result":"0xffc1dc" //16761308 wei
} Submit transaction
post
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /transactions This endpoint accepts transaction submissions in two formats.
To submit a transaction as JSON, you must submit a SubmitTransactionRequest.
To build this request, do the following:
Encode the transaction as BCS. If you are using a language that has
native BCS support, make sure of that library. If not, you may take
advantage of /transactions/encode_submission. When using this
endpoint, make sure you trust the node you're talking to, as it is
possible they could manipulate your request.
Sign the encoded transaction and use it to create a TransactionSignature.
Submit the request. Make sure to use the "application/json" Content-Type.
To submit a transaction as BCS, you must submit a SignedTransaction
encoded as BCS. See SignedTransaction in types/src/transaction/mod.rs.
Make sure to use the application/x.aptos.signed_transaction+bcs Content-Type.
Body
application/json chevron-down application/json application/x.aptos.signed_transaction+bcs
A request to submit a transaction
This requires a transaction and a signature of it
sender string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 sequence_number string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 max_gas_amount string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 gas_unit_price string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 expiration_timestamp_secs string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 payload one of Required An enum of the possible transaction payloads
object Optional Payload which runs a single entry function
Hide properties plus
type Discriminator string Required Example: entry_function_payload
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
or object Optional Payload which runs a script that can run multiple functions
Hide properties plus
type Discriminator string Required Example: script_payload
Hide properties plus
bytecode string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Hide properties plus
visibility string · enum Required Possible values: privatepublicfriend is_entry boolean Required Whether the function can be called as an entry function directly in a transaction
generic_type_params object[] Required Generic type params associated with the Move function
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the function that uses it
params string[] Required Parameters associated with the move function
return string[] Required Return type of the function
type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
or object Optional
Hide properties plus
type Discriminator string Required Example: module_bundle_payload
modules object[] Required Move module bytecode along with it's ABI
Hide properties plus
bytecode string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Hide properties plus
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 friends string[] Required Example: 0x1::aptos_coin exposed_functions object[] Required Public functions of the module
Hide properties plus
visibility string · enum Required Possible values: privatepublicfriend is_entry boolean Required Whether the function can be called as an entry function directly in a transaction
generic_type_params object[] Required Generic type params associated with the Move function
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the function that uses it
params string[] Required Parameters associated with the move function
return string[] Required Return type of the function
Hide properties plus
is_native boolean Required Whether the struct is a native struct of Move
abilities string[] Required Abilities associated with the struct
generic_type_params object[] Required Generic types associated with the struct
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the type that uses it
fields object[] Required Fields associated with the struct
Hide properties plus
type string Required String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Pattern: ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$ or object Optional A multisig transaction that allows an owner of a multisig account to execute a pre-approved
transaction as the multisig account.
Hide properties plus
type Discriminator string Required Example: multisig_payload
multisig_address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 transaction_payload any of Optional
object Optional Payload which runs a single entry function
Hide properties plus
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
signature one of Required An enum representing the different transaction signatures available
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional Multi agent signature for multi agent transactions
This allows you to have transactions across multiple accounts
Hide properties plus
type Discriminator string Required Example: multi_agent_signature
sender one of Required Account signature scheme
The account signature scheme allows you to have two types of accounts:
A single Ed25519 key account, one private key
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 secondary_signer_addresses string · hex[] Required The other involved parties' addresses
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 secondary_signers one of[] Required The associated signatures, in the same order as the secondary addresses
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Required Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Required Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Required Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Required Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Required Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Required Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Required Oldest non-pruned block height of the chain
X-APTOS-CURSOR string Optional Cursor to be used for endpoints that support cursor-based
pagination. Pass this to the start field of the endpoint
on the next call to get the next page of results.
Response object A transaction waiting in mempool
Hide properties plus
sender string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 sequence_number string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 max_gas_amount string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 gas_unit_price string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 expiration_timestamp_secs string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 payload one of Required An enum of the possible transaction payloads
object Optional Payload which runs a single entry function
Hide properties plus
type Discriminator string Required Example: entry_function_payload
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
or object Optional Payload which runs a script that can run multiple functions
Hide properties plus
type Discriminator string Required Example: script_payload
Hide properties plus
bytecode string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Hide properties plus
visibility string · enum Required Possible values: privatepublicfriend is_entry boolean Required Whether the function can be called as an entry function directly in a transaction
generic_type_params object[] Required Generic type params associated with the Move function
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the function that uses it
params string[] Required Parameters associated with the move function
return string[] Required Return type of the function
type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
or object Optional
Hide properties plus
type Discriminator string Required Example: module_bundle_payload
modules object[] Required Move module bytecode along with it's ABI
Hide properties plus
bytecode string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Hide properties plus
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 friends string[] Required Example: 0x1::aptos_coin exposed_functions object[] Required Public functions of the module
Hide properties plus
visibility string · enum Required Possible values: privatepublicfriend is_entry boolean Required Whether the function can be called as an entry function directly in a transaction
generic_type_params object[] Required Generic type params associated with the Move function
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the function that uses it
params string[] Required Parameters associated with the move function
return string[] Required Return type of the function
Hide properties plus
is_native boolean Required Whether the struct is a native struct of Move
abilities string[] Required Abilities associated with the struct
generic_type_params object[] Required Generic types associated with the struct
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the type that uses it
fields object[] Required Fields associated with the struct
Hide properties plus
type string Required String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Pattern: ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$ or object Optional A multisig transaction that allows an owner of a multisig account to execute a pre-approved
transaction as the multisig account.
Hide properties plus
type Discriminator string Required Example: multisig_payload
multisig_address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 transaction_payload any of Optional
object Optional Payload which runs a single entry function
Hide properties plus
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
signature one of Optional An enum representing the different transaction signatures available
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional Multi agent signature for multi agent transactions
This allows you to have transactions across multiple accounts
Hide properties plus
type Discriminator string Required Example: multi_agent_signature
sender one of Required Account signature scheme
The account signature scheme allows you to have two types of accounts:
A single Ed25519 key account, one private key
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 secondary_signer_addresses string · hex[] Required The other involved parties' addresses
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 secondary_signers one of[] Required The associated signatures, in the same order as the secondary addresses
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Copy POST /v1/<YOUR_API_KEY_HERE>/v1/transactions HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Content-Type: application/json
Accept: */*
Content-Length: 546
{
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
}
Copy {
"hash": "text",
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
} Billing Welcome to Node API's Billing Page
At Validation Cloud, we understand that every business has unique needs and financial constraints. That’s why we’ve designed our billing system to be as flexible and accommodating as possible, catering to enterprises and experienced developers entering the web3 space.
Our pricing model is structured around three plans: The Free Plan and Scale Plan, charged based on a Compute Unit (CU) system. We also have the Private Plan which has custom pricing based on your traffic profile and offers access to more blockchains.
Get started with our Node API without any upfront costs or commitment. Simply sign up for free—no credit card required—and gain immediate access to our enterprise-grade nodes with no performance limitations until you've reached your 50 million-th compute unit. Enjoy seamless integration and superior performance up to the 50 millionth compute unit, completely free of charge.
As your web3 needs grow, Validation Cloud is prepared to scale with you. Our Scale Plan is designed for users requiring additional compute units beyond the Free Plan 50 million CUs. The Scale Plan operates on a sliding scale, with the cost per 1 million CUs decreasing as your usage increases.
For high-volume users, protocols and applications, we offer the Private Plan.
The Private Plan offers two things over the Scale Plan:
Discounts/custom pricing based on your volume and traffic profile
RPC/API access to more blockchains than are available in the public Node API product. Validation Cloud runs nodes for 50+ chains. If you want connectivity into something not in our public product, chances are we're probably already running it and can enable it for your account.
You can let us know which chains you are interested in within the Node API product or with us directly.
In summary, Node API's Scale Plan offers a flexible pricing model that adjusts based on your usage. The more compute units you consume, the lower the cost per million CUs.
This approach ensures that you only pay for the resources you need, making it a cost-effective solution for both enterprises and developers at any stage of their web3 venture. For high-volume usage and discounts, the Private Plan offers a way to have custom pricing.
With our Node API, you can trust that you’re getting the most value from your crypto node infrastructure investment. Please feel free to if you have any questions or require further information.
Compute Unit Thresholds
Team Accounts How to share your Validation Cloud account with teammates.
With Team Accounts, your team can have individual accounts with controlled access to your Node API keys, Staking, and a single bill, instead of sharing one login.
If you already have a Validation Cloud account, you are the Admin of your own team. Until you add teammates, nothing changes about how you use your account.
There are two roles: Admin and Team Member . A team must always have at least one Admin.
One bill per team covers Node API usage for all team members.
Where to manage your team
As an Admin, you can see your team's members and their roles on the Team page in your Validation Cloud account. To add, remove, or change a teammate's role, email your account contact. Self-serve controls are coming in a future release.
Team Members see a read-only version of the team page.
Adding teammates
triangle-exclamation
Before you add a teammate, make sure they are not using their own existing Node API keys.
When someone joins a team, their previous Node API keys are deleted. Any applications or services running with those keys will break and cannot be recovered.
Have an Admin or Team Member in the account you will be invited to create any keys you need. Switch them over and verify they are working before joining the team.
To add a teammate:
Have them sign up for a Validation Cloud account at .
Email your account contact (or reply in your existing support thread) with their email and the role they should have (Admin or Team Member).
We will add them to your team.
Self-serve email invitations are coming in a future release.
Leaving or moving between teams
To leave a team or move between teams, contact your account manager.
Delete Node API endpoint keys
View billing, change plan, change payment method
Add, remove, or change role of team members
View and create Node API endpoint keys
Get Account Return the authentication key and the sequence number for an account address.
This method will use 15 Compute Units .
Get Account Resources Retrieves all account resources for a given account and a specific ledger version.
This method will use 30 Compute Units .
Get Account Resource Retrieves an individual resource from a given account and at a specific ledger version.
This method will use 20 Compute Units .
Get Account Modules Retrieves all account modules' bytecode for a given account at a specific ledger version.
This method will use 60 Compute Units .
Get Account Module Retrieves an individual module from a given account and at a specific ledger version.
This method will use 30 Compute Units .
Get Blocks by Height This endpoint allows you to get the transactions in a block and the corresponding block information.
This method will use 50 Compute Units .
Get Blocks by Version Get the transactions in a block and the corresponding block information given a version in the block.
This method will use 50 Compute Units .
Get Events by Creation Number Event types are globally identifiable by an account address and monotonically increasing creation_number. This API returns events corresponding to that event type.
This method will use 30 Compute Units .
Get Events by Event Handle This endpoint returns events emitted to the account matching a given event type.
This method will use 30 Compute Units .
Get Ledger Info Get the latest ledger information, including data such as chain ID, role type, ledger versions, epoch, etc.
This method will use 10 Compute Units .
Get Table Item Get a table item at a specific ledger version from the table.
This method will use 150 Compute Units .
Get Raw Table iItem Get a raw table item at a specific ledger version from the table.
This method will use 200 Compute Units .
Get transactions Retrieve on-chain committed transactions.
This method will use 150 Compute Units .
Get Transaction by Hash Look up a transaction by its hash.
This method will use 15 Compute Units .
Get Transaction by Version Retrieves a transaction by a given version.
This method will use 15 Compute Units .
Get Account Transactions Retrieves on-chain committed transactions from an account.
This method will use 150 Compute Units .
Submit Batch Transactions This allows you to submit multiple transactions.
Simulate Transaction The output of the transaction will have the exact transaction outputs and events that running an actual signed transaction would have.
This method will use 50 Compute Units .
Execute View Function of a Module Execute the Move function with the given parameters and return its execution result.
This method will use 50 Compute Units .
Faucets Getting test tokens to interact with blockchain networks
What is a Faucet in web3?
A faucet is a way for web3 users to obtain a small amount of testnet, or sometimes mainnet, tokens to their wallet, for the purpose of getting started using various blockchain networks or protocols, e.g. to help pay initial gas fees for testing transactions.
The name “faucet”, from American English, is used because tokens are usually “dripped” in small amounts over a fixed time period for the same user/wallet, e.g. 100 Test HBAR every 24 hours.
eth_accounts Returns a list of addresses owned by client.
This method will use 20 .
eth_blockNumber Returns the number of most recent block.
This method will use 20 .
eth_chainId Returns the chain ID used for signing replay-protected transactions.
This method will use 10 .
eth_estimateGas Generates and returns an estimate of how much gas is necessary to allow the transaction to complete.
This method will use 40 .
eth_getBalance Returns the balance of the account of given address.
This method will use 40 .
eth_getBlockTransactionCountByHash Returns the number of transactions in a block from a block matching the given block hash.
This method will use 40 .
eth_getBlockTransactionCountByNumber Returns the number of transactions in a block matching the given block number.
This method will use 40 .
eth_getCode Returns code at a given address.
This method will use 40 .
eth_getStorageAt Returns the balance of the account of given address.
This method will use 40 .
eth_getUncleByBlockNumberAndIndex Returns information about a uncle of a block by number and uncle index position.
This method will use 40 .
eth_getUncleCountByBlockHash Returns the number of uncles in a block from a block matching the given block hash.
This method will use 40 .
eth_maxPriorityFeePerGas Get the priority fee needed to be included in a block.
This method will use 20 .
None
eth_newBlockFilter Creates a filter in the node, to notify when a new block arrives. To check if the state has changed, call .
This method will use 40 .
eth_newPendingTransactionFilter Creates a filter in the node, to notify when new pending transactions arrive. To check if the state has changed, call .
This method will use 40 .
eth_sendRawTransaction Creates new message call transaction or a contract creation for signed transactions.
This method will use 80 .
eth_uninstallFilter Uninstalls a filter with given id. Should always be called when watch is no longer needed. Additionally Filters timeout when they aren't requested with for a period of time.
This method will use 20 .
eth_unsubscribe Cancels an existing subscription so that no further events are sent.
This method will use 20 .
subscription name - string, same as previously returned from an
net_peerCount Returns number of peers currently connected to the client.
This method will use 20 .
net_version Returns the current network id.
This method will use 10 .
web3_clientVersion Returns the current client version.
This method will use 40 .
web3_sha3 Returns Keccak-256 (not the standardized SHA3-256) of the given data.
This method will use 40 .
eth_accounts Returns a list of addresses owned by client.
This method will use 10 .
eth_chainId Returns the chain ID used for signing replay-protected transactions.
This method will use 5 .
eth_estimateGas Generates and returns an estimate of how much gas is necessary to allow the transaction to complete.
This method will use 100 .
eth_blockNumber Returns the number of most recent block.
This method will use 10 .
eth_getBlockTransactionCountByNumber Returns the number of transactions in a block matching the given block number.
This method will use 20 .
eth_getBlockTransactionCountByHash Returns the number of transactions in a block from a block matching the given block hash.
This method will use 20 .
C-Chain Supported JSON-RPC methods for Avalanche mainnet and fuji testnet.
Contract Chain (C-Chain):
The Contract Chain is the default smart contract blockchain on Avalanche and enables the creation of any Ethereum-compatible smart contracts. This blockchain is for applications that require total ordering (for faster asset transfers or any other commutative application, use the Exchange Chain). The Contract Chain implements the consensus protocol.
The trailing endpoint for C-Chain calls is:
What Faucets does Validation Cloud offer?
We provide a faucet for ICP (Internet Computer Protocol), specifically for the following tokens:
Note: You may have to import the above tokens into your wallet using the canister ID above.
We also link to other existing and working testnet faucets for the following networks:
Faucet Frequently Asked Questions (FAQ)
Why can I only get X tokens?
Even on testnet networks, tokens need to come from somewhere, often the relevant blockchain foundation.
As a result, individual users/wallets are normally restricted to a certain amount of tokens that provide enough to allow for testing or interaction with the relevant blockchain.
Copy To interact with C-Chain via the JSON-RPC endpoint via HTTPS:
/ext/bc/C/rpc (for all eth_ methods)
/ext/bc/C/avax (for all avax. methods)
To interact with C-Chain via the JSON-RPC endpoint via Websocket:
/ext/bc/C/ws
To interact with other instances of the EVM via the JSON-RPC endpoint:
/ext/bc/blockchainID/rpc
(where "blockchainID" is the ID of the EVM chain) from - [optional] String of the address the transaction is sent from.
to - [optional] String of the address the transaction is directed to.
gas - [optional] Integer of the gas provided for the transaction execution.
gasprice - [optional] Integer of the gasPrice used for each paid gas encoded as a hexadecimal.
value - [optional] Integer of the value sent with this transaction encoded as a hexadecimal.
String - hex string value representing an integer of the amount of gas units used.
QUANTITY - integer of the number of transactions in this block.
DATA, 20 Bytes - address.
DATA - the code from the given address.
DATA, The signed transaction data.
DATA, 32 Bytes - the transaction hash, or the zero hash if the transaction is not yet available.
QUANTITY - The filter id.
Boolean - true if the filter was successfully uninstalled, otherwise false.
String - The current network id.
11155111: Sepolia testnet
from - [optional] String of the address the transaction is sent from.
to - [optional] String of the address the transaction is directed to.
gas - [optional] Integer of the gas provided for the transaction execution.
gasprice - [optional] Integer of the gasPrice used for each paid gas encoded as a hexadecimal.
value - [optional] Integer of the value sent with this transaction encoded as a hexadecimal.
String - hex string value representing an integer of the amount of gas units used.
QUANTITY - integer of the number of transactions in this block.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_estimateGas","params":[{see above}],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_estimateGas","params":[{see above}],"id":1}'
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x5208" // 21000
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByNumber","params":["0x55946fd"],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByNumber","params":["0xe8"],"id":1}'
Copy params: [
"0xe8", // 232
]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xa" // 10
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getCode","params":["0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b", "0x2"],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getCode","params":["0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b", "0x2"],"id":1}'
Copy params: [
"0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b",
"0x2", // 2
]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x600160008035811a818181146012578301005b601b6001356025565b8060005260206000f25b600060078202905091905056"
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_sendRawTransaction","params":[{see above}],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_sendRawTransaction","params":[{see above}],"id":1}'
Copy params: [
"0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",
]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_uninstallFilter","params":["0xb"],"id":73}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_uninstallFilter","params":["0xb"],"id":73}'
Copy params: [
"0xb", // 11
]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": true
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"net_version","params":[],"id":67}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"net_version","params":[],"id":67}'
Copy // Result
{
"id":67,
"jsonrpc": "2.0",
"result": "3"
}
Copy curl https://mainnet.avalanche.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ext/bc/C/rpc \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_estimateGas","params":[{see above}],"id":1}'
Copy curl https://fuji.avalanche.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ext/bc/C/rpc \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_estimateGas","params":[{see above}],"id":1}'
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x5208" // 21000
}
Copy curl https://mainnet.avalanche.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ext/bc/C/rpc \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByNumber","params":["0xe8"],"id":1}'
Copy curl https://fuji.avalanche.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ext/bc/C/rpc \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByNumber","params":["0xe8"],"id":1}'
Copy params: [
"0xe8", // 232
]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xa" // 10
} array of data - 20 Bytes - addresses owned by the client
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": ["0x407d73d8a49eeb85d32cf465507dd71d507100c1"]
} INTEGER - Value of the current block number the client is on
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy // Result
{
"id":83,
"jsonrpc": "2.0",
"result": "0x4b7" // 1207
} chainId, hexadecimal value as a string representing the integer of the current chain id.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy // Result
{
"id":67,
"jsonrpc": "2.0",
"result": "0x1"
} DATA, 20 Bytes - address to check for balance.
INTEGER - Hex value representing integer of the current balance in WEI.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy // Result
{
"id":83,
"jsonrpc": "2.0",
"result": "0x2abfcdcfa71e54e"
} DATA, 32 Bytes - hash of a block
QUANTITY - integer of the number of transactions in this block.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy params: ["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xb" // 11
} DATA, 20 Bytes - address of the storage.
QUANTITY - integer of the position in the storage.
QUANTITY|TAG - integer block number, or the string "latest", "earliest" or "pending", see the
String - Hex value representing data at this storage position.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0", "method": "eth_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x0", "latest"], "id": 1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0", "method": "eth_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x0", "latest"], "id": 1}'
Copy // Result
{
"id":83,
"jsonrpc": "2.0",
"result": "0x0000000000000000000000000000000000000000000000000000000000000000"
} QUANTITY - the uncle's index position.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy params: [
"0x29c", // 668
"0x0", // 0
] DATA, 32 Bytes - hash of a block
QUANTITY - integer of the number of uncles in this block.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy params: ["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
call
true if a subscription was successfully cancelled, or false if no subscription existed with the given ID.
Copy wscat -c wss:///mainnet.arbitrum.validationcloud.io/v1/wss/ < YOUR_API_KEY_HER E >
Copy wscat -c wss:///sepolia.arbitrum.validationcloud.io/v1/wss/ < YOUR_API_KEY_HER E >
Copy params: [
"0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",
]
Copy // Result
{
"jsonrpc": "2.0",
"id": 1,
"result": true
} QUANTITY - integer of the number of connected peers.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy // Result
{
"id":74,
"jsonrpc": "2.0",
"result": "0x2" // 2
} string - The current client version 20 Bytes - addresses owned by the client
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy // Result
{
"jsonrpc":"2.0",
"id":67,
"result":"Geth/v1.10.26-stable-e5eb32ac/linux-amd64/go1.18.5"
} DATA - the data to convert into a SHA3 hash
DATA - The SHA3 resultant hash of the given string
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy // Result
{
"id":64,
"jsonrpc": "2.0",
"result": "0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad"
} array of data - 20 Bytes - addresses owned by the client
Copy curl https://mainnet.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
Copy curl https://fuji.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": ["0x407d73d8a49eeb85d32cf465507dd71d507100c1"]
} chainId, hexadecimal value as a string representing the integer of the current chain id.
Copy curl https://mainnet.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
Copy curl https://fuji.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
Copy // Result
{
"id":67,
"jsonrpc": "2.0",
"result": "0x1"
} INTEGER - Value of the current block number the client is on
Copy curl https://mainnet.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
Copy curl https://fuji.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
Copy // Result
{
"id":83,
"jsonrpc": "2.0",
"result": "0x4b7" // 1207
} DATA, 32 Bytes - hash of a block
QUANTITY - integer of the number of transactions in this block.
Copy curl https://mainnet.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
Copy curl https://fuji.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X
Copy params: ["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xb" // 11
} get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /accounts/ {address} Return the authentication key and the sequence number for an account
address. Optionally, a ledger version can be specified. If the ledger
version is not specified in the request, the latest ledger version is used.
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ledger_version string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get account resources
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /accounts/ {address} /resources Retrieves all account resources for a given account and a specific ledger version. If the
ledger version is not specified in the request, the latest ledger version is used.
The Aptos nodes prune account state history, via a configurable time window.
If the requested ledger version has been pruned, the server responds with a 410.
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ledger_version string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 start string Optional Representation of a StateKey as a hex string. This is used for cursor based pagination.
Example: 0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879 limit integer · uint16 Optional Max number of account resources to retrieve
If not provided, defaults to default page size.
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get account resource
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /accounts/ {address} /resource/ {resource_type} Retrieves an individual resource from a given account and at a specific ledger version. If the
ledger version is not specified in the request, the latest ledger version is used.
The Aptos nodes prune account state history, via a configurable time window.
If the requested ledger version has been pruned, the server responds with a 410.
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 resource_type string Required String representation of a MoveStructTag (on-chain Move struct type). This exists so you
can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
move_module_address, module_name and struct_name, all joined by ::
struct generic type parameters joined by ,
Examples:
0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
0x1::account::Account
Note:
Empty chars should be ignored when comparing 2 struct tag ids.
When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
See doc for more details.
Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> Pattern: ^0x[0-9a-zA-Z:_<>]+$ ledger_version string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get account modules
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /accounts/ {address} /modules Retrieves all account modules' bytecode for a given account at a specific ledger version.
If the ledger version is not specified in the request, the latest ledger version is used.
The Aptos nodes prune account state history, via a configurable time window.
If the requested ledger version has been pruned, the server responds with a 410.
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ledger_version string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 start string Optional Representation of a StateKey as a hex string. This is used for cursor based pagination.
Example: 0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879 limit integer · uint16 Optional Max number of account modules to retrieve
If not provided, defaults to default page size.
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get account module
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /accounts/ {address} /module/ {module_name} Retrieves an individual module from a given account and at a specific ledger version. If the
ledger version is not specified in the request, the latest ledger version is used.
The Aptos nodes prune account state history, via a configurable time window.
If the requested ledger version has been pruned, the server responds with a 410.
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 module_name string Required Name of module to retrieve e.g. coin
ledger_version string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get blocks by height
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /blocks/by_height/ {block_height} This endpoint allows you to get the transactions in a block
and the corresponding block information.
Transactions are limited by max default transactions size. If not all transactions
are present, the user will need to query for the rest of the transactions via the
get transactions API.
If the block is pruned, it will return a 410
block_height integer · uint64 Required Block height to lookup. Starts at 0
with_transactions boolean Optional If set to true, include all transactions in the block
If not provided, no transactions will be retrieved
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get blocks by version
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /blocks/by_version/ {version} This endpoint allows you to get the transactions in a block
and the corresponding block information given a version in the block.
Transactions are limited by max default transactions size. If not all transactions
are present, the user will need to query for the rest of the transactions via the
get transactions API.
If the block has been pruned, it will return a 410
version integer · uint64 Required Ledger version to lookup block information for.
with_transactions boolean Optional If set to true, include all transactions in the block
If not provided, no transactions will be retrieved
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get events by creation number
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /accounts/ {address} /events/ {creation_number} Event types are globally identifiable by an account address and
monotonically increasing creation_number, one per event type emitted
to the given account. This API returns events corresponding to that
that event type.
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 creation_number string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 start string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 limit integer · uint16 Optional Max number of events to retrieve.
If unspecified, defaults to default page size
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get events by event handle
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /accounts/ {address} /events/ {event_handle} / {field_name} This API uses the given account address, eventHandle, and fieldName
to build a key that can globally identify an event types. It then uses this
key to return events emitted to the given account matching that event type.
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 event_handle string Required String representation of a MoveStructTag (on-chain Move struct type). This exists so you
can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
move_module_address, module_name and struct_name, all joined by ::
struct generic type parameters joined by ,
Examples:
0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
0x1::account::Account
Note:
Empty chars should be ignored when comparing 2 struct tag ids.
When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
See doc for more details.
Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> Pattern: ^0x[0-9a-zA-Z:_<>]+$ field_name string Required Name of field to lookup event handle e.g. withdraw_events
start string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 limit integer · uint16 Optional Max number of events to retrieve.
If unspecified, defaults to default page size
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get ledger info
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 / Get the latest ledger information, including data such as chain ID,
role type, ledger versions, epoch, etc.
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
post
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /tables/ {table_handle} /item Get a table item at a specific ledger version from the table identified by {table_handle}
in the path and the "key" (TableItemRequest) provided in the request body.
This is a POST endpoint because the "key" for requesting a specific
table item (TableItemRequest) could be quite complex, as each of its
fields could themselves be composed of other structs. This makes it
impractical to express using query params, meaning GET isn't an option.
The Aptos nodes prune account state history, via a configurable time window.
If the requested ledger version has been pruned, the server responds with a 410.
table_handle string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ledger_version string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 Body
application/json chevron-down application/json
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get raw table item
post
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /tables/ {table_handle} /raw_item Get a table item at a specific ledger version from the table identified by {table_handle}
in the path and the "key" (RawTableItemRequest) provided in the request body.
The get_raw_table_item requires only a serialized key comparing to the full move type information
comparing to the get_table_item api, and can only return the query in the bcs format.
The Aptos nodes prune account state history, via a configurable time window.
If the requested ledger version has been pruned, the server responds with a 410.
table_handle string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ledger_version string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 Body
application/json chevron-down application/json
Table Item request for the GetTableItemRaw API
key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get transactions
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /transactions Retrieve on-chain committed transactions. The page size and start ledger version
can be provided to get a specific sequence of transactions.
If the version has been pruned, then a 410 will be returned.
To retrieve a pending transaction, use /transactions/by_hash.
start string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 limit integer · uint16 Optional Max number of transactions to retrieve.
If not provided, defaults to default page size
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get transaction by hash
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /transactions/by_hash/ {txn_hash} Look up a transaction by its hash. This is the same hash that is returned
by the API when submitting a transaction (see PendingTransaction).
When given a transaction hash, the server first looks for the transaction
in storage (on-chain, committed). If no on-chain transaction is found, it
looks the transaction up by hash in the mempool (pending, not yet committed).
To create a transaction hash by yourself, do the following:
Hash message bytes: "RawTransaction" bytes + BCS bytes of Transaction .
Apply hash algorithm SHA3-256 to the hash message bytes.
Hex-encode the hash bytes with 0x prefix.
txn_hash string Required Hash of transaction to retrieve
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get transaction by version
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /transactions/by_version/ {txn_version} Retrieves a transaction by a given version. If the version has been
pruned, a 410 will be returned.
txn_version string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Get account transactions
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /accounts/ {address} /transactions Retrieves on-chain committed transactions from an account. If the start
version is too far in the past, a 410 will be returned.
If no start version is given, it will start at version 0.
To retrieve a pending transaction, use /transactions/by_hash.
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 start string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 limit integer · uint16 Optional Max number of transactions to retrieve.
If not provided, defaults to default page size
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Submit batch transactions
post
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /transactions/batch This allows you to submit multiple transactions. The response has three outcomes:
All transactions succeed, and it will return a 202
Some transactions succeed, and it will return the failed transactions and a 206
No transactions succeed, and it will also return the failed transactions and a 206
To submit a transaction as JSON, you must submit a SubmitTransactionRequest.
To build this request, do the following:
Encode the transaction as BCS. If you are using a language that has
native BCS support, make sure to use that library. If not, you may take
advantage of /transactions/encode_submission. When using this
endpoint, make sure you trust the node you're talking to, as it is
possible they could manipulate your request.
Sign the encoded transaction and use it to create a TransactionSignature.
Submit the request. Make sure to use the "application/json" Content-Type.
To submit a transaction as BCS, you must submit a SignedTransaction
encoded as BCS. See SignedTransaction in types/src/transaction/mod.rs.
Make sure to use the application/x.aptos.signed_transaction+bcs Content-Type.
Body object[]
application/json chevron-down application/json application/x.aptos.signed_transaction+bcs
A request to submit a transaction
This requires a transaction and a signature of it
sender string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 sequence_number string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 max_gas_amount string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 gas_unit_price string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 expiration_timestamp_secs string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 payload one of Required An enum of the possible transaction payloads
object Optional Payload which runs a single entry function
Hide properties plus
type Discriminator string Required Example: entry_function_payload
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
or object Optional Payload which runs a script that can run multiple functions
Hide properties plus
type Discriminator string Required Example: script_payload
Hide properties plus
bytecode string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Hide properties plus
visibility string · enum Required Possible values: privatepublicfriend is_entry boolean Required Whether the function can be called as an entry function directly in a transaction
generic_type_params object[] Required Generic type params associated with the Move function
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the function that uses it
params string[] Required Parameters associated with the move function
return string[] Required Return type of the function
type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
or object Optional
Hide properties plus
type Discriminator string Required Example: module_bundle_payload
modules object[] Required Move module bytecode along with it's ABI
Hide properties plus
bytecode string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Hide properties plus
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 friends string[] Required Example: 0x1::aptos_coin exposed_functions object[] Required Public functions of the module
Hide properties plus
visibility string · enum Required Possible values: privatepublicfriend is_entry boolean Required Whether the function can be called as an entry function directly in a transaction
generic_type_params object[] Required Generic type params associated with the Move function
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the function that uses it
params string[] Required Parameters associated with the move function
return string[] Required Return type of the function
Hide properties plus
is_native boolean Required Whether the struct is a native struct of Move
abilities string[] Required Abilities associated with the struct
generic_type_params object[] Required Generic types associated with the struct
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the type that uses it
fields object[] Required Fields associated with the struct
Hide properties plus
type string Required String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Pattern: ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$ or object Optional A multisig transaction that allows an owner of a multisig account to execute a pre-approved
transaction as the multisig account.
Hide properties plus
type Discriminator string Required Example: multisig_payload
multisig_address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 transaction_payload any of Optional
object Optional Payload which runs a single entry function
Hide properties plus
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
signature one of Required An enum representing the different transaction signatures available
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional Multi agent signature for multi agent transactions
This allows you to have transactions across multiple accounts
Hide properties plus
type Discriminator string Required Example: multi_agent_signature
sender one of Required Account signature scheme
The account signature scheme allows you to have two types of accounts:
A single Ed25519 key account, one private key
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 secondary_signer_addresses string · hex[] Required The other involved parties' addresses
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 secondary_signers one of[] Required The associated signatures, in the same order as the secondary addresses
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Simulate transaction
post
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /transactions/simulate The output of the transaction will have the exact transaction outputs and events that running
an actual signed transaction would have. However, it will not have the associated state
hashes, as they are not updated in storage. This can be used to estimate the maximum gas
units for a submitted transaction.
To use this, you must:
Create a SignedTransaction with a zero-padded signature.
Submit a SubmitTransactionRequest containing a UserTransactionRequest containing that signature.
To use this endpoint with BCS, you must submit a SignedTransaction
encoded as BCS. See SignedTransaction in types/src/transaction/mod.rs.
estimate_max_gas_amount boolean Optional If set to true, the max gas value in the transaction will be ignored
and the maximum possible gas will be used
estimate_gas_unit_price boolean Optional If set to true, the gas unit price in the transaction will be ignored
and the estimated value will be used
estimate_prioritized_gas_unit_price boolean Optional If set to true, the transaction will use a higher price than the original
estimate.
Body
application/json chevron-down application/json application/x.aptos.signed_transaction+bcs
A request to submit a transaction
This requires a transaction and a signature of it
sender string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 sequence_number string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 max_gas_amount string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 gas_unit_price string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 expiration_timestamp_secs string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 payload one of Required An enum of the possible transaction payloads
object Optional Payload which runs a single entry function
Hide properties plus
type Discriminator string Required Example: entry_function_payload
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
or object Optional Payload which runs a script that can run multiple functions
Hide properties plus
type Discriminator string Required Example: script_payload
Hide properties plus
bytecode string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Hide properties plus
visibility string · enum Required Possible values: privatepublicfriend is_entry boolean Required Whether the function can be called as an entry function directly in a transaction
generic_type_params object[] Required Generic type params associated with the Move function
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the function that uses it
params string[] Required Parameters associated with the move function
return string[] Required Return type of the function
type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
or object Optional
Hide properties plus
type Discriminator string Required Example: module_bundle_payload
modules object[] Required Move module bytecode along with it's ABI
Hide properties plus
bytecode string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Hide properties plus
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 friends string[] Required Example: 0x1::aptos_coin exposed_functions object[] Required Public functions of the module
Hide properties plus
visibility string · enum Required Possible values: privatepublicfriend is_entry boolean Required Whether the function can be called as an entry function directly in a transaction
generic_type_params object[] Required Generic type params associated with the Move function
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the function that uses it
params string[] Required Parameters associated with the move function
return string[] Required Return type of the function
Hide properties plus
is_native boolean Required Whether the struct is a native struct of Move
abilities string[] Required Abilities associated with the struct
generic_type_params object[] Required Generic types associated with the struct
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the type that uses it
fields object[] Required Fields associated with the struct
Hide properties plus
type string Required String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Pattern: ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$ or object Optional A multisig transaction that allows an owner of a multisig account to execute a pre-approved
transaction as the multisig account.
Hide properties plus
type Discriminator string Required Example: multisig_payload
multisig_address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 transaction_payload any of Optional
object Optional Payload which runs a single entry function
Hide properties plus
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
signature one of Required An enum representing the different transaction signatures available
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional Multi agent signature for multi agent transactions
This allows you to have transactions across multiple accounts
Hide properties plus
type Discriminator string Required Example: multi_agent_signature
sender one of Required Account signature scheme
The account signature scheme allows you to have two types of accounts:
A single Ed25519 key account, one private key
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 secondary_signer_addresses string · hex[] Required The other involved parties' addresses
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 secondary_signers one of[] Required The associated signatures, in the same order as the secondary addresses
object Optional A single Ed25519 signature
Hide properties plus
type Discriminator string Required Example: ed25519_signature
public_key string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signature string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 or object Optional A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Hide properties plus
type Discriminator string Required Example: multi_ed25519_signature
public_keys string · hex[] Required The public keys for the Ed25519 signature
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 signatures string · hex[] Required Signature associated with the public keys in the same order
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 threshold integer · uint8 Required The number of signatures required for a successful transaction
bitmap string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Encode submission
post
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /transactions/encode_submission This endpoint accepts an EncodeSubmissionRequest, which internally is a
UserTransactionRequestInner (and optionally secondary signers) encoded
as JSON, validates the request format, and then returns that request
encoded in BCS. The client can then use this to create a transaction
signature to be used in a SubmitTransactionRequest, which it then
passes to the /transactions POST endpoint.
To be clear, this endpoint makes it possible to submit transaction
requests to the API from languages that do not have library support for
BCS. If you are using an SDK that has BCS support, such as the official
Rust, TypeScript, or Python SDKs, you do not need to use this endpoint.
To sign a message using the response from this endpoint:
Decode the hex encoded string in the response to bytes.
Sign the bytes to create the signature.
Use that as the signature field in something like Ed25519Signature, which you then use to build a TransactionSignature.
Body
application/json chevron-down application/json
Estimate gas price
get
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /estimate_gas_price Currently, the gas estimation is handled by taking the median of the last 100,000 transactions
If a user wants to prioritize their transaction and is willing to pay, they can pay more
than the gas price. If they're willing to wait longer, they can pay less. Note that the
gas price moves with the fee market, and should only increase when demand outweighs supply.
If there have been no transactions in the last 100,000 transactions, the price will be 1.
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Execute view function of a module
post
https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1 /view Execute the Move function with the given parameters and return its execution result.
The Aptos nodes prune account state history, via a configurable time window.
If the requested ledger version has been pruned, the server responds with a 410.
ledger_version string · uint64 Optional A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 Body
application/json chevron-down application/json
View request for the Move View Function API
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
eth_call Executes a new message call immediately without creating a transaction on the block chain.
This method will use 40 Compute Units .
Object - The transaction call object
from - [optional] String of the address the transaction is sent from.
to - String of the address the transaction is directed to.
gas - [optional] Integer of the gas provided for the transaction execution.
gasprice - [optional] Integer of the gasPrice used for each paid gas encoded as a hexadecimal.
value - [optional] Integer of the value sent with this transaction encoded as a hexadecimal.
data - [optional] String of the hash of the method signature and encoded parameters. For more information, see the .
QUANTITY | TAG - integer block number, or the string "latest", "earliest" or "pending", see the
data - hex value of the executed call or contract
eth_syncing Returns an object with data about the sync status or false.
This method will use 10 Compute Units .
None
Object|Boolean, An object with sync status data or FALSE, when not syncing:
startingBlock: QUANTITY - The block at which the import started (will only be reset, after the sync reached his head)
currentBlock: QUANTITY - The current block, same as eth_blockNumber
eth_call Executes a new message call immediately without creating a transaction on the block chain.
This method will use 30 Compute Units .
Object - The transaction call object
from - [optional] String of the address the transaction is sent from.
to - String of the address the transaction is directed to.
gas - [optional] Integer of the gas provided for the transaction execution.
QUANTITY | TAG - integer block number, or the string "latest", "earliest" or "pending", see the
data - hex value of the executed call or contract
eth_getTransactionCount Returns the number of transactions sent from an address.
This method will use 40 Compute Units .
DATA, 20 Bytes - address.
QUANTITY|TAG - integer block number, or the string "latest", "earliest" or "pending", see the
QUANTITY - String hex value representing integer of the number of transactions sent from this address.
eth_getUncleByBlockHashAndIndex Returns information about a uncle of a block by hash and uncle index position.
This method will use 40 .
eth_newFilter Creates a filter object, based on filter options, to notify when the state changes (logs). To check if the state has changed, call .
This method will use 40 .
A note on specifying topic filters: Topics are order-dependent. A transaction with a log with topics [A, B] will be matched by the following topic filters:
eth_getBlockByHash Returns information about a block by hash.
This method will use 30 .
eth_getBlockByNumber Returns information about a block by block number.
This method will use 20 .
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_accounts","params":[],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_accounts","params":[],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":0} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":0} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_chainId","params":[],"id":67} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_chainId","params":[],"id":67} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getBalance","params":["0x95abDa53Bc5E9fBBDce34603614018d32CED219e", "latest"],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getBalance","params":["0x95abDa53Bc5E9fBBDce34603614018d32CED219e", "latest"],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByHash","params":["0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae"],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getUncleByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getUncleByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getUncleCountByBlockHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getUncleCountByBlockHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_maxPriorityFeePerGas","params":[],"id":73} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_maxPriorityFeePerGas","params":[],"id":73} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_newBlockFilter","params":[],"id":73} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_newBlockFilter","params":[],"id":73} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_newPendingTransactionFilter","params":[],"id":73} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_newPendingTransactionFilter","params":[],"id":73} '
{ "jsonrpc" : " 2.0 " , " id " : 1, " method " : " eth_subscribe " , " params " :[ " newHeads " ]}
{ "jsonrpc" : "2.0" , "result" : "0x5302037dae412a3454143512a3c7617b" , "id" :1}
# # subscription data
{ "id" : 1, " jsonrpc " : " 2.0 " , " method " : " eth_unsubscribe " , " params " : [ " 0x5302037dae412a3454143512a3c7617b " ] }
{ "jsonrpc" : "2.0" , "result" :true, "id" :1}
{ "jsonrpc" : " 2.0 " , " id " : 1, " method " : " eth_subscribe " , " params " :[ " newHeads " ]}
{ "jsonrpc" : "2.0" , "result" : "0x5302037dae412a3454143512a3c7617b" , "id" :1}
# # subscription data
{ "id" : 1, " jsonrpc " : " 2.0 " , " method " : " eth_unsubscribe " , " params " : [ " 0x5302037dae412a3454143512a3c7617b " ] }
{ "jsonrpc" : "2.0" , "result" :true, "id" :1}
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"net_peerCount","params":[],"id":74} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"net_peerCount","params":[],"id":74} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"web3_clientVersion","params":[],"id":67} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"web3_clientVersion","params":[],"id":67} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"web3_sha3","params":["0x68656c6c6f20776f726c64"],"id":64} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"web3_sha3","params":["0x68656c6c6f20776f726c64"],"id":64} '
-X
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_accounts","params":[],"id":1} '
-X
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_accounts","params":[],"id":1} '
-X
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0", "method":"eth_chainId","params":[],"id":67} '
-X
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0", "method":"eth_chainId","params":[],"id":67} '
-X
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":0} '
-X
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":0} '
-X
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1} '
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1} '
v1/accounts/{address}/module/{module_name}
v1/accounts/{address}/events/{creation_number}
v1/accounts/{address}/events/{event_handle}/{field_name}
v1/blocks/by_height/{block_height}
v1/blocks/by_version/{version}
v1/tables/{table_handle}/item
v1/tables/{table_handle}/raw_item
v1/transactions/by_hash/{txn_hash}
v1/transactions/by_version/{txn_version}
v1/accounts/{address}/transactions
v1/transactions/encode_submission
Table Item request for the GetTableItem API
key_type string Required String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Pattern: ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$ value_type string Required String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Pattern: ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$ key any Required The value of the table item's key
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Required Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Required Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Required Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Required Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Required Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Required Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Required Oldest non-pruned block height of the chain
X-APTOS-CURSOR string Optional Cursor to be used for endpoints that support cursor-based
pagination. Pass this to the start field of the endpoint
on the next call to get the next page of results.
Response object Batch transaction submission result
Tells which transactions failed
Hide properties plus
transaction_failures object[] Required Summary of the failed transactions
Hide properties plus
error object Required This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
transaction_index integer · uint64 Required The index of which transaction failed, same as submission order
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Request to encode a submission
sender string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 sequence_number string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 max_gas_amount string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 gas_unit_price string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 expiration_timestamp_secs string · uint64 Required A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such
as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034 payload one of Required An enum of the possible transaction payloads
object Optional Payload which runs a single entry function
Hide properties plus
type Discriminator string Required Example: entry_function_payload
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
or object Optional Payload which runs a script that can run multiple functions
Hide properties plus
type Discriminator string Required Example: script_payload
Hide properties plus
bytecode string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Hide properties plus
visibility string · enum Required Possible values: privatepublicfriend is_entry boolean Required Whether the function can be called as an entry function directly in a transaction
generic_type_params object[] Required Generic type params associated with the Move function
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the function that uses it
params string[] Required Parameters associated with the move function
return string[] Required Return type of the function
type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
or object Optional
Hide properties plus
type Discriminator string Required Example: module_bundle_payload
modules object[] Required Move module bytecode along with it's ABI
Hide properties plus
bytecode string · hex Required All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Hide properties plus
address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 friends string[] Required Example: 0x1::aptos_coin exposed_functions object[] Required Public functions of the module
Hide properties plus
visibility string · enum Required Possible values: privatepublicfriend is_entry boolean Required Whether the function can be called as an entry function directly in a transaction
generic_type_params object[] Required Generic type params associated with the Move function
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the function that uses it
params string[] Required Parameters associated with the move function
return string[] Required Return type of the function
Hide properties plus
is_native boolean Required Whether the struct is a native struct of Move
abilities string[] Required Abilities associated with the struct
generic_type_params object[] Required Generic types associated with the struct
Hide properties plus
constraints string[] Required Move abilities tied to the generic type param and associated with the type that uses it
fields object[] Required Fields associated with the struct
Hide properties plus
type string Required String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Pattern: ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$ or object Optional A multisig transaction that allows an owner of a multisig account to execute a pre-approved
transaction as the multisig account.
Hide properties plus
type Discriminator string Required Example: multisig_payload
multisig_address string · hex Required A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes
shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 transaction_payload any of Optional
object Optional Payload which runs a single entry function
Hide properties plus
function string Required Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Example: 0x1::aptos_coin::transfer type_arguments string[] Required Type arguments of the function
arguments any[] Required Arguments of the function
Hide properties plus
secondary_signers string · hex[] Optional Secondary signer accounts of the request for Multi-agent
Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
Headers object
Hide Headers plus
X-APTOS-CHAIN-ID integer · uint8 Optional Chain ID of the current chain
X-APTOS-LEDGER-VERSION integer · uint64 Optional Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer · uint64 Optional Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer · uint64 Optional Current timestamp of the chain
X-APTOS-EPOCH integer · uint64 Optional Current epoch of the chain
X-APTOS-BLOCK-HEIGHT integer · uint64 Optional Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer · uint64 Optional Oldest non-pruned block height of the chain
Response object This is the generic struct we use for all API errors, it contains a string
message and an Aptos API specific error code.
Hide properties plus
message string Required A message describing the error
error_code string · enum Required These codes provide more granular error information beyond just the HTTP
status code of the response.
Possible values: account_not_foundresource_not_foundmodule_not_foundstruct_field_not_foundversion_not_foundtransaction_not_foundtable_item_not_foundblock_not_foundversion_prunedblock_prunedinvalid_inputinvalid_transaction_updatesequence_number_too_oldvm_errorhealth_check_failedmempool_is_fullinternal_errorweb_framework_errorbcs_not_supportedapi_disabled vm_error_code integer · uint64 Optional A code providing VM error details when submitting transactions to the VM
highestBlock: QUANTITY - The estimated highest block
gasprice - [optional] Integer of the gasPrice used for each paid gas encoded as a hexadecimal.
value - [optional] Integer of the value sent with this transaction encoded as a hexadecimal.
DATA, 32 Bytes - The hash of a block.
QUANTITY - The uncle's index position.
Object - A block object, or null when no block was found:
number: QUANTITY - the block number. null when its pending block.
hash: DATA, 32 Bytes - hash of the block. null when its pending block.
parentHash: DATA, 32 Bytes - hash of the parent block.
nonce: DATA, 8 Bytes - hash of the generated proof-of-work. null when its pending block.
sha3Uncles: DATA, 32 Bytes - SHA3 of the uncles data in the block.
logsBloom: DATA, 256 Bytes - the bloom filter for the logs of the block. null when its pending block.
transactionsRoot: DATA, 32 Bytes - the root of the transaction trie of the block.
stateRoot: DATA, 32 Bytes - the root of the final state trie of the block.
receiptsRoot: DATA, 32 Bytes - the root of the receipts trie of the block.
miner: DATA, 20 Bytes - the address of the beneficiary to whom the mining rewards were given.
difficulty: QUANTITY - integer of the difficulty for this block.
totalDifficulty: QUANTITY - integer of the total difficulty of the chain until this block.
extraData: DATA - the "extra data" field of this block.
size: QUANTITY - integer the size of this block in bytes.
gasLimit: QUANTITY - the maximum gas allowed in this block.
gasUsed: QUANTITY - the total used gas by all transactions in this block.
timestamp: QUANTITY - the unix timestamp for when the block was collated.
transactions: Array - Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
uncles: Array - Array of uncle hashes.
[A] "A in first position (and anything after)"
[null, B] "anything in first position AND B in second position (and anything after)"
[A, B] "A in first position AND B in second position (and anything after)"
[[A, B], [A, B]] "(A OR B) in first position AND (A OR B) in second position (and anything after)"
Object - The filter options:
fromBlock: QUANTITY|TAG - (optional, default: "latest") Integer block number, or "latest" for the last mined block, "safe" for the latest safe block, "finalized" for the latest finalized block, or "pending", "earliest" for not yet mined transactions.
toBlock: QUANTITY|TAG - (optional, default: "latest") Integer block number, or "latest" for the last mined block, "safe" for the latest safe block, "finalized" for the latest finalized block, or "pending", "earliest" for not yet mined transactions.
address: DATA|Array, 20 Bytes - (optional) Contract address or a list of addresses from which logs should originate.
topics: Array of DATA, - (optional) Array of 32 Bytes DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with "or" options.
DATA, 32 Bytes - Hash of a block.
Boolean - If true it returns the full transaction objects, if false only the hashes of the transactions are returned.
Object - A block object, or null when no block was found:
number: QUANTITY - the block number. null when its pending block.
hash: DATA, 32 Bytes - hash of the block. null when its pending block.
parentHash: DATA, 32 Bytes - hash of the parent block.
nonce: DATA, 8 Bytes - hash of the generated proof-of-work. null when its pending block.
sha3Uncles: DATA, 32 Bytes - SHA3 of the uncles data in the block.
logsBloom: DATA, 256 Bytes - the bloom filter for the logs of the block. null when its pending block.
transactionsRoot: DATA, 32 Bytes - the root of the transaction trie of the block.
stateRoot: DATA, 32 Bytes - the root of the final state trie of the block.
receiptsRoot: DATA, 32 Bytes - the root of the receipts trie of the block.
miner: DATA, 20 Bytes - the address of the beneficiary to whom the mining rewards were given.
difficulty: QUANTITY - integer of the difficulty for this block.
totalDifficulty: QUANTITY - integer of the total difficulty of the chain until this block.
extraData: DATA - the "extra data" field of this block.
size: QUANTITY - integer the size of this block in bytes.
gasLimit: QUANTITY - the maximum gas allowed in this block.
gasUsed: QUANTITY - the total used gas by all transactions in this block.
timestamp: QUANTITY - the unix timestamp for when the block was collated.
transactions: Array - Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
uncles: Array - Array of uncle hashes.
Boolean - If true it returns the full transaction objects, if false only the hashes of the transactions.
Object - A block object, or null when no block was found:
number: QUANTITY - the block number. null when its pending block.
hash: DATA, 32 Bytes - hash of the block. null when its pending block.
parentHash: DATA, 32 Bytes - hash of the parent block.
nonce: DATA, 8 Bytes - hash of the generated proof-of-work. null when its pending block.
sha3Uncles: DATA, 32 Bytes - SHA3 of the uncles data in the block.
logsBloom: DATA, 256 Bytes - the bloom filter for the logs of the block. null when its pending block.
transactionsRoot: DATA, 32 Bytes - the root of the transaction trie of the block.
stateRoot: DATA, 32 Bytes - the root of the final state trie of the block.
receiptsRoot: DATA, 32 Bytes - the root of the receipts trie of the block.
miner: DATA, 20 Bytes - the address of the beneficiary to whom the mining rewards were given.
difficulty: QUANTITY - integer of the difficulty for this block.
totalDifficulty: QUANTITY - integer of the total difficulty of the chain until this block.
extraData: DATA - the "extra data" field of this block.
size: QUANTITY - integer the size of this block in bytes.
gasLimit: QUANTITY - the maximum gas allowed in this block.
gasUsed: QUANTITY - the total used gas by all transactions in this block.
timestamp: QUANTITY - the unix timestamp for when the block was collated.
transactions: Array - Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
uncles: Array - Array of uncle hashes.
Copy POST /v1/<YOUR_API_KEY_HERE>/v1/tables/{table_handle}/item HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Content-Type: application/json
Accept: */*
Content-Length: 50
{
"key_type": "text",
"value_type": "text",
"key": null
}
Copy POST /v1/<YOUR_API_KEY_HERE>/v1/tables/{table_handle}/raw_item HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
Copy POST /v1/<YOUR_API_KEY_HERE>/v1/transactions/batch HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Content-Type: application/json
Accept: */*
Content-Length: 548
[
{
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
}
]
Copy {
"transaction_failures": [
{
"error": {
"message": "text",
"error_code": "account_not_found",
"vm_error_code": 1
},
"transaction_index": 1
}
]
}
Copy POST /v1/<YOUR_API_KEY_HERE>/v1/transactions/encode_submission HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Content-Type: application/json
Accept: */*
Content-Length: 432
{
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"secondary_signers": [
"0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
]
}
Copy 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Copy {
"sequence_number": "32425224034",
"authentication_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/accounts/{address} HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy {
"bytecode": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"abi": {
"address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"name": "text",
"friends": [
"0x1::aptos_coin"
],
"exposed_functions": [
{
"name": "text",
"visibility": "private",
"is_entry": true,
"generic_type_params": [
{
"constraints": [
"text"
]
}
],
"params": [
"text"
],
"return": [
"text"
]
}
],
"structs": [
{
"name": "text",
"is_native": true,
"abilities": [
"text"
],
"generic_type_params": [
{
"constraints": [
"text"
]
}
],
"fields": [
{
"name": "text",
"type": "text"
}
]
}
]
}
}
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/module/{module_name} HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy {
"block_height": "32425224034",
"block_hash": "text",
"block_timestamp": "32425224034",
"first_version": "32425224034",
"last_version": "32425224034",
"transactions": [
{
"type": "pending_transaction",
"hash": "text",
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
}
]
}
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/blocks/by_height/{block_height} HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy {
"block_height": "32425224034",
"block_hash": "text",
"block_timestamp": "32425224034",
"first_version": "32425224034",
"last_version": "32425224034",
"transactions": [
{
"type": "pending_transaction",
"hash": "text",
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
}
]
}
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/blocks/by_version/{version} HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/ HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy {
"chain_id": 1,
"epoch": "32425224034",
"ledger_version": "32425224034",
"oldest_ledger_version": "32425224034",
"ledger_timestamp": "32425224034",
"node_role": "validator",
"oldest_block_height": "32425224034",
"block_height": "32425224034",
"git_hash": "text"
}
Copy [
{
"type": "pending_transaction",
"hash": "text",
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
}
]
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/transactions HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy {
"type": "pending_transaction",
"hash": "text",
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
}
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/transactions/by_hash/{txn_hash} HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy {
"type": "pending_transaction",
"hash": "text",
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
}
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/transactions/by_version/{txn_version} HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy [
{
"type": "pending_transaction",
"hash": "text",
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
}
]
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/transactions HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy {
"deprioritized_gas_estimate": 1,
"gas_estimate": 1,
"prioritized_gas_estimate": 1
}
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/estimate_gas_price HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy POST /v1/<YOUR_API_KEY_HERE>/v1/view HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Content-Type: application/json
Accept: */*
Content-Length: 81
{
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
}
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x"
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"method":"eth_call","params":[{"from":null,"to":"0x6b175474e89094c44da98b954eedeac495271d0f","data":"0x70a082310000000000000000000000006E0d01A76C3Cf4288372a29124A26D4353EE51BE"}, "latest"],"id":1,"jsonrpc":"2.0"}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"method":"eth_call","params":[{"from":null,"to":"0x6b175474e89094c44da98b954eedeac495271d0f","data":"0x70a082310000000000000000000000006E0d01A76C3Cf4288372a29124A26D4353EE51BE"}, "latest"],"id":1,"jsonrpc":"2.0"}'
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": {
startingBlock: '0x384',
currentBlock: '0x386',
highestBlock: '0x454'
}
}
// Or when not syncing
{
"id":1,
"jsonrpc": "2.0",
"result": false
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}'
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x"
}
Copy curl https://mainnet.avalanche.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ext/bc/C/rpc \
-X POST \
-H "Content-Type: application/json" \
-d '{"method":"eth_call","params":[{"from":null,"to":"0x6b175474e89094c44da98b954eedeac495271d0f","data":"0x70a082310000000000000000000000006E0d01A76C3Cf4288372a29124A26D4353EE51BE"}, "latest"],"id":1,"jsonrpc":"2.0"}'
Copy curl https://fuji.avalanche.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ext/bc/C/rpc \
-X POST \
-H "Content-Type: application/json" \
-d '{"method":"eth_call","params":[{"from":null,"to":"0x6b175474e89094c44da98b954eedeac495271d0f","data":"0x70a082310000000000000000000000006E0d01A76C3Cf4288372a29124A26D4353EE51BE"}, "latest"],"id":1,"jsonrpc":"2.0"}'
Copy params: [
"0x407d73d8a49eeb85d32cf465507dd71d507100c1",
"latest", // state at the latest block
]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getTransactionCount","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1","latest"],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getTransactionCount","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1","latest"],"id":1}'
Copy [
{
"type": "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>",
"data": {
"authentication_key": "0x0000000000000000000000000000000000000000000000000000000000000001",
"coin_register_events": {
"counter": "0",
"guid": {
"id": {
"addr": "0x1",
"creation_num": "0"
}
}
},
"self_address": "0x1",
"sequence_number": "0"
}
}
]
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/resources HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy {
"type": "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>",
"data": {
"authentication_key": "0x0000000000000000000000000000000000000000000000000000000000000001",
"coin_register_events": {
"counter": "0",
"guid": {
"id": {
"addr": "0x1",
"creation_num": "0"
}
}
},
"self_address": "0x1",
"sequence_number": "0"
}
}
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/resource/{resource_type} HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy [
{
"bytecode": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"abi": {
"address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"name": "text",
"friends": [
"0x1::aptos_coin"
],
"exposed_functions": [
{
"name": "text",
"visibility": "private",
"is_entry": true,
"generic_type_params": [
{
"constraints": [
"text"
]
}
],
"params": [
"text"
],
"return": [
"text"
]
}
],
"structs": [
{
"name": "text",
"is_native": true,
"abilities": [
"text"
],
"generic_type_params": [
{
"constraints": [
"text"
]
}
],
"fields": [
{
"name": "text",
"type": "text"
}
]
}
]
}
}
]
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/modules HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy [
{
"version": "32425224034",
"guid": {
"creation_number": "32425224034",
"account_address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
},
"sequence_number": "32425224034",
"type": "text",
"data": null
}
]
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/events/{creation_number} HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy [
{
"version": "32425224034",
"guid": {
"creation_number": "32425224034",
"account_address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
},
"sequence_number": "32425224034",
"type": "text",
"data": null
}
]
Copy GET /v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/events/{event_handle}/{field_name} HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*
Copy [
{
"version": "32425224034",
"hash": "text",
"state_change_hash": "text",
"event_root_hash": "text",
"state_checkpoint_hash": "text",
"gas_used": "32425224034",
"success": true,
"vm_status": "text",
"accumulator_root_hash": "text",
"changes": [
{
"type": "delete_module",
"address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"state_key_hash": "text",
"module": "0x1::aptos_coin"
}
],
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
},
"events": [
{
"guid": {
"creation_number": "32425224034",
"account_address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
},
"sequence_number": "32425224034",
"type": "text",
"data": null
}
],
"timestamp": "32425224034"
}
]
Copy POST /v1/<YOUR_API_KEY_HERE>/v1/transactions/simulate HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Content-Type: application/json
Accept: */*
Content-Length: 546
{
"sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"sequence_number": "32425224034",
"max_gas_amount": "32425224034",
"gas_unit_price": "32425224034",
"expiration_timestamp_secs": "32425224034",
"payload": {
"type": "entry_function_payload",
"function": "0x1::aptos_coin::transfer",
"type_arguments": [
"text"
],
"arguments": []
},
"signature": {
"type": "ed25519_signature",
"public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getUncleByBlockHashAndIndex","params":["0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b", "0x0"],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getUncleByBlockHashAndIndex","params":["0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b", "0x0"],"id":1}'
Copy params: [
"0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b",
"0x0", // 0
]
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_newFilter","params":[{"topics":["0x12341234"]}],"id":73}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_newFilter","params":[{"topics":["0x12341234"]}],"id":73}'
Copy params: [
{
fromBlock: "0x1",
toBlock: "0x2",
address: "0x8888f1f195afa192cfee860698584c030f4c9db1",
topics: [
"0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b",
null,
[
"0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b",
"0x0000000000000000000000000aff3454fce5edbc8cca8697c15331677e6ebccc",
],
],
},
]
Copy // Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Copy curl https://mainnet.avalanche.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ext/bc/C/rpc \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockByHash","params":["0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae", false],"id":1}'
Copy curl https://fuji.avalanche.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ext/bc/C/rpc \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockByHash","params":["0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae", false],"id":1}'
Copy params: [
"0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae",
false,
]
Copy // Result
{
"id":83,
"jsonrpc": "2.0",
"result": "0x2abfcdcfa71e54e"
}
Copy curl https://mainnet.avalanche.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ext/bc/C/rpc \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["0x1b4", true],"id":1}'
Copy curl https://fuji.avalanche.validationcloud.io/v1/<YOUR_API_KEY_HERE>/ext/bc/C/rpc \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["0x1b4", true],"id":1}'
Copy params: [
"0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae",
false,
] eth_getBlockByHash Returns information about a block by hash.
This method will use 40 Compute Units .
DATA, 32 Bytes - Hash of a block.
Boolean - If true it returns the full transaction objects, if false only the hashes of the transactions are returned.
Object - A block object, or null when no block was found:
number: QUANTITY - the block number. null when its pending block.
hash: DATA, 32 Bytes - hash of the block. null when its pending block.
eth_getFilterLogs Returns an array of all logs matching filter with given id.
This method will use 40 Compute Units .
QUANTITY - the filter id.
Array - Array of log objects, or an empty array if nothing has changed since last poll.
For filters created with eth_newBlockFilter the return are block hashes (DATA, 32 Bytes), e.g. ["0x3454645634534..."].
For filters created with eth_newPendingTransactionFilter the return are transaction hashes (DATA, 32 Bytes), e.g. ["0x6345343454645..."]
eth_getFilterChanges Polling method for a filter, which returns an array of logs which occurred since last poll.
This method will use 40 Compute Units .
QUANTITY - the filter id.
Array - Array of log objects, or an empty array if nothing has changed since last poll.
For filters created with eth_newBlockFilter the return are block hashes (DATA, 32 Bytes), e.g. ["0x3454645634534..."].
For filters created with eth_newPendingTransactionFilter the return are transaction hashes (DATA, 32 Bytes), e.g. ["0x6345343454645..."]
eth_getTransactionByBlockNumberAndIndex Returns information about a transaction by block number and transaction index position.
This method will use 40 Compute Units .
QUANTITY|TAG - a block number, or the string "earliest", "latest" or "pending", as in the .
QUANTITY - the transaction index position.
Object - A transaction object, or null when no transaction was found:
blockHash: DATA, 32 Bytes - hash of the block where this transaction was in. null when its pending.
blockNumber: QUANTITY - block number where this transaction was in. null when its pending.
eth_getTransactionByHash Returns the information about a transaction requested by transaction hash.
This method will use 40 Compute Units .
DATA, 32 Bytes - hash of a transaction
Object - A transaction object, or null when no transaction was found:
blockHash: DATA, 32 Bytes - hash of the block where this transaction was in. null when its pending.
blockNumber: QUANTITY - block number where this transaction was in. null when its pending.
eth_subscribe Returns an object with data about the sync status or false.
This method will use 20 Compute Units .
subscription name - string - The type of event you want to subscribe to (i.e. newHeads or logs ). This method supports the following subscription types:
newHeads - Fires a notification each time a new header is appended to the chain, including chain reorganizations.
logs - Returns logs that are included in new imported blocks and match the given filter criteria.
data - object - (Optional) - Arguments such as an address, multiple addresses, and topics. Note, only logs that are created from these addresses or match the specified topics will return logs.
result - string - Hex encoded subscription ID. This ID will be attached to all received events and can also be used to cancel the subscription using .
debug_traceBlockByNumber Returns the possible tracing result number by executing all transactions in the block specified by the block number with a tracer.
This method will use 80 Compute Units .
blockNumber - String - Required - The block number as a string in hexadecimal format.
object - Object - Required - The tracer object with the following fields:
tracer - String - The type of tracer, options are: callTracer orprestateTracer.
callTracer - String - The callTracer keeps track of all call frames, including depth - calls, that are made during a transaction.
result - An array of transaction objects for that block, each containing:
txHash - The transaction hash of the transaction
result - An object containing detailed information about the traced transaction
beforeEVMTransfers - An array representing EVM transfers that occurred before the execution of the transaction
debug_traceTransaction Returns all traces of a given transaction.
This method will use 80 Compute Units .
transactionHash - String - Required - The transaction hash to be traced.
object - Object - Required - The tracer object with the following fields:
tracer - String - The type of tracer, options are: callTracer or prestateTracer.
callTracer - String - The callTracer keeps track of all call frames, including depth - calls, that are made during a transaction.
result - An array of transaction objects for that block, each containing:
txHash - The transaction hash of the transaction
result - An object containing detailed information about the traced transaction
beforeEVMTransfers - An array representing EVM transfers that occurred before the execution of the transaction
net_listening Returns true if client is actively listening for network connections.
This method will use 10 Compute Units .
None
Boolean - true when listening, otherwise false.
eth_getLogs Returns an array of all logs matching a given filter object.
This method will use 80 .
Development Centre | Support FAQ's Welcome to the Validation Cloud Support FAQ. This page provides answers to common questions about our infrastructure, APIs, supported networks, performance, billing, and service operations. Whether you’re troubleshooting an issue, looking for best practices, or seeking clarification on our offerings, you’ll find helpful guidance here. If your question isn’t covered, our support team is always available to assist.
Infrastructure & Availability
chevron-right Do you offer Multi-AZ deployment? eth_getTransactionByBlockHashAndIndex Returns information about a transaction by block hash and transaction index position.
This method will use 40 .
hashtag
Yes, Multi-AZ deployments are leveraged where supported to improve resiliency and fault tolerance.
chevron-right How is high availability handled? hashtag Our infrastructure is distributed across multiple regions with load balancing, automated failover, and continuous health monitoring.
chevron-right How do you handle traffic spikes? hashtag We use scalable infrastructure with dynamic resource allocation and intelligent workload distribution to maintain performance during peak demand.
chevron-right Where can I check service status? hashtag Live status, uptime metrics, and incidents are available at
https://status.validationcloud.io/
chevron-right Where are your nodes located, and which chains have archive support? hashtag We operate globally distributed infrastructure across major regions. Archive availability varies by network. Please refer to chain-specific documentation or contact support for details.
chevron-right Which networks do you support? hashtag chevron-right Do you support archive nodes? hashtag Yes, archive nodes are available on supported networks. Historical depth varies by chain.
chevron-right What is the difference between a full node and an archive node? hashtag A full node maintains current state and recent history. An archive node stores complete historical state from genesis for deep historical queries.
chevron-right How far back does historical data go? hashtag Historical data availability varies by network. Please consult chain-specific documentation for details.
chevron-right Do you support WebSocket connections? hashtag Yes, WebSocket support is network-dependent. Refer to the relevant chain documentation.
chevron-right Do you support batch JSON-RPC requests? hashtag Yes, batch JSON-RPC is supported where the network and endpoint allow it.
chevron-right Do you support txpool methods? hashtag Yes, where mempool functionality is exposed. Example documentation:
https://docs.validationcloud.io/v1/mezo/execution-api/txpool_content
chevron-right Do you support Ethereum Beacon RPC? hashtag Yes, we do support Beacon RPC.
chevron-right Can I upgrade or change plans? hashtag Yes, plans can be upgraded or modified through your dashboard or by contacting our team.
chevron-right How is usage calculated? hashtag Usage is calculated based on total monthly Compute Unit consumption, which varies by network and RPC method.
chevron-right What happens if my payment fails? hashtag We retry the payment method on file. If it continues to fail, our team will contact you. Continued non-payment may result in API key suspension.
chevron-right Are you SOC 2 compliant? hashtag Yes, Validation Cloud is SOC 2 compliant, maintaining rigorous standards for security and operational integrity.
chevron-right Is traffic encrypted? hashtag Yes, all traffic is encrypted in transit using TLS.
chevron-right How is customer data handled? hashtag We apply strict access controls, encryption, monitoring, and security best practices aligned with SOC 2 standards.
chevron-right How is infrastructure secured? hashtag We employ layered security controls including network segmentation, access management, monitoring, and proactive threat detection.
chevron-right Do you offer private endpoints? hashtag Yes, private endpoints are available depending on network and configuration. Please contact our team for details.
chevron-right Do you throttle or rate-limit requests? hashtag We do not impose arbitrary throttling. Some networks may enforce protocol-level limits.
chevron-right What should I do if my API key is exposed? hashtag Immediately revoke and rotate the key in your dashboard. Contact support if suspicious activity is detected.
chevron-right How do I rotate or regenerate my API key? hashtag API keys can be revoked and regenerated from your dashboard.
chevron-right How do I create an API key? hashtag API keys can be generated from your dashboard under project or API settings.
chevron-right How do I reach out for Support queries hashtag Click on the "Help" icon in the bottom left from your admin page.
chevron-right Solana Staking Rewards Reporting API hashtag For information on Solana staking rewards reporting APIs, refer to staking documentation or contact our team.
The information on this page is provided for general informational purposes only and does not constitute a legally binding agreement. Service features, availability, historical retention, and infrastructure configurations may vary by network, region, and plan.
Binding commitments, including SLAs and performance guarantees, are governed solely by the applicable service agreement.
Validation Cloud reserves the right to update services and documentation without prior notice.
parentHash: DATA, 32 Bytes - hash of the parent block.
nonce: DATA, 8 Bytes - hash of the generated proof-of-work. null when its pending block.
sha3Uncles: DATA, 32 Bytes - SHA3 of the uncles data in the block.
logsBloom: DATA, 256 Bytes - the bloom filter for the logs of the block. null when its pending block.
transactionsRoot: DATA, 32 Bytes - the root of the transaction trie of the block.
stateRoot: DATA, 32 Bytes - the root of the final state trie of the block.
receiptsRoot: DATA, 32 Bytes - the root of the receipts trie of the block.
miner: DATA, 20 Bytes - the address of the beneficiary to whom the mining rewards were given.
difficulty: QUANTITY - integer of the difficulty for this block.
totalDifficulty: QUANTITY - integer of the total difficulty of the chain until this block.
extraData: DATA - the "extra data" field of this block.
size: QUANTITY - integer the size of this block in bytes.
gasLimit: QUANTITY - the maximum gas allowed in this block.
gasUsed: QUANTITY - the total used gas by all transactions in this block.
timestamp: QUANTITY - the unix timestamp for when the block was collated.
transactions: Array - Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
uncles: Array - Array of uncle hashes.
.
For filters created with eth_newFilter logs are objects with following params:
removed: TAG - true when the log was removed, due to a chain reorganization. false if its a valid log.
logIndex: QUANTITY - integer of the log index position in the block. null when its pending log.
transactionIndex: QUANTITY - integer of the transactions index position log was created from. null when its pending log.
transactionHash: DATA, 32 Bytes - hash of the transactions this log was created from. null when its pending log.
blockHash: DATA, 32 Bytes - hash of the block where this log was in. null when its pending. null when its pending log.
blockNumber: QUANTITY - the block number where this log was in. null when its pending. null when its pending log.
address: DATA, 20 Bytes - address from which this log originated.
data: DATA - contains one or more 32 Bytes non-indexed arguments of the log.
topics: Array of DATA - Array of 0 to 4 32 Bytes DATA of indexed log arguments. (In solidity : The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)), except you declared the event with the anonymous specifier.)
.
For filters created with eth_newFilter logs are objects with following params:
removed: TAG - true when the log was removed, due to a chain reorganization. false if its a valid log.
logIndex: QUANTITY - integer of the log index position in the block. null when its pending log.
transactionIndex: QUANTITY - integer of the transactions index position log was created from. null when its pending log.
transactionHash: DATA, 32 Bytes - hash of the transactions this log was created from. null when its pending log.
blockHash: DATA, 32 Bytes - hash of the block where this log was in. null when its pending. null when its pending log.
blockNumber: QUANTITY - the block number where this log was in. null when its pending. null when its pending log.
address: DATA, 20 Bytes - address from which this log originated.
data: DATA - contains one or more 32 Bytes non-indexed arguments of the log.
topics: Array of DATA - Array of 0 to 4 32 Bytes DATA of indexed log arguments. (In solidity : The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)), except you declared the event with the anonymous specifier.)
from: DATA, 20 Bytes - address of the sender.
gas: QUANTITY - gas provided by the sender.
gasPrice: QUANTITY - gas price provided by the sender in Wei.
hash: DATA, 32 Bytes - hash of the transaction.
input: DATA - the data send along with the transaction.
nonce: QUANTITY - the number of transactions made by the sender prior to this one.
to: DATA, 20 Bytes - address of the receiver. null when its a contract creation transaction.
transactionIndex: QUANTITY - integer of the transactions index position in the block. null when its pending.
value: QUANTITY - value transferred in Wei.
v: QUANTITY - ECDSA recovery id
r: QUANTITY - ECDSA signature r
s: QUANTITY - ECDSA signature s
from: DATA, 20 Bytes - address of the sender.
gas: QUANTITY - gas provided by the sender.
gasPrice: QUANTITY - gas price provided by the sender in Wei.
hash: DATA, 32 Bytes - hash of the transaction.
input: DATA - the data send along with the transaction.
nonce: QUANTITY - the number of transactions made by the sender prior to this one.
to: DATA, 20 Bytes - address of the receiver. null when its a contract creation transaction.
transactionIndex: QUANTITY - integer of the transactions index position in the block. null when its pending.
value: QUANTITY - value transferred in Wei.
v: QUANTITY - ECDSA recovery id
r: QUANTITY - ECDSA signature r
s: QUANTITY - ECDSA signature s
prestateTracer - String - The prestateTracer replays the transaction and tracks every part of state that occurred during the transaction.
tracerConfig - Object (Optional) - The object to specify the configurations of the tracer.
onlyTopCall - Boolean - When set to true, this will only trace the primary (top-level) call and not any sub-calls. It eliminates the additional processing for each call frame.
purpose - (Optional) The purpose of the EVM transfer
from - (Optional) The Ethereum address initiating the transfer
to - (Optional) The Ethereum address receiving the transfer
value - (Optional) The value of the transfer, specified in hexadecimal format (Wei)
afterEVMTransfers - An array representing EVM transfers that occurred after the execution of the transaction
Optional fields are the same as beforeEVMTransfers above
from - The address the transaction is sent from.
gas - The integer of the gas provided for the transaction execution.
gasUsed - The integer of the gas used.
to - The address the transaction is directed to.
input - The data given at the time of input.
value - The integer of the value sent with this transaction.
calls - A list of sub-calls.
prestateTracer - String - The prestateTracer replays the transaction and tracks every part of state that occurred during the transaction.
tracerConfig - Object (Optional) - The object to specify the configurations of the tracer.
onlyTopCall - Boolean - When set to true, this will only trace the primary (top-level) call and not any sub-calls. It eliminates the additional processing for each call frame.
timeout - String (Optional) - A string of decimal integers that overrides the JavaScript-based tracing calls default timeout of 5 seconds. Example: 10s for 10 seconds.
purpose - (Optional) The purpose of the EVM transfer
from - (Optional) The Ethereum address initiating the transfer
to - (Optional) The Ethereum address receiving the transfer
value - (Optional) The value of the transfer, specified in hexadecimal format (Wei)
afterEVMTransfers - An array representing EVM transfers that occurred after the execution of the transaction
Optional fields are the same as beforeEVMTransfers above
from - The address the transaction is sent from.
gas - The integer of the gas provided for the transaction execution.
gasUsed - The integer of the gas used.
to - The address the transaction is directed to.
input - The data given at the time of input.
value - The integer of the value sent with this transaction.
calls - A list of sub-calls.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X POST \
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"net_listening","params":[],"id":67} '
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/ < YOUR_API_KEY_HER E > \
-X POST \
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"net_listening","params":[],"id":67} '
DATA, 32 Bytes - hash of a block.
QUANTITY - integer of the transaction index position.
Object - A transaction object, or null when no transaction was found:
blockHash: DATA, 32 Bytes - hash of the block where this transaction was in. null when its pending.
blockNumber: QUANTITY - block number where this transaction was in. null when its pending.
from: DATA, 20 Bytes - address of the sender.
gas: QUANTITY - gas provided by the sender.
gasPrice: QUANTITY - gas price provided by the sender in Wei.
hash: DATA, 32 Bytes - hash of the transaction.
input: DATA - the data send along with the transaction.
nonce: QUANTITY - the number of transactions made by the sender prior to this one.
to: DATA, 20 Bytes - address of the receiver. null when its a contract creation transaction.
transactionIndex: QUANTITY - integer of the transactions index position in the block. null when its pending.
value: QUANTITY - value transferred in Wei.
v: QUANTITY - ECDSA recovery id
r: QUANTITY - ECDSA signature r
s: QUANTITY - ECDSA signature s
Copy params: [
"0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae",
false,
]
Copy // Result
{
"id":83,
"jsonrpc": "2.0",
"result": "0x2abfcdcfa71e54e"
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockByHash","params":["0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae", false],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockByHash","params":["0x98f37278176977ec9ae5b25ff751bf06f86075b85dd63900c93894b4817256e8", false],"id":1}'
Copy params:
[
"0x16", // 22
]
Copy // Result
{
"id":1,
"jsonrpc":"2.0",
"result": [{
"logIndex": "0x1", // 1
"blockNumber":"0x1b4", // 436
"blockHash": "0x8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcfdf829c5a142f1fccd7d",
"transactionHash": "0xdf829c5a142f1fccd7d8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcf",
"transactionIndex": "0x0", // 0
"address": "0x16c5785ac562ff41e2dcfdf829c5a142f1fccd7d",
"data":"0x0000000000000000000000000000000000000000000000000000000000000000",
"topics": ["0x59ebeb90bc63057b6515673c3ecf9438e5058bca0f92585014eced636878c9a5"]
},{
...
}]
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getFilterLogs","params":["0x16"],"id":74}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getFilterLogs","params":["0x16"],"id":74}'
Copy params:
[
"0x16", // 22
]
Copy // Result
{
"id":1,
"jsonrpc":"2.0",
"result": [{
"logIndex": "0x1", // 1
"blockNumber":"0x1b4", // 436
"blockHash": "0x8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcfdf829c5a142f1fccd7d",
"transactionHash": "0xdf829c5a142f1fccd7d8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcf",
"transactionIndex": "0x0", // 0
"address": "0x16c5785ac562ff41e2dcfdf829c5a142f1fccd7d",
"data":"0x0000000000000000000000000000000000000000000000000000000000000000",
"topics": ["0x59ebeb90bc63057b6515673c3ecf9438e5058bca0f92585014eced636878c9a5"]
},{
...
}]
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getFilterChanges","params":["0x16"],"id":73}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getFilterChanges","params":["0x16"],"id":73}'
Copy params: [
"0x29c", // 668
"0x0", // 0
]
Copy // Result
{
"jsonrpc":"2.0",
"id":1,
"result":{
"blockHash":"0x1d59ff54b1eb26b013ce3cb5fc9dab3705b415a67127a003c3e61eb445bb8df2",
"blockNumber":"0x5daf3b", // 6139707
"from":"0xa7d9ddbe1f17865597fbd27ec712455208b6b76d",
"gas":"0xc350", // 50000
"gasPrice":"0x4a817c800", // 20000000000
"hash":"0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b",
"input":"0x68656c6c6f21",
"nonce":"0x15", // 21
"to":"0xf02c1c8e6114b1dbe8937a39260b5b0a374432bb",
"transactionIndex":"0x41", // 65
"value":"0xf3dbb76162000", // 4290000000000000
"v":"0x25", // 37
"r":"0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea",
"s":"0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c"
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getTransactionByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getTransactionByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1}'
Copy params: ["0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b"]
Copy // Result
{
"jsonrpc":"2.0",
"id":1,
"result":{
"blockHash":"0x1d59ff54b1eb26b013ce3cb5fc9dab3705b415a67127a003c3e61eb445bb8df2",
"blockNumber":"0x5daf3b", // 6139707
"from":"0xa7d9ddbe1f17865597fbd27ec712455208b6b76d",
"gas":"0xc350", // 50000
"gasPrice":"0x4a817c800", // 20000000000
"hash":"0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b",
"input":"0x68656c6c6f21",
"nonce":"0x15", // 21
"to":"0xf02c1c8e6114b1dbe8937a39260b5b0a374432bb",
"transactionIndex":"0x41", // 65
"value":"0xf3dbb76162000", // 4290000000000000
"v":"0x25", // 37
"r":"0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea",
"s":"0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c"
}
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getTransactionByHash","params":["0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b"],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getTransactionByHash","params":["0x2ba8341449280a993edf80402ec1549933e95c3ae8fbcf6a072c31e9cd364ffe"],"id":1}'
Copy params: [
"0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",
]
Copy // Result
{"id":1,"result":"0x9a52eeddc2b289f985c0e23a7d8427c8","jsonrpc":"2.0"}
//Example
{
"jsonrpc":"2.0",
"method":"eth_subscription",
"params":{
"result":{
"blockHash":null,
"blockNumber":null,
"from":"0xa36452fc31f6f482ad823cd1cf5515177d57667f",
"gas":"0x1adb0",
"gasPrice":"0x7735c4d40",
"hash":"0x50bff0736c713458c92dd1848d12f3354149be1363123dae35e94e0f2a9d56bf",
"input":"0xa9059cbb0000000000000000000000000d0707963952f2fba59dd06f2b425ace40b492fe0000000000000000000000000000000000000000000015b1111266cfca100000",
"nonce":"0x0",
"to":"0xea38eaa3c86c8f9b751533ba2e562deb9acded40",
"transactionIndex":null,
"value":"0x0",
"v":"0x26",
"r":"0x195c2c1ed126088e12d290aa93541677d3e3b1d10f137e11f86b1b9227f01e3b",
"s":"0x60fc4edbf1527832a2a36dbc1e63ed6193a6eee654472fbebbf88ef1750b5344"},
"subscription":"0x9a52eeddc2b289f985c0e23a7d8427c8"
}
}
Copy wscat -c wss:///mainnet.arbitrum.validationcloud.io/v1/wss/<YOUR_API_KEY_HERE>
# wait for connection
# request
{"jsonrpc": "2.0", "id": 1, "method":"eth_subscribe","params":["newHeads"]}
# response
{"jsonrpc":"2.0","result":"0x5302037dae412a3454143512a3c7617b","id":1}
Copy wscat -c wss:///sepolia.arbitrum.validationcloud.io/v1/wss/<YOUR_API_KEY_HERE>
# wait for connection
# request
{"jsonrpc": "2.0", "id": 1, "method":"eth_subscribe","params":["newHeads"]}
# response
{"jsonrpc":"2.0","result":"0x5302037dae412a3454143512a3c7617b","id":1}
Copy // Result
{
"jsonrpc": "2.0",
"result": [
{
"txHash": "0xd11b0067cf4fb01858ea76e545871667de8c7f877e0bba812725d38e6887ce2a",
"result": {
"beforeEVMTransfers": [],
"afterEVMTransfers": [],
"from": "0x00000000000000000000000000000000000a4b05",
"gas": "0x0",
"gasUsed": "0x0",
"to": "0x00000000000000000000000000000000000a4b05",
"input": "0x6bf6a42d000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000013d23bb000000000000000000000000000000000000000000000000000000000f34b2d70000000000000000000000000000000000000000000000000000000000000000",
"value": "0x0",
"type": "CALL"
}
},
{
"txHash": "0x69f5fcbd690d97665637a62b101c29db2d5cd444682599746d6078b42b2c5e10",
"result": {
"beforeEVMTransfers": [
{
"purpose": "feePayment",
"from": "0x4DF13106b8DFa90b4D7A9485274a5fD23CC02Fa0",
"to": null,
"value": "0x939d1582280"
}
],
"afterEVMTransfers": [
{
"purpose": "gasRefund",
"from": null,
"to": "0x4DF13106b8DFa90b4D7A9485274a5fD23CC02Fa0",
"value": "0x2cf78501500"
},
{
"purpose": "feeCollection",
"from": null,
"to": "0xbF5041Fc07E1c866D15c749156657B8eEd0fb649",
"value": "0x1bcd50edb00"
},
{
"purpose": "feeCollection",
"from": null,
"to": "0xa4B00000000000000000000000000000000000F6",
"value": "0x4ad83f93280"
}
],
"from": "0x4df13106b8dfa90b4d7a9485274a5fd23cc02fa0",
"gas": "0xf7a79",
"gasUsed": "0xac367",
"to": "0x89d43d991f47924dd47c9b6a7fa17c6a15091999",
"input": ...
...
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0", "method":"debug_traceBlockByNumber","params":["0xf34b2d7", {"tracer": "callTracer"}],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0", "method":"debug_traceBlockByNumber","params":["0x4e4fffb", {"tracer": "callTracer"}],"id":1}'
Copy // Result
{
"jsonrpc": "2.0",
"result": {
"beforeEVMTransfers": [
{
"purpose": "feePayment",
"from": "0xa95B83af96d0B8A90BD507f2Bd82aD8F3dbb86BC",
"to": null,
"value": "0xb5e620f48000"
}
],
"afterEVMTransfers": [
{
"purpose": "gasRefund",
"from": null,
"to": "0xa95B83af96d0B8A90BD507f2Bd82aD8F3dbb86BC",
"value": "0xb4e7359e1e80"
},
{
"purpose": "feeCollection",
"from": null,
"to": "0xbF5041Fc07E1c866D15c749156657B8eEd0fb649",
"value": "0x30e4f9b400"
},
{
"purpose": "feeCollection",
"from": null,
"to": "0xa4B00000000000000000000000000000000000F6",
"value": "0xce065cad80"
}
],
"from": "0xa95b83af96d0b8a90bd507f2bd82ad8f3dbb86bc",
"gas": "0x1312d00",
"gasUsed": "0x1abaf",
"to": "0x28d4d5ecdfde97ffc3d70ea9cf985cd7b833a1b1",
"input": "0x",
"value": "0x4e28e2290f0000",
"type": "CALL"
},
"id": 1
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"debug_traceTransaction","params":["0x8c09e1f80fecf242ac01e93200217f8a199a01e2258db49ab380d045eeab27a5", {"tracer": "callTracer"}],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"debug_traceTransaction","params":["0xcd14a4f427bedcd4beb2eb091422851925170f1790a26bdf6689d2a618d2d843", {"tracer": "callTracer"}],"id":1}'
Copy // Result
{
"id":67,
"jsonrpc":"2.0",
"result":true
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getTransactionByBlockHashAndIndex","params":["0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b", "0x0"],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getTransactionByBlockHashAndIndex","params":["0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b", "0x0"],"id":1}'
Copy params: [
"0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",
"0x0", // 0
]
Copy // Result
{
"jsonrpc":"2.0",
"id":1,
"result":{
"blockHash":"0x1d59ff54b1eb26b013ce3cb5fc9dab3705b415a67127a003c3e61eb445bb8df2",
"blockNumber":"0x5daf3b", // 6139707
"from":"0xa7d9ddbe1f17865597fbd27ec712455208b6b76d",
"gas":"0xc350", // 50000
"gasPrice":"0x4a817c800", // 20000000000
"hash":"0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b",
"input":"0x68656c6c6f21",
"nonce":"0x15", // 21
"to":"0xf02c1c8e6114b1dbe8937a39260b5b0a374432bb",
"transactionIndex":"0x41", // 65
"value":"0xf3dbb76162000", // 4290000000000000
"v":"0x25", // 37
"r":"0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea",
"s":"0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c"
} Object - The filter options:
fromBlock: QUANTITY|TAG - (optional, default: "latest") Integer block number, or "latest" for the last mined block or "pending", "earliest" for not yet mined transactions.
toBlock: QUANTITY|TAG - (optional, default: "latest") Integer block number, or "latest" for the last mined block or "pending", "earliest" for not yet mined transactions.
address: DATA|Array, 20 Bytes - (optional) Contract address or a list of addresses from which logs should originate.
topics: Array of DATA, - (optional) Array of 32 Bytes DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with "or" options.
blockhash: DATA, 32 Bytes - (optional, future ) With the addition of EIP-234, blockHash will be a new filter option which restricts the logs returned to the single block with the 32-byte hash blockHash. Using blockHash is equivalent to fromBlock = toBlock = the block number with hash blockHash. If blockHash
Array - Array of log objects, or an empty array if nothing has changed since last poll.
For filters created with eth_newBlockFilter the return are block hashes (DATA, 32 Bytes), e.g. ["0x3454645634534..."].
For filters created with eth_newPendingTransactionFilter the return are transaction hashes (DATA, 32 Bytes), e.g. ["0x6345343454645..."].
For filters created with eth_newFilter logs are objects with following params:
removed: TAG - true when the log was removed, due to a chain reorganization. false if its a valid log.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getLogs","params":[{"topics":["0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b"]}],"id":74}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getLogs","params":[{"topics":["0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b"]}],"id":74}'
Copy params: [
{
topics: [
"0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b",
],
},
]
Copy // Result
{
"id":1,
"jsonrpc":"2.0",
"result": [{
"logIndex": "0x1", // 1
"blockNumber":"0x1b4", // 436
"blockHash": "0x8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcfdf829c5a142f1fccd7d",
"transactionHash": "0xdf829c5a142f1fccd7d8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcf",
"transactionIndex": "0x0", // 0
"address": "0x16c5785ac562ff41e2dcfdf829c5a142f1fccd7d",
"data":"0x0000000000000000000000000000000000000000000000000000000000000000",
"topics": ["0x59ebeb90bc63057b6515673c3ecf9438e5058bca0f92585014eced636878c9a5"]
},{
...
}]
} debug_traceBlockByHash Returns the possible tracing result number by executing all transactions in the block specified by the block hash with a tracer.
This method will use 80 Compute Units .
blockHash - String - Required - The block hash.
object - Object - Required - The tracer object with the following fields:
tracer - String - The type of tracer, options are: callTracer orprestateTracer.
callTracer - String - The callTracer keeps track of all call frames, including depth - calls, that are made during a transaction.
result - An array of transaction objects for that block, each containing:
txHash - The transaction hash of the transaction
result - An object containing detailed information about the traced transaction
beforeEVMTransfers - An array representing EVM transfers that occurred before the execution of the transaction
Overview Arbitrum One is a Layer-2 scaling solution for Ethereum that uses optimistic rollups to enable faster and cheaper transactions while inheriting Ethereum’s security.
Fully compatible with the Ethereum Virtual Machine (EVM), Arbitrum One allows developers to deploy existing Ethereum dApps with minimal changes and benefit from greater scalability.
Block explorer:
Network Support
eth_getBlockByNumber Returns information about a block by block number.
This method will use 40 .
debug_traceCall Returns the number of possible tracing results by executing an eth call within the context of the given block execution.
This method will use 80 .
object - Object - The transaction call object with the following fields:
eth_getBalance Returns the balance of the account of given address.
This method will use 20 .
is present in in the filter criteria, then neither
fromBlock
nor
toBlock
are allowed.
logIndex: QUANTITY - integer of the log index position in the block. null when its pending log.
transactionIndex: QUANTITY - integer of the transactions index position log was created from. null when its pending log.
transactionHash: DATA, 32 Bytes - hash of the transactions this log was created from. null when its pending log.
blockHash: DATA, 32 Bytes - hash of the block where this log was in. null when its pending. null when its pending log.
blockNumber: QUANTITY - the block number where this log was in. null when its pending. null when its pending log.
address: DATA, 20 Bytes - address from which this log originated.
data: DATA - contains one or more 32 Bytes non-indexed arguments of the log.
topics: Array of DATA - Array of 0 to 4 32 Bytes DATA of indexed log arguments. (In solidity : The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)), except you declared the event with the anonymous specifier.)
prestateTracer - String - The prestateTracer replays the transaction and tracks every part of state that occurred during the transaction.
tracerConfig - Object (Optional) - The object to specify the configurations of the tracer.
onlyTopCall - Boolean - When set to true, this will only trace the primary (top-level) call and not any sub-calls. It eliminates the additional processing for each call frame.
purpose - (Optional) The purpose of the EVM transfer
from - (Optional) The Ethereum address initiating the transfer
to - (Optional) The Ethereum address receiving the transfer
value - (Optional) The value of the transfer, specified in hexadecimal format (Wei)
afterEVMTransfers - An array representing EVM transfers that occurred after the execution of the transaction
Optional fields are the same as beforeEVMTransfers above
from - The address the transaction is sent from.
gas - The integer of the gas provided for the transaction execution.
gasUsed - The integer of the gas used.
to - The address the transaction is directed to.
input - The data given at the time of input.
value - The integer of the value sent with this transaction.
calls - A list of sub-calls.
Boolean - If true it returns the full transaction objects, if false only the hashes of the transactions.
Object - A block object, or null when no block was found:
number: QUANTITY - the block number. null when its pending block.
hash: DATA, 32 Bytes - hash of the block. null when its pending block.
parentHash: DATA, 32 Bytes - hash of the parent block.
nonce: DATA, 8 Bytes - hash of the generated proof-of-work. null when its pending block.
sha3Uncles: DATA, 32 Bytes - SHA3 of the uncles data in the block.
logsBloom: DATA, 256 Bytes - the bloom filter for the logs of the block. null when its pending block.
transactionsRoot: DATA, 32 Bytes - the root of the transaction trie of the block.
stateRoot: DATA, 32 Bytes - the root of the final state trie of the block.
receiptsRoot: DATA, 32 Bytes - the root of the receipts trie of the block.
miner: DATA, 20 Bytes - the address of the beneficiary to whom the mining rewards were given.
difficulty: QUANTITY - integer of the difficulty for this block.
totalDifficulty: QUANTITY - integer of the total difficulty of the chain until this block.
extraData: DATA - the "extra data" field of this block.
size: QUANTITY - integer the size of this block in bytes.
gasLimit: QUANTITY - the maximum gas allowed in this block.
gasUsed: QUANTITY - the total used gas by all transactions in this block.
timestamp: QUANTITY - the unix timestamp for when the block was collated.
transactions: Array - Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
uncles: Array - Array of uncle hashes.
Copy // Result
{
"jsonrpc": "2.0",
"result": [
{
"txHash": "0x727340a318d712e723fa01c9a239572f2dfd83084e15dc2b882ba6e8e42ed35f",
"result": {
"beforeEVMTransfers": [],
"afterEVMTransfers": [],
"from": "0x00000000000000000000000000000000000a4b05",
"gas": "0x0",
"gasUsed": "0x0",
"to": "0x00000000000000000000000000000000000a4b05",
"input": "0x6bf6a42d000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000013d0d4b000000000000000000000000000000000000000000000000000000000f3082ac0000000000000000000000000000000000000000000000000000000000000000",
"value": "0x0",
"type": "CALL"
}
},
{
"txHash": "0xf257edd971c8aea7b9a59e03f6f15696f02cdb2908d4e5b6c3fa82ab3bc2966f",
"result": {
"beforeEVMTransfers": [
{
"purpose": "feePayment",
"from": "0x46DB4cC823d1a4ad2E07727b42a64Dd6d2F64B9D",
"to": null,
"value": "0x6b5cab97900"
}
],
"afterEVMTransfers": [
{
"purpose": "gasRefund",
"from": null,
"to": "0x46DB4cC823d1a4ad2E07727b42a64Dd6d2F64B9D",
"value": "0x512a1141c80"
},
{
"purpose": "feeCollection",
"from": null,
"to": "0xbF5041Fc07E1c866D15c749156657B8eEd0fb649",
"value": "0xae3d22cb80"
},
{
"purpose": "feeCollection",
"from": null,
"to": "0xa4B00000000000000000000000000000000000F6",
"value": "0xf4ec829100"
}
],
"from": "0x46db4cc823d1a4ad2e07727b42a64dd6d2f64b9d",
"gas": "0xb41fa",
"gasUsed": "0x2bf3d",
"to": "0x1f0ea3b63f3fca05719e54e7469ef897754ef666",
"input": "0x1589b24f000000000000000000000000000000000000000000000000000000000000000200000000000000000000000089060b31db21c6cb4e946eacb28efeff085c275a2847e7f2823a5048f4ae2cd808a5e978aa6ce41fcbb6e7e7bbbb1b64446b0639000000000000000000000000000000000000000000000000de0b6b3a76400000",
"calls": [
{
"from": "0x1f0ea3b63f3fca05719e54e7469ef897754ef666",
"gas": "0x7530",
"gasUsed": "0x0",
"to": "0x0000000000000000000000000000000000000000",
"input": "0x01ffc9a701ffc9a700000000000000000000000000000000000000000000000000000000",
"type": "STATICCALL"
},
{
"from": "0x1f0ea3b63f3fca05719e54e7469ef897754ef666",
"gas": "0x8a1c7",
"gasUsed": "0x4b83",
"to": "0xc352c711943941d608d0545ef2e6fe57d9e70155",
"input": "0xc94e66ef000000000000000000000000000000000000000000000000000000000000000200000000000000000000000089060b31db21c6cb4e946eacb28efeff085c275a000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000645217c5302847e7f2823a5048f4ae2cd808a5e978aa6ce41fcbb6e7e7bbbb1b64446b063900000000000000000000000046db4cc823d1a4ad2e07727b42a64dd6d2f64b9d000000000000000000000000000000000000000000000000de0b6b3a7640000000000000000000000000000000000000000000000000000000000000",
"output": "0x000000000000000000000000000000000000000000000000000000000001acb4",
"value": "0x0",
"type": "CALL"
}
],
"value": "0x0",
"type": "CALL"
}
},
...
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"debug_traceBlockByHash","params":["0x89f968e73472c656cbed1e084980e09b3ec06fbaa4b174b51f1cb60ac457ae99", {"tracer": "callTracer"}],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"debug_traceBlockByHash","params":["0x74d50bc463c2b56f48c7fa597d3b3167847f91b936fe6a30f2f3a48d8f85b193", {"tracer": "callTracer"}],"id":1}'
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["0x1b4", true],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["0x55946fd", true],"id":1}'
Copy params: [
"0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae",
false,
] Arbitrum One Testnet (Sepolia)
WebSocket clients MUST respond to server ping frames, otherwise the connection will be closed and re-established every minute.
from - String - The address the transaction is sent from
to - String - Required - The address the transaction is directed to
gas - Integer - The integer of the gas provided for the transaction execution
gasPrice - Integer - The integer of the gasPrice used for paid gas
value - Integer - The integer of the value sent with this transaction
data - String - The has of the method signature and encoded parameters
blockReference - String - Required - The block number in hexadecimal format, the block hash, or tags: "earliest", "latest" or "pending".
object - Object (Optional) - The tracer object with the following fields:
tracer - String - The type of tracer, options are: callTracer or prestateTracer.
callTracer - String - The callTracer keeps track of all call frames, including depth - calls, that are made during a transaction.
prestateTracer - String - The prestateTracer replays the transaction and tracks every part of state that occurred during the transaction.
tracerConfig - Object (Optional) - The object to specify the configurations of the tracer.
onlyTopCall - Boolean - When set to true, this will only trace the primary (top-level) call and not any sub-calls. It eliminates the additional processing for each call frame.
result - An array of transaction objects for that block, each containing:
txHash - The transaction hash of the transaction
result - An object containing detailed information about the traced transaction
beforeEVMTransfers - An array representing EVM transfers that occurred before the execution of the transaction
purpose - (Optional) The purpose of the EVM transfer
from - (Optional) The Ethereum address initiating the transfer
to - (Optional) The Ethereum address receiving the transfer
afterEVMTransfers - An array representing EVM transfers that occurred after the execution of the transaction
Optional fields are the same as beforeEVMTransfers above
from - The address the transaction is sent from.
gas - The integer of the gas provided for the transaction execution.
gasUsed - The integer of the gas used.
to - The address the transaction is directed to.
input - The data given at the time of input.
value - The integer of the value sent with this transaction.
calls - A list of sub-calls.
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"debug_traceCall","params":[{"from":null,"to":"0x6b175474e89094c44da98b954eedeac495271d0f","data":"0x70a082310000000000000000000000006E0d01A76C3Cf4288372a29124A26D4353EE51BE"}, "latest", {"tracer": "callTracer"}],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"debug_traceCall","params":[{"from":null,"to":"0x6b175474e89094c44da98b954eedeac495271d0f","data":"0x70a082310000000000000000000000006E0d01A76C3Cf4288372a29124A26D4353EE51BE"}, "latest"],"id":1}'
Copy // Result
{
"jsonrpc": "2.0",
"result": {
"beforeEVMTransfers": [
{
"purpose": "feePayment",
"from": "0x0000000000000000000000000000000000000000",
"to": null,
"value": "0x0"
}
],
"afterEVMTransfers": [
{
"purpose": "gasRefund",
"from": null,
"to": "0x0000000000000000000000000000000000000000",
"value": "0x0"
},
{
"purpose": "feeCollection",
"from": null,
"to": "0xbF5041Fc07E1c866D15c749156657B8eEd0fb649",
"value": "0x321626b400"
},
{
"purpose": "feeCollection",
"from": null,
"to": "0xa4B00000000000000000000000000000000000F6",
"value": "0x14184a66780"
}
],
"from": "0x0000000000000000000000000000000000000000",
"gas": "0x2fd41dd",
"gasUsed": "0x26f73",
"to": "0x16b5856dbc2f66d6dc5b361b0073f51ed5ffb52b",
"input": "0x727fa213619edc134b3c8b36e117a4b8e95cb5f7cd2330eab81aa241346ebe07",
"value": "0x0",
"type": "CALL"
},
"id": 1
} DATA, 20 Bytes - address to check for balance.
INTEGER - Hex value representing integer of the current balance in WEI.
Copy curl https://mainnet.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
Copy curl https://fuji.avalanche.validationcloud.io/v1/ < YOUR_API_KEY_HER E > /ext/bc/C/rpc \
Copy // Result
{
"id":83,
"jsonrpc": "2.0",
"result": "0x2abfcdcfa71e54e"
} Changelog Changes, additions and updates to Validation Cloud's products and infrastructure
Entries are ordered by date, newest first.
Changes, additions, and upgrades between April 28 and May 4, 2026
1 new chain | 19 client upgrades
Node Infrastructure
Updated World Chain Mainnet — op-geth to v1.101702.1, op-node to v1.16.10 (hardfork: Jovian)
Updated HashKey Chain, Ink, Metal L2, Mode, Soneium, and Superseed — op-reth to v2.2.0
Updated Lisk — op-reth to v2.2.0, op-node to v1.16.13-rc.1
Staking Infrastructure
Updated Ethereum validators — Lodestar to v1.42.0, Teku to v26.4.0, Nethermind to v1.37.0
Updated Monad Mainnet validator to v0.14.2
Updated Aptos validator to v1.43.3
Updated Canton validators to v0.6.1
Node API Capabilities
Fixed Avalanche WebSocket path handling
Web Application
Added detailed error code breakdown in Response Status chart (Node API)
Updated rate limit error label to display consistently as "Rate limited" (Node API)
Updated user account dropdown (Node API)
Changes, additions, and upgrades between April 21 and April 27, 2026
19 client upgrades
Node Infrastructure
Updated BNB Smart Chain — standard client to v1.7.2, reth client to v0.0.9-beta
Updated Cronos Mainnet to v1.7.5
Updated Fraxtal — op-geth to v1.101701.0-frax-1.3.0, op-node to v1.16.9-frax-1.2.1
Updated HashKey Chain, Ink, Lisk, Metal L2, Mode, Soneium, and Superseed — migrated to op-reth v2.0.0, op-node v1.16.12
Staking Infrastructure
Updated Ethereum web3signer to v26.4.1
Changes, additions, and upgrades between April 16 and April 20, 2026
7 client upgrades_
Node Infrastructure
Updated Base Sepolia to node-reth v0.15.4
Updated Berachain Mainnet bera-reth to v1.3.3
Updated Bitcoin Mainnet to v30.2
Updated Conflux Mainnet to v3.0.3
Staking Infrastructure
Added commit-boost multiplexer for EtherFi validators (v0.9.3)
Updated Solana Testnet validator to v4.0.0-beta.7-jito
Changes, additions, and upgrades between April 8 and April 15, 2026
18 client upgrades
Node Infrastructure
Updated Aptos Mainnet to v1.43.2
Updated Berachain Mainnet bera-reth to v1.3.2-2
Updated Gnosis Mainnet Lighthouse to v1.41.1, Nethermind to v1.36.2
Staking Infrastructure
Updated Aptos validator to v1.43.2
Updated Canton validators to v0.5.18
Updated Mezo Mainnet to v9.0.0 (hardfork)
Updated Solana Mainnet validator to v3.1.13
Node API Capabilities
Fixed Solana batch RPC rate limiting, batch calls no longer trigger per-call limits incorrectly
Updated cross-region failover, requests now properly retry when a node times out
Web Application
Fixed dashboard estimated bill displaying 100x actual value for paid customers (Node API)
Updated billing view for custom-contract customers, plan now shows as "Custom" with usage-only view (Node API)
Changes, additions, and upgrades between March 31 and April 6, 2026
7 client upgrades
Node Infrastructure
Added Nethermind v1.36.2 and Prysm v7.1.3 for Ethereum Mainnet (client diversity)
Updated Berachain Mainnet bera-reth to v1.3.2
Updated Merlin Mainnet cdk-erigon to v2.0.3
Updated Polygon Mainnet bor to v2.7.0
Staking Infrastructure
Updated Canton validator to v0.5.17
Updated Juno validator to v0.15.21
Updated Somnia Testnet validator
Web Application
Made it easier for first time users to make their first API call (Node API)
Redesigned endpoint detail page with full-width analytics, cURL/JS code examples, and docs links (Node API)
Updated endpoint metrics chart, fixed loading error (Node API)
Changes, additions, and upgrades between March 23 and March 30, 2026
28 client upgrades
Node Infrastructure
Updated Aptos Mainnet to v1.42.1
Updated BOB, Hashkey, Ink, Lisk, Metal, Mint, Mode, Soneium, Superseed, Unichain, Worldchain, Zora to OP Stack op-geth v1.101701.0, op-node v1.16.9
Updated Abstract, Cronos zkEVM, Lens, zkSync Era to ZK Stack node v29.14.0
Staking Infrastructure
Updated Canton validators to v0.5.16
Updated Ethereum Lighthouse to v8.1.3
Updated Mezo Mainnet validator to v8.0.0
Updated Mezo Testnet validator to v8.0.0-rc0
Web Application
Updated response status chart to show individual status codes for better debugging visibility (Node API)
Changes, additions, and upgrades between March 16 and March 23, 2026
1 new chain | 28 client upgrades
Node Infrastructure
Updated Base Mainnet reth to v0.14.8, op-node to v1.16.8, migrated to new infrastructure
Updated BOB, Unichain, Worldchain, Metal, Hashkey to OP Stack op-geth v1.101609.2, op-node v1.16.8
Updated Celo Mainnet to v2.2.1 (security patch)
Staking Infrastructure
Added Ethereum validators in Asia
Updated Canton validators to v0.5.15
Updated Ethereum Charon to v1.8.3
Updated Ethereum Commit Boost, switched to multiple relays
Node API Capabilities
Added eth_simulateV1 RPC method for all EVM chains
Added Tempo Mainnet and Tempo Testnet to Node API
Web Application
Added Tempo RPC code snippet for endpoints (Node API)
Added Tempo WebSocket support (Node API)
Updated chain list, sorted alphabetically by display name (Node API)
Changes, additions, and upgrades between March 9 and March 16, 2026
23 client upgrades
Node Infrastructure
Updated Abstract, zkSync Era, Lens to ZK Stack node v29.12.1-alpha
Updated Aptos Mainnet to v1.41.9-hotfix (security patch)
Updated Aptos Testnet to v1.41.8
Updated Arbitrum nitro node to v3.9.7 (security patch)
Staking Infrastructure
Updated Ethereum Charon to v1.9.2-rc1
Updated Ethereum Lighthouse to v8.1.2 (security patch)
Updated Solana Mainnet validator to v3.1.10 (security patch)
eth_getTransactionReceipt Returns the receipt of a transaction by transaction hash. Note that the receipt is not available for pending transactions.
This method will use 40 Compute Units .
DATA, 32 Bytes - hash of a transaction
Object - A transaction receipt object, or null when no receipt was found:
transactionHash : DATA, 32 Bytes - hash of the transaction.
transactionIndex: QUANTITY - integer of the transactions index position in the block.
value - (Optional) The value of the transfer, specified in hexadecimal format (Wei)
Updated Unichain Mainnet — op-reth to v2.1.0-rc.1
Updated Zora Mainnet — op-reth to v2.1.0-rc.1, op-node to v1.16.12
Updated ZetaChain to v38.0.3
Updated Ethereum Mainnet — Nethermind to v1.37.0
Updated Aptos Mainnet to v1.43.3
Updated Berachain Mainnet — beacon-kit to v1.3.8
Updated Monad Mainnet to v0.14.2
Removed Mint Mainnet (network shut down)
Updated Katana — op-geth to v1.101702.1, op-node to v1.16.9
Updated Pharos to v0.12.2
Updated Polygon Mainnet — Heimdall to v0.7.0, Bor to v2.7.2
Updated Sui Mainnet to v1.70.2
Updated Tempo Mainnet and Tempo Testnet to v1.6.0
Updated Unichain Mainnet, migrated to op-reth v1.11.5, op-node v1.16.12
Updated Zora Mainnet, migrated to op-reth v1.11.5, op-node v1.16.11
Updated Mantle Mainnet to v1.5.4
Updated Monad Mainnet to v0.14.1
Updated Pharos to v0.12.1
Updated Sei Mainnet to v6.4.1 (hardfork)
Updated Stellar core to v26.0.1, Horizon to v26.0.0
Updated Somnia Mainnet (hardfork)
Updated TAC Mainnet to v1.0.4
Updated Taiko Mainnet taiko-alethia-client to v2.3.0
Updated IOTA to v1.19.1 (hardfork)
Updated Stellar core to v25.2.2, Horizon to v25.1.0
Updated SUI Mainnet to v1.68.1
Updated Tempo Mainnet and Tempo Testnet to v1.5.0
Updated Solana Testnet validator to v4.0.0-beta.4
Updated Ethereum Mainnet reth to v1.11.3
Updated Monad Mainnet to v0.13.0
Updated Morph to v2.2.0 (security patch)
Updated Polygon Amoy bor to v2.7.0-beta2 (security patch)
Updated Polygon Mainnet, migrated to new infrastructure
Updated Somnia, migrated to new infrastructure
Updated Stellar core to v25.2.1
Updated Taiko geth to v1.17.4
Updated Mezo Mainnet validator to v7.0.0 (hardfork)
Updated Mezo Testnet validator to v7.0.0-rc0
Updated Avalanche Mainnet to v1.14.1
Updated Berachain beacon-kit to v1.3.7
Updated BSC Mainnet reth to v0.0.8-beta (security patch)
Updated BSC Testnet to v1.7.1 (security patch)
Updated Cronos Mainnet to v1.7.0
Updated Ethereum Lighthouse to v8.1.2 (security patch)
Updated Ethereum Sepolia geth to v1.17.1
Updated Fraxtal op-geth to v1.101609.0, op-node to v1.16.6
Updated Hedera to v0.149.0
Updated IOTA to v1.18.1 (hardfork, security patch)
Updated Kaia to v2.2.2 (security patch)
Updated Optimism Mainnet op-geth to v1.101609.2, op-node to v1.16.8
Updated Soneium, Mode, BOB, Zora, Mint to OP Stack op-geth v1.101609.2, op-node v1.16.8
Updated Solana Agave RPC to v3.1.10 (security patch)
Updated Sonic Mainnet to v2.1.6 (security patch)
Updated ZetaChain to v36.1.5
-X
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getBalance","params":["0x95abDa53Bc5E9fBBDce34603614018d32CED219e", "latest"],"id":1} '
-X
POST
\
-H " Content-Type: application/json " \
-d ' {"jsonrpc":"2.0","method":"eth_getBalance","params":["0x95abDa53Bc5E9fBBDce34603614018d32CED219e", "latest"],"id":1} '
eth_getBlockTransactionCountByHash
eth_getBlockTransactionCountByNumber
eth_getTransactionByBlockHashAndIndex
eth_getTransactionByBlockNumberAndIndex
eth_getTransactionReceipt
eth_getUncleByBlockHashAndIndex
eth_getUncleByBlockNumberAndIndex
eth_getUncleCountByBlockHash
eth_getUncleCountByBlockNumber
eth_newPendingTransactionFilter
blockHash: DATA, 32 Bytes - hash of the block where this transaction was in.
blockNumber: QUANTITY - block number where this transaction was in.
from: DATA, 20 Bytes - address of the sender.
to: DATA, 20 Bytes - address of the receiver. null when its a contract creation transaction.
cumulativeGasUsed : QUANTITY - The total amount of gas used when this transaction was executed in the block.
effectiveGasPrice : QUANTITY - The sum of the base fee and tip paid per unit of gas.
gasUsed : QUANTITY - The amount of gas used by this specific transaction alone.
contractAddress : DATA, 20 Bytes - The contract address created, if the transaction was a contract creation, otherwise null.
logs: Array - Array of log objects, which this transaction generated.
logsBloom: DATA, 256 Bytes - Bloom filter for light clients to quickly retrieve related logs.
type: DATA - integer of the transaction type, 0x00 for legacy transactions, 0x01 for access list types, 0x02 for dynamic fees. It also returns either :
root : DATA 32 bytes of post-transaction stateroot (pre Byzantium)
status: QUANTITY either 1 (success) or 0 (failure)
Copy params: ["0x85d995eba9763907fdf35cd2034144dd9d53ce32cbec21349d4b12823c6860c5"]
Copy // Result
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"blockHash":
"0xa957d47df264a31badc3ae823e10ac1d444b098d9b73d204c40426e57f47e8c3",
"blockNumber": "0xeff35f",
"contractAddress": null, // string of the address if it was created
"cumulativeGasUsed": "0xa12515",
"effectiveGasPrice": "0x5a9c688d4",
"from": "0x6221a9c005f6e47eb398fd867784cacfdcfff4e7",
"gasUsed": "0xb4c8",
"logs": [{
// logs as returned by getFilterLogs, etc.
}],
"logsBloom": "0x00...0", // 256 byte bloom filter
"status": "0x1",
"to": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
"transactionHash":
"0x85d995eba9763907fdf35cd2034144dd9d53ce32cbec21349d4b12823c6860c5",
"transactionIndex": "0x66",
"type": "0x2"
}
Copy curl https://mainnet.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getTransactionReceipt","params":["0x85d995eba9763907fdf35cd2034144dd9d53ce32cbec21349d4b12823c6860c5"],"id":1}'
Copy curl https://sepolia.arbitrum.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_getTransactionReceipt","params":["0x85d995eba9763907fdf35cd2034144dd9d53ce32cbec21349d4b12823c6860c5"],"id":1}'
WebSocket clients MUST respond to server ping frames, otherwise the connection will be closed and re-established every minute.
eth_getBlockTransactionCountByHash
eth_getBlockTransactionCountByNumber
eth_getTransactionByBlockHashAndIndex
eth_getTransactionByBlockNumberAndIndex
eth_getTransactionReceipt
eth_getUncleByBlockHashAndIndex
eth_getUncleByBlockNumberAndIndex
eth_getUncleCountByBlockHash
eth_getUncleCountByBlockNumber
eth_newPendingTransactionFilter
platform.getpendingvalidators
platform.getstakingassetid
platform.samplevalidators