Get blocks by height

GET 
/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

Request

Path Parameters

block_height uint64required

Block height to lookup. Starts at 0

Query Parameters

with_transactions boolean

If set to true, include all transactions in the block

If not provided, no transactions will be retrieved

Responses

200

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

• X-APTOS-CURSOR

  string

  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.

application/json

Schema

Schema

block_height uint64required

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.

block_hash HashValue (string)required
block_timestamp uint64required

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.

first_version uint64required

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.

last_version uint64required

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.

transactions

object[]

The transactions in the block in sequential order

Array [

oneOf

Transaction_PendingTransaction

type stringrequired

Possible values: [pending_transaction]

hash HashValue (string)required

sender hexrequired

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.

sequence_number uint64required

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.

max_gas_amount uint64required

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.

gas_unit_price uint64required

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.

expiration_timestamp_secs uint64required

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.

payload

object

required

An enum of the possible transaction payloads

oneOf

TransactionPayload_EntryFunctionPayload

Payload which runs a single entry function

type stringrequired

Possible values: [entry_function_payload]

function EntryFunctionId (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.

type_arguments MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Type arguments of the function

arguments arrayrequired

Arguments of the function

TransactionPayload_ScriptPayload

Payload which runs a script that can run multiple functions

type stringrequired

Possible values: [script_payload]

code

object

required

Move script bytecode

bytecode hexrequired

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.

abi

object

Move function

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

type_arguments MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Type arguments of the function

arguments arrayrequired

Arguments of the function

TransactionPayload_DeprecatedModuleBundlePayload

type stringrequired

Possible values: [module_bundle_payload]

TransactionPayload_MultisigPayload

A multisig transaction that allows an owner of a multisig account to execute a pre-approved transaction as the multisig account.

type stringrequired

Possible values: [multisig_payload]

multisig_address hexrequired

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.

transaction_payload

object

oneOf

MultisigTransactionPayload_EntryFunctionPayload

Payload which runs a single entry function

type stringrequired

Possible values: [entry_function_payload]

function EntryFunctionId (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.

type_arguments MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Type arguments of the function

arguments arrayrequired

Arguments of the function

signature

object

An enum representing the different transaction signatures available

oneOf

TransactionSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

TransactionSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

TransactionSignature_MultiAgentSignature

Multi agent signature for multi agent transactions

This allows you to have transactions across multiple accounts

type stringrequired

Possible values: [multi_agent_signature]

sender

object

required

Account signature scheme

The account signature scheme allows you to have two types of accounts:

1. A single Ed25519 key account, one private key

2. A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.

3. A single Secp256k1Ecdsa key account, one private key

oneOf

AccountSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

AccountSignature_SingleKeySignature

A single key signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

AccountSignature_MultiKeySignature

A multi key signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

type stringrequired

Possible values: [no_account_signature]

secondary_signer_addresses hex[]required

The other involved parties' addresses

secondary_signers

object[]

required

The associated signatures, in the same order as the secondary addresses

Array [

oneOf

AccountSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

AccountSignature_SingleKeySignature

A single key signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

AccountSignature_MultiKeySignature

A multi key signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

type stringrequired

Possible values: [no_account_signature]

]

TransactionSignature_FeePayerSignature

Fee payer signature for fee payer transactions

This allows you to have transactions across multiple accounts and with a fee payer

type stringrequired

Possible values: [fee_payer_signature]

sender

object

required

Account signature scheme

The account signature scheme allows you to have two types of accounts:

1. A single Ed25519 key account, one private key

2. A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.

3. A single Secp256k1Ecdsa key account, one private key

oneOf

AccountSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

AccountSignature_SingleKeySignature

A single key signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

AccountSignature_MultiKeySignature

A multi key signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

type stringrequired

Possible values: [no_account_signature]

secondary_signer_addresses hex[]required

The other involved parties' addresses

secondary_signers

object[]

required

The associated signatures, in the same order as the secondary addresses

Array [

oneOf

AccountSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

AccountSignature_SingleKeySignature

A single key signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

AccountSignature_MultiKeySignature

A multi key signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

type stringrequired

Possible values: [no_account_signature]

]

fee_payer_address hexrequired

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.

fee_payer_signer

object

required

Account signature scheme

The account signature scheme allows you to have two types of accounts:

1. A single Ed25519 key account, one private key

2. A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.

3. A single Secp256k1Ecdsa key account, one private key

oneOf

AccountSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

AccountSignature_SingleKeySignature

A single key signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

AccountSignature_MultiKeySignature

A multi key signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

type stringrequired

Possible values: [no_account_signature]

TransactionSignature_AccountSignature

Account signature scheme

The account signature scheme allows you to have two types of accounts:

1. A single Ed25519 key account, one private key

2. A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.

3. A single Secp256k1Ecdsa key account, one private key

type

string

required

Possible values: [ed25519_signature, multi_ed25519_signature, single_key_signature, multi_key_signature, no_account_signature]

ed25519_signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

multi_ed25519_signature

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

single_key_signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

multi_key_signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

no_account_signature

type stringrequired

Possible values: [no_account_signature]

Transaction_UserTransaction

type stringrequired

Possible values: [user_transaction]

version uint64required

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.

hash HashValue (string)required

state_change_hash HashValue (string)required

event_root_hash HashValue (string)required

state_checkpoint_hash HashValue (string)

gas_used uint64required

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.

success booleanrequired

Whether the transaction was successful

vm_status stringrequired

The VM status of the transaction, can tell useful information in a failure

accumulator_root_hash HashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

type stringrequired

Possible values: [delete_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

module MoveModuleId (string)required

Move module id is a string representation of Move module.

Format: {address}::{module name}

address should be hex-encoded 32 byte account address that is prefixed with 0x.

Module name is case-sensitive.

WriteSetChange_DeleteResource

Delete a resource

type stringrequired

Possible values: [delete_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

resource MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

WriteSetChange_DeleteTableItem

Delete a table item

type stringrequired

Possible values: [delete_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

data

object

Deleted table data

key required

Deleted key

key_type stringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

type stringrequired

Possible values: [write_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecode hexrequired

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.

abi

object

A Move module

address hexrequired

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.

name IdentifierWrapper (string)required

friends MoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

]

structs

object[]

required

Structs of the module

Array [

name IdentifierWrapper (string)required

is_native booleanrequired

Whether the struct is a native struct of Move

is_event booleanrequired

Whether the struct is marked with the #[event] annotation

abilities MoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraints MoveAbility (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

Array [

name IdentifierWrapper (string)required

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

type stringrequired

Possible values: [write_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

A parsed Move resource

type MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

data objectrequired

This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.

To clarify, you might query for 0x1::account::Account and see the example data.

Move bool type value is serialized into boolean.

Move u8, u16 and u32 type value is serialized into integer.

Move u64, u128 and u256 type value is serialized into string.

Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example:

• 0x1
• 0x1668f6be25668c1a17cd8caf6b8d2f25

Move vector type value is serialized into array, except vector<u8> which is serialized into a HexEncodedBytes string with 0x prefix. For example:

• vector<u64>{255, 255} => ["255", "255"]
• vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

{
  field1_name: field1_value,
  field2_name: field2_value,
  ......
}

For example: { "created": "0xa550c18", "role_id": "0" }

Special serialization for Move stdlib types:

• 0x1::string::String is serialized into string. For example, struct value 0x1::string::String{bytes: b"Hello World!"} is serialized as "Hello World!" in JSON.

WriteSetChange_WriteTableItem

Change set to write a table item

type stringrequired

Possible values: [write_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

value hexrequired

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.

data

object

Decoded table data

key required

Key of table in JSON

key_type stringrequired

Type of key

value required

Value of table in JSON

value_type stringrequired

Type of value

]

sender hexrequired

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.

sequence_number uint64required

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.

max_gas_amount uint64required

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.

gas_unit_price uint64required

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.

expiration_timestamp_secs uint64required

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.

payload

object

required

An enum of the possible transaction payloads

oneOf

TransactionPayload_EntryFunctionPayload

Payload which runs a single entry function

type stringrequired

Possible values: [entry_function_payload]

function EntryFunctionId (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.

type_arguments MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Type arguments of the function

arguments arrayrequired

Arguments of the function

TransactionPayload_ScriptPayload

Payload which runs a script that can run multiple functions

type stringrequired

Possible values: [script_payload]

code

object

required

Move script bytecode

bytecode hexrequired

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.

abi

object

Move function

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

type_arguments MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Type arguments of the function

arguments arrayrequired

Arguments of the function

TransactionPayload_DeprecatedModuleBundlePayload

type stringrequired

Possible values: [module_bundle_payload]

TransactionPayload_MultisigPayload

A multisig transaction that allows an owner of a multisig account to execute a pre-approved transaction as the multisig account.

type stringrequired

Possible values: [multisig_payload]

multisig_address hexrequired

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.

transaction_payload

object

oneOf

MultisigTransactionPayload_EntryFunctionPayload

Payload which runs a single entry function

type stringrequired

Possible values: [entry_function_payload]

function EntryFunctionId (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.

type_arguments MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Type arguments of the function

arguments arrayrequired

Arguments of the function

signature

object

An enum representing the different transaction signatures available

oneOf

TransactionSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

TransactionSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

TransactionSignature_MultiAgentSignature

Multi agent signature for multi agent transactions

This allows you to have transactions across multiple accounts

type stringrequired

Possible values: [multi_agent_signature]

sender

object

required

Account signature scheme

The account signature scheme allows you to have two types of accounts:

1. A single Ed25519 key account, one private key

2. A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.

3. A single Secp256k1Ecdsa key account, one private key

oneOf

AccountSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

AccountSignature_SingleKeySignature

A single key signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

AccountSignature_MultiKeySignature

A multi key signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

type stringrequired

Possible values: [no_account_signature]

secondary_signer_addresses hex[]required

The other involved parties' addresses

secondary_signers

object[]

required

The associated signatures, in the same order as the secondary addresses

Array [

oneOf

AccountSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

AccountSignature_SingleKeySignature

A single key signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

AccountSignature_MultiKeySignature

A multi key signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

type stringrequired

Possible values: [no_account_signature]

]

TransactionSignature_FeePayerSignature

Fee payer signature for fee payer transactions

This allows you to have transactions across multiple accounts and with a fee payer

type stringrequired

Possible values: [fee_payer_signature]

sender

object

required

Account signature scheme

The account signature scheme allows you to have two types of accounts:

1. A single Ed25519 key account, one private key

2. A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.

3. A single Secp256k1Ecdsa key account, one private key

oneOf

AccountSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

AccountSignature_SingleKeySignature

A single key signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

AccountSignature_MultiKeySignature

A multi key signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

type stringrequired

Possible values: [no_account_signature]

secondary_signer_addresses hex[]required

The other involved parties' addresses

secondary_signers

object[]

required

The associated signatures, in the same order as the secondary addresses

Array [

oneOf

AccountSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

AccountSignature_SingleKeySignature

A single key signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

AccountSignature_MultiKeySignature

A multi key signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

type stringrequired

Possible values: [no_account_signature]

]

fee_payer_address hexrequired

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.

fee_payer_signer

object

required

Account signature scheme

The account signature scheme allows you to have two types of accounts:

1. A single Ed25519 key account, one private key

2. A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.

3. A single Secp256k1Ecdsa key account, one private key

oneOf

AccountSignature_Ed25519Signature

A single Ed25519 signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

AccountSignature_SingleKeySignature

A single key signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

AccountSignature_MultiKeySignature

A multi key signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

type stringrequired

Possible values: [no_account_signature]

TransactionSignature_AccountSignature

Account signature scheme

The account signature scheme allows you to have two types of accounts:

1. A single Ed25519 key account, one private key

2. A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.

3. A single Secp256k1Ecdsa key account, one private key

type

string

required

Possible values: [ed25519_signature, multi_ed25519_signature, single_key_signature, multi_key_signature, no_account_signature]

ed25519_signature

type stringrequired

Possible values: [ed25519_signature]

public_key hexrequired

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.

signature hexrequired

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.

multi_ed25519_signature

type stringrequired

Possible values: [multi_ed25519_signature]

public_keys hex[]required

The public keys for the Ed25519 signature

signatures hex[]required

Signature associated with the public keys in the same order

threshold uint8required

The number of signatures required for a successful transaction

bitmap hexrequired

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.

single_key_signature

type stringrequired

Possible values: [single_key_signature]

public_key

object

required

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

multi_key_signature

type stringrequired

Possible values: [multi_key_signature]

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

PublicKey_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

PublicKey_Secp256r1Ecdsa

type stringrequired

Possible values: [secp256r1_ecdsa]

value hexrequired

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.

PublicKey_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

PublicKey_FederatedKeyless

type stringrequired

Possible values: [federated_keyless]

value hexrequired

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.

]

signatures

object[]

required

Array [

index uint8required

signature

object

required

oneOf

Signature_Ed25519

type stringrequired

Possible values: [ed25519]

value hexrequired

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.

Signature_Secp256k1Ecdsa

type stringrequired

Possible values: [secp256k1_ecdsa]

value hexrequired

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.

Signature_WebAuthn

type stringrequired

Possible values: [web_authn]

value hexrequired

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.

Signature_Keyless

type stringrequired

Possible values: [keyless]

value hexrequired

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.

]

signatures_required uint8required

no_account_signature

type stringrequired

Possible values: [no_account_signature]

events

object[]

required

Events generated by the transaction

Array [

guid

object

required

creation_number uint64required

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.

account_address hexrequired

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.

sequence_number uint64required

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.

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

data required

The JSON representation of the event

]

timestamp uint64required

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.

Transaction_GenesisTransaction

type stringrequired

Possible values: [genesis_transaction]

version uint64required

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.

hash HashValue (string)required

state_change_hash HashValue (string)required

event_root_hash HashValue (string)required

state_checkpoint_hash HashValue (string)

gas_used uint64required

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.

success booleanrequired

Whether the transaction was successful

vm_status stringrequired

The VM status of the transaction, can tell useful information in a failure

accumulator_root_hash HashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

type stringrequired

Possible values: [delete_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

module MoveModuleId (string)required

Move module id is a string representation of Move module.

Format: {address}::{module name}

address should be hex-encoded 32 byte account address that is prefixed with 0x.

Module name is case-sensitive.

WriteSetChange_DeleteResource

Delete a resource

type stringrequired

Possible values: [delete_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

resource MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

WriteSetChange_DeleteTableItem

Delete a table item

type stringrequired

Possible values: [delete_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

data

object

Deleted table data

key required

Deleted key

key_type stringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

type stringrequired

Possible values: [write_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecode hexrequired

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.

abi

object

A Move module

address hexrequired

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.

name IdentifierWrapper (string)required

friends MoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

]

structs

object[]

required

Structs of the module

Array [

name IdentifierWrapper (string)required

is_native booleanrequired

Whether the struct is a native struct of Move

is_event booleanrequired

Whether the struct is marked with the #[event] annotation

abilities MoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraints MoveAbility (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

Array [

name IdentifierWrapper (string)required

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

type stringrequired

Possible values: [write_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

A parsed Move resource

type MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

data objectrequired

This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.

To clarify, you might query for 0x1::account::Account and see the example data.

Move bool type value is serialized into boolean.

Move u8, u16 and u32 type value is serialized into integer.

Move u64, u128 and u256 type value is serialized into string.

Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example:

• 0x1
• 0x1668f6be25668c1a17cd8caf6b8d2f25

Move vector type value is serialized into array, except vector<u8> which is serialized into a HexEncodedBytes string with 0x prefix. For example:

• vector<u64>{255, 255} => ["255", "255"]
• vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

{
  field1_name: field1_value,
  field2_name: field2_value,
  ......
}

For example: { "created": "0xa550c18", "role_id": "0" }

Special serialization for Move stdlib types:

• 0x1::string::String is serialized into string. For example, struct value 0x1::string::String{bytes: b"Hello World!"} is serialized as "Hello World!" in JSON.

WriteSetChange_WriteTableItem

Change set to write a table item

type stringrequired

Possible values: [write_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

value hexrequired

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.

data

object

Decoded table data

key required

Key of table in JSON

key_type stringrequired

Type of key

value required

Value of table in JSON

value_type stringrequired

Type of value

]

payload

object

required

The writeset payload of the Genesis transaction

oneOf

GenesisPayload_WriteSetPayload

A writeset payload, used only for genesis

type stringrequired

Possible values: [write_set_payload]

write_set

object

required

The associated writeset with a payload

oneOf

WriteSet_ScriptWriteSet

type stringrequired

Possible values: [script_write_set]

execute_as hexrequired

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.

script

object

required

Payload which runs a script that can run multiple functions

code

object

required

Move script bytecode

bytecode hexrequired

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.

abi

object

Move function

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

type_arguments MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Type arguments of the function

arguments arrayrequired

Arguments of the function

WriteSet_DirectWriteSet

type stringrequired

Possible values: [direct_write_set]

changes

object[]

required

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

type stringrequired

Possible values: [delete_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

module MoveModuleId (string)required

Move module id is a string representation of Move module.

Format: {address}::{module name}

address should be hex-encoded 32 byte account address that is prefixed with 0x.

Module name is case-sensitive.

WriteSetChange_DeleteResource

Delete a resource

type stringrequired

Possible values: [delete_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

resource MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

WriteSetChange_DeleteTableItem

Delete a table item

type stringrequired

Possible values: [delete_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

data

object

Deleted table data

key required

Deleted key

key_type stringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

type stringrequired

Possible values: [write_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecode hexrequired

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.

abi

object

A Move module

address hexrequired

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.

name IdentifierWrapper (string)required

friends MoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

]

structs

object[]

required

Structs of the module

Array [

name IdentifierWrapper (string)required

is_native booleanrequired

Whether the struct is a native struct of Move

is_event booleanrequired

Whether the struct is marked with the #[event] annotation

abilities MoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraints MoveAbility (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

Array [

name IdentifierWrapper (string)required

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

type stringrequired

Possible values: [write_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

A parsed Move resource

type MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

data objectrequired

This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.

To clarify, you might query for 0x1::account::Account and see the example data.

Move bool type value is serialized into boolean.

Move u8, u16 and u32 type value is serialized into integer.

Move u64, u128 and u256 type value is serialized into string.

Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example:

• 0x1
• 0x1668f6be25668c1a17cd8caf6b8d2f25

Move vector type value is serialized into array, except vector<u8> which is serialized into a HexEncodedBytes string with 0x prefix. For example:

• vector<u64>{255, 255} => ["255", "255"]
• vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

{
  field1_name: field1_value,
  field2_name: field2_value,
  ......
}

For example: { "created": "0xa550c18", "role_id": "0" }

Special serialization for Move stdlib types:

• 0x1::string::String is serialized into string. For example, struct value 0x1::string::String{bytes: b"Hello World!"} is serialized as "Hello World!" in JSON.

WriteSetChange_WriteTableItem

Change set to write a table item

type stringrequired

Possible values: [write_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

value hexrequired

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.

data

object

Decoded table data

key required

Key of table in JSON

key_type stringrequired

Type of key

value required

Value of table in JSON

value_type stringrequired

Type of value

]

events

object[]

required

Array [

guid

object

required

creation_number uint64required

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.

account_address hexrequired

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.

sequence_number uint64required

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.

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

data required

The JSON representation of the event

]

events

object[]

required

Events emitted during genesis

Array [

guid

object

required

creation_number uint64required

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.

account_address hexrequired

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.

sequence_number uint64required

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.

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

data required

The JSON representation of the event

]

Transaction_BlockMetadataTransaction

type stringrequired

Possible values: [block_metadata_transaction]

version uint64required

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.

hash HashValue (string)required

state_change_hash HashValue (string)required

event_root_hash HashValue (string)required

state_checkpoint_hash HashValue (string)

gas_used uint64required

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.

success booleanrequired

Whether the transaction was successful

vm_status stringrequired

The VM status of the transaction, can tell useful information in a failure

accumulator_root_hash HashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

type stringrequired

Possible values: [delete_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

module MoveModuleId (string)required

Move module id is a string representation of Move module.

Format: {address}::{module name}

address should be hex-encoded 32 byte account address that is prefixed with 0x.

Module name is case-sensitive.

WriteSetChange_DeleteResource

Delete a resource

type stringrequired

Possible values: [delete_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

resource MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

WriteSetChange_DeleteTableItem

Delete a table item

type stringrequired

Possible values: [delete_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

data

object

Deleted table data

key required

Deleted key

key_type stringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

type stringrequired

Possible values: [write_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecode hexrequired

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.

abi

object

A Move module

address hexrequired

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.

name IdentifierWrapper (string)required

friends MoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

]

structs

object[]

required

Structs of the module

Array [

name IdentifierWrapper (string)required

is_native booleanrequired

Whether the struct is a native struct of Move

is_event booleanrequired

Whether the struct is marked with the #[event] annotation

abilities MoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraints MoveAbility (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

Array [

name IdentifierWrapper (string)required

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

type stringrequired

Possible values: [write_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

A parsed Move resource

type MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

data objectrequired

This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.

To clarify, you might query for 0x1::account::Account and see the example data.

Move bool type value is serialized into boolean.

Move u8, u16 and u32 type value is serialized into integer.

Move u64, u128 and u256 type value is serialized into string.

Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example:

• 0x1
• 0x1668f6be25668c1a17cd8caf6b8d2f25

Move vector type value is serialized into array, except vector<u8> which is serialized into a HexEncodedBytes string with 0x prefix. For example:

• vector<u64>{255, 255} => ["255", "255"]
• vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

{
  field1_name: field1_value,
  field2_name: field2_value,
  ......
}

For example: { "created": "0xa550c18", "role_id": "0" }

Special serialization for Move stdlib types:

• 0x1::string::String is serialized into string. For example, struct value 0x1::string::String{bytes: b"Hello World!"} is serialized as "Hello World!" in JSON.

WriteSetChange_WriteTableItem

Change set to write a table item

type stringrequired

Possible values: [write_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

value hexrequired

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.

data

object

Decoded table data

key required

Key of table in JSON

key_type stringrequired

Type of key

value required

Value of table in JSON

value_type stringrequired

Type of value

]

id HashValue (string)required

epoch uint64required

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.

round uint64required

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.

events

object[]

required

The events emitted at the block creation

Array [

guid

object

required

creation_number uint64required

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.

account_address hexrequired

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.

sequence_number uint64required

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.

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

data required

The JSON representation of the event

]

previous_block_votes_bitvec uint8[]required

Previous block votes

proposer hexrequired

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.

failed_proposer_indices uint32[]required

The indices of the proposers who failed to propose

timestamp uint64required

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.

Transaction_StateCheckpointTransaction

type stringrequired

Possible values: [state_checkpoint_transaction]

version uint64required

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.

hash HashValue (string)required

state_change_hash HashValue (string)required

event_root_hash HashValue (string)required

state_checkpoint_hash HashValue (string)

gas_used uint64required

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.

success booleanrequired

Whether the transaction was successful

vm_status stringrequired

The VM status of the transaction, can tell useful information in a failure

accumulator_root_hash HashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

type stringrequired

Possible values: [delete_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

module MoveModuleId (string)required

Move module id is a string representation of Move module.

Format: {address}::{module name}

address should be hex-encoded 32 byte account address that is prefixed with 0x.

Module name is case-sensitive.

WriteSetChange_DeleteResource

Delete a resource

type stringrequired

Possible values: [delete_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

resource MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

WriteSetChange_DeleteTableItem

Delete a table item

type stringrequired

Possible values: [delete_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

data

object

Deleted table data

key required

Deleted key

key_type stringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

type stringrequired

Possible values: [write_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecode hexrequired

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.

abi

object

A Move module

address hexrequired

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.

name IdentifierWrapper (string)required

friends MoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

]

structs

object[]

required

Structs of the module

Array [

name IdentifierWrapper (string)required

is_native booleanrequired

Whether the struct is a native struct of Move

is_event booleanrequired

Whether the struct is marked with the #[event] annotation

abilities MoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraints MoveAbility (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

Array [

name IdentifierWrapper (string)required

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

type stringrequired

Possible values: [write_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

A parsed Move resource

type MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

data objectrequired

This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.

To clarify, you might query for 0x1::account::Account and see the example data.

Move bool type value is serialized into boolean.

Move u8, u16 and u32 type value is serialized into integer.

Move u64, u128 and u256 type value is serialized into string.

Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example:

• 0x1
• 0x1668f6be25668c1a17cd8caf6b8d2f25

Move vector type value is serialized into array, except vector<u8> which is serialized into a HexEncodedBytes string with 0x prefix. For example:

• vector<u64>{255, 255} => ["255", "255"]
• vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

{
  field1_name: field1_value,
  field2_name: field2_value,
  ......
}

For example: { "created": "0xa550c18", "role_id": "0" }

Special serialization for Move stdlib types:

• 0x1::string::String is serialized into string. For example, struct value 0x1::string::String{bytes: b"Hello World!"} is serialized as "Hello World!" in JSON.

WriteSetChange_WriteTableItem

Change set to write a table item

type stringrequired

Possible values: [write_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

value hexrequired

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.

data

object

Decoded table data

key required

Key of table in JSON

key_type stringrequired

Type of key

value required

Value of table in JSON

value_type stringrequired

Type of value

]

timestamp uint64required

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.

Transaction_BlockEpilogueTransaction

type stringrequired

Possible values: [block_epilogue_transaction]

version uint64required

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.

hash HashValue (string)required

state_change_hash HashValue (string)required

event_root_hash HashValue (string)required

state_checkpoint_hash HashValue (string)

gas_used uint64required

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.

success booleanrequired

Whether the transaction was successful

vm_status stringrequired

The VM status of the transaction, can tell useful information in a failure

accumulator_root_hash HashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

type stringrequired

Possible values: [delete_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

module MoveModuleId (string)required

Move module id is a string representation of Move module.

Format: {address}::{module name}

address should be hex-encoded 32 byte account address that is prefixed with 0x.

Module name is case-sensitive.

WriteSetChange_DeleteResource

Delete a resource

type stringrequired

Possible values: [delete_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

resource MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

WriteSetChange_DeleteTableItem

Delete a table item

type stringrequired

Possible values: [delete_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

data

object

Deleted table data

key required

Deleted key

key_type stringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

type stringrequired

Possible values: [write_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecode hexrequired

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.

abi

object

A Move module

address hexrequired

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.

name IdentifierWrapper (string)required

friends MoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

]

structs

object[]

required

Structs of the module

Array [

name IdentifierWrapper (string)required

is_native booleanrequired

Whether the struct is a native struct of Move

is_event booleanrequired

Whether the struct is marked with the #[event] annotation

abilities MoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraints MoveAbility (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

Array [

name IdentifierWrapper (string)required

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

type stringrequired

Possible values: [write_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

A parsed Move resource

type MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

data objectrequired

This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.

To clarify, you might query for 0x1::account::Account and see the example data.

Move bool type value is serialized into boolean.

Move u8, u16 and u32 type value is serialized into integer.

Move u64, u128 and u256 type value is serialized into string.

Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example:

• 0x1
• 0x1668f6be25668c1a17cd8caf6b8d2f25

Move vector type value is serialized into array, except vector<u8> which is serialized into a HexEncodedBytes string with 0x prefix. For example:

• vector<u64>{255, 255} => ["255", "255"]
• vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

{
  field1_name: field1_value,
  field2_name: field2_value,
  ......
}

For example: { "created": "0xa550c18", "role_id": "0" }

Special serialization for Move stdlib types:

• 0x1::string::String is serialized into string. For example, struct value 0x1::string::String{bytes: b"Hello World!"} is serialized as "Hello World!" in JSON.

WriteSetChange_WriteTableItem

Change set to write a table item

type stringrequired

Possible values: [write_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

value hexrequired

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.

data

object

Decoded table data

key required

Key of table in JSON

key_type stringrequired

Type of key

value required

Value of table in JSON

value_type stringrequired

Type of value

]

timestamp uint64required

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.

block_end_info

object

block_gas_limit_reached booleanrequired

block_output_limit_reached booleanrequired

block_effective_block_gas_units uint64required

block_approx_output_size uint64required

Transaction_ValidatorTransaction

oneOf

ValidatorTransaction_JWKUpdateTransaction

validator_transaction_type stringrequired

Possible values: [observed_jwk_update]

version uint64required

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.

hash HashValue (string)required

state_change_hash HashValue (string)required

event_root_hash HashValue (string)required

state_checkpoint_hash HashValue (string)

gas_used uint64required

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.

success booleanrequired

Whether the transaction was successful

vm_status stringrequired

The VM status of the transaction, can tell useful information in a failure

accumulator_root_hash HashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

type stringrequired

Possible values: [delete_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

module MoveModuleId (string)required

Move module id is a string representation of Move module.

Format: {address}::{module name}

address should be hex-encoded 32 byte account address that is prefixed with 0x.

Module name is case-sensitive.

WriteSetChange_DeleteResource

Delete a resource

type stringrequired

Possible values: [delete_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

resource MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

WriteSetChange_DeleteTableItem

Delete a table item

type stringrequired

Possible values: [delete_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

data

object

Deleted table data

key required

Deleted key

key_type stringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

type stringrequired

Possible values: [write_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecode hexrequired

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.

abi

object

A Move module

address hexrequired

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.

name IdentifierWrapper (string)required

friends MoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

]

structs

object[]

required

Structs of the module

Array [

name IdentifierWrapper (string)required

is_native booleanrequired

Whether the struct is a native struct of Move

is_event booleanrequired

Whether the struct is marked with the #[event] annotation

abilities MoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraints MoveAbility (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

Array [

name IdentifierWrapper (string)required

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

type stringrequired

Possible values: [write_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

A parsed Move resource

type MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

data objectrequired

This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.

To clarify, you might query for 0x1::account::Account and see the example data.

Move bool type value is serialized into boolean.

Move u8, u16 and u32 type value is serialized into integer.

Move u64, u128 and u256 type value is serialized into string.

Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example:

• 0x1
• 0x1668f6be25668c1a17cd8caf6b8d2f25

Move vector type value is serialized into array, except vector<u8> which is serialized into a HexEncodedBytes string with 0x prefix. For example:

• vector<u64>{255, 255} => ["255", "255"]
• vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

{
  field1_name: field1_value,
  field2_name: field2_value,
  ......
}

For example: { "created": "0xa550c18", "role_id": "0" }

Special serialization for Move stdlib types:

• 0x1::string::String is serialized into string. For example, struct value 0x1::string::String{bytes: b"Hello World!"} is serialized as "Hello World!" in JSON.

WriteSetChange_WriteTableItem

Change set to write a table item

type stringrequired

Possible values: [write_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

value hexrequired

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.

data

object

Decoded table data

key required

Key of table in JSON

key_type stringrequired

Type of key

value required

Value of table in JSON

value_type stringrequired

Type of value

]

events

object[]

required

Array [

guid

object

required

creation_number uint64required

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.

account_address hexrequired

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.

sequence_number uint64required

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.

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

data required

The JSON representation of the event

]

timestamp uint64required

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.

quorum_certified_update

object

required

A more API-friendly representation of the on-chain aptos_types::jwks::QuorumCertifiedUpdate.

update

object

required

A more API-friendly representation of the on-chain aptos_types::jwks::ProviderJWKs.

issuer stringrequired

version uint64required

jwks

object[]

required

Array [

anyOf

RSA_JWK

Move type 0x1::jwks::RSA_JWK in rust. See its doc in Move for more details.

kid stringrequired

kty stringrequired

alg stringrequired

e stringrequired

n stringrequired

UnsupportedJWK

Move type 0x1::jwks::UnsupportedJWK in rust. See its doc in Move for more details.

id uint8[]required

payload uint8[]required

]

multi_sig

object

required

A more API-friendly representation of the on-chain aptos_types::aggregate_signature::AggregateSignature.

signer_indices uint64[]required

sig hex

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.

ValidatorTransaction_DKGResultTransaction

validator_transaction_type stringrequired

Possible values: [dkg_result]

version uint64required

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.

hash HashValue (string)required

state_change_hash HashValue (string)required

event_root_hash HashValue (string)required

state_checkpoint_hash HashValue (string)

gas_used uint64required

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.

success booleanrequired

Whether the transaction was successful

vm_status stringrequired

The VM status of the transaction, can tell useful information in a failure

accumulator_root_hash HashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

type stringrequired

Possible values: [delete_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

module MoveModuleId (string)required

Move module id is a string representation of Move module.

Format: {address}::{module name}

address should be hex-encoded 32 byte account address that is prefixed with 0x.

Module name is case-sensitive.

WriteSetChange_DeleteResource

Delete a resource

type stringrequired

Possible values: [delete_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

resource MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

WriteSetChange_DeleteTableItem

Delete a table item

type stringrequired

Possible values: [delete_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

data

object

Deleted table data

key required

Deleted key

key_type stringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

type stringrequired

Possible values: [write_module]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecode hexrequired

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.

abi

object

A Move module

address hexrequired

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.

name IdentifierWrapper (string)required

friends MoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

name IdentifierWrapper (string)required

visibility MoveFunctionVisibility (string)required

Possible values: [private, public, friend]

Move function visibility

is_entry booleanrequired

Whether the function can be called as an entry function directly in a transaction

is_view booleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraints MoveAbility (string)[]required

Move abilities tied to the generic type param and associated with the function that uses it

]

params MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Parameters associated with the move function

return MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Return type of the function

]

structs

object[]

required

Structs of the module

Array [

name IdentifierWrapper (string)required

is_native booleanrequired

Whether the struct is a native struct of Move

is_event booleanrequired

Whether the struct is marked with the #[event] annotation

abilities MoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraints MoveAbility (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

Array [

name IdentifierWrapper (string)required

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

type stringrequired

Possible values: [write_resource]

address hexrequired

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.

state_key_hash stringrequired

State key hash

data

object

required

A parsed Move resource

type MoveStructTag (string)required

Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$

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:

1. move_module_address, module_name and struct_name, all joined by ::
2. struct generic type parameters joined by ,

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).

See doc for more details.

data objectrequired

This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.

To clarify, you might query for 0x1::account::Account and see the example data.

Move bool type value is serialized into boolean.

Move u8, u16 and u32 type value is serialized into integer.

Move u64, u128 and u256 type value is serialized into string.

Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example:

• 0x1
• 0x1668f6be25668c1a17cd8caf6b8d2f25

Move vector type value is serialized into array, except vector<u8> which is serialized into a HexEncodedBytes string with 0x prefix. For example:

• vector<u64>{255, 255} => ["255", "255"]
• vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

{
  field1_name: field1_value,
  field2_name: field2_value,
  ......
}

For example: { "created": "0xa550c18", "role_id": "0" }

Special serialization for Move stdlib types:

• 0x1::string::String is serialized into string. For example, struct value 0x1::string::String{bytes: b"Hello World!"} is serialized as "Hello World!" in JSON.

WriteSetChange_WriteTableItem

Change set to write a table item

type stringrequired

Possible values: [write_table_item]

state_key_hash stringrequired

handle hexrequired

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.

key hexrequired

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.

value hexrequired

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.

data

object

Decoded table data

key required

Key of table in JSON

key_type stringrequired

Type of key

value required

Value of table in JSON

value_type stringrequired

Type of value

]

events

object[]

required

Array [

guid

object

required

creation_number uint64required

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.

account_address hexrequired

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.

sequence_number uint64required

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.

type MoveType (string)required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

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).

data required

The JSON representation of the event

]

timestamp uint64required

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.

dkg_transcript

object

required

epoch uint64required

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.

author hexrequired

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.

payload hexrequired

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.

type stringrequired

Possible values: [validator_transaction]

]

Example (from schema)

{
  "block_height": "32425224034",
  "block_hash": "string",
  "block_timestamp": "32425224034",
  "first_version": "32425224034",
  "last_version": "32425224034",
  "transactions": [
    null,
    null,
    null,
    null,
    null,
    null,
    null
  ]
}

application/x-bcs

Schema

Schema

• Array [

integer

• ]

Example (from schema)

[
  0
]

400

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

403

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

404

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

410

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

500

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

503

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

Loading...