Get blocks by version

GET 
/blocks/by_version/:version

This endpoint allows you to get the transactions in a block and the corresponding block information given a version in the block.

Transactions are limited by max default transactions size. If not all transactions are present, the user will need to query for the rest of the transactions via the get transactions API.

If the block has been pruned, it will return a 410

Request

Path Parameters

version uint64required

Ledger version to lookup block information for.

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_heightuint64required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034
block_hashHashValue (string)required
block_timestampuint64required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034
first_versionuint64required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034
last_versionuint64required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Example: 32425224034

transactions

object[]

The transactions in the block in sequential order

Array [

oneOf

Transaction_PendingTransaction

typestringrequired

Possible values: [pending_transaction]

Example: pending_transaction

hashHashValue (string)required

senderhexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

sequence_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

max_gas_amountuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

gas_unit_priceuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

expiration_timestamp_secsuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

payload

object

required

An enum of the possible transaction payloads

oneOf

TransactionPayload_EntryFunctionPayload

Payload which runs a single entry function

typestringrequired

Possible values: [entry_function_payload]

Example: entry_function_payload

functionEntryFunctionId (string)required

Entry function id is string representation of a entry function defined on-chain.

Format: {address}::{module name}::{function name}

Both module name and function name are case-sensitive.

Example: 0x1::aptos_coin::transfer

type_argumentsMoveType (string)[]required

Type arguments of the function

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

argumentsarrayrequired

Arguments of the function

TransactionPayload_ScriptPayload

Payload which runs a script that can run multiple functions

typestringrequired

Possible values: [script_payload]

Example: script_payload

code

object

required

Move script bytecode

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

Move function

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

type_argumentsMoveType (string)[]required

Type arguments of the function

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

argumentsarrayrequired

Arguments of the function

TransactionPayload_DeprecatedModuleBundlePayload

typestringrequired

Possible values: [module_bundle_payload]

Example: 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.

typestringrequired

Possible values: [multisig_payload]

Example: multisig_payload

multisig_addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

transaction_payload

object

oneOf

MultisigTransactionPayload_EntryFunctionPayload

Payload which runs a single entry function

typestringrequired

Possible values: [entry_function_payload]

Example: entry_function_payload

functionEntryFunctionId (string)required

Entry function id is string representation of a entry function defined on-chain.

Format: {address}::{module name}::{function name}

Both module name and function name are case-sensitive.

Example: 0x1::aptos_coin::transfer

type_argumentsMoveType (string)[]required

Type arguments of the function

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

argumentsarrayrequired

Arguments of the function

signature

object

An enum representing the different transaction signatures available

oneOf

TransactionSignature_Ed25519Signature

A single Ed25519 signature

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

TransactionSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

TransactionSignature_MultiAgentSignature

Multi agent signature for multi agent transactions

This allows you to have transactions across multiple accounts

typestringrequired

Possible values: [multi_agent_signature]

Example: 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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_SingleKeySignature

A single key signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiKeySignature

A multi key signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

typestringrequired

Possible values: [no_account_signature]

Example: no_account_signature

secondary_signer_addresseshex[]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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_SingleKeySignature

A single key signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiKeySignature

A multi key signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

typestringrequired

Possible values: [no_account_signature]

Example: 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

typestringrequired

Possible values: [fee_payer_signature]

Example: 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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_SingleKeySignature

A single key signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiKeySignature

A multi key signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

typestringrequired

Possible values: [no_account_signature]

Example: no_account_signature

secondary_signer_addresseshex[]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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_SingleKeySignature

A single key signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiKeySignature

A multi key signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

typestringrequired

Possible values: [no_account_signature]

Example: no_account_signature

]

fee_payer_addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_SingleKeySignature

A single key signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiKeySignature

A multi key signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

typestringrequired

Possible values: [no_account_signature]

Example: 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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

multi_ed25519_signature

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

single_key_signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

multi_key_signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

no_account_signature

typestringrequired

Possible values: [no_account_signature]

Example: no_account_signature

Transaction_UserTransaction

typestringrequired

Possible values: [user_transaction]

Example: user_transaction

versionuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

hashHashValue (string)required

state_change_hashHashValue (string)required

event_root_hashHashValue (string)required

state_checkpoint_hashHashValue (string)

gas_useduint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

successbooleanrequired

Whether the transaction was successful

vm_statusstringrequired

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

accumulator_root_hashHashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

typestringrequired

Possible values: [delete_module]

Example: delete_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

moduleMoveModuleId (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.

Example: 0x1::aptos_coin

WriteSetChange_DeleteResource

Delete a resource

typestringrequired

Possible values: [delete_resource]

Example: delete_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

resourceMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

WriteSetChange_DeleteTableItem

Delete a table item

typestringrequired

Possible values: [delete_table_item]

Example: delete_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Deleted table data

keyrequired

Deleted key

key_typestringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

typestringrequired

Possible values: [write_module]

Example: write_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

A Move module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

nameIdentifierWrapper (string)required

friendsMoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

]

structs

object[]

required

Structs of the module

Array [

nameIdentifierWrapper (string)required

is_nativebooleanrequired

Whether the struct is a native struct of Move

is_eventbooleanrequired

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

abilitiesMoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraintsMoveAbility (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 [

nameIdentifierWrapper (string)required

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

typestringrequired

Possible values: [write_resource]

Example: write_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

A parsed Move resource

typeMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

dataobjectrequired

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.

Example: {"authentication_key":"0x0000000000000000000000000000000000000000000000000000000000000001","coin_register_events":{"counter":"0","guid":{"id":{"addr":"0x1","creation_num":"0"}}},"self_address":"0x1","sequence_number":"0"}

WriteSetChange_WriteTableItem

Change set to write a table item

typestringrequired

Possible values: [write_table_item]

Example: write_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Decoded table data

keyrequired

Key of table in JSON

key_typestringrequired

Type of key

valuerequired

Value of table in JSON

value_typestringrequired

Type of value

]

senderhexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

sequence_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

max_gas_amountuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

gas_unit_priceuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

expiration_timestamp_secsuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

payload

object

required

An enum of the possible transaction payloads

oneOf

TransactionPayload_EntryFunctionPayload

Payload which runs a single entry function

typestringrequired

Possible values: [entry_function_payload]

Example: entry_function_payload

functionEntryFunctionId (string)required

Entry function id is string representation of a entry function defined on-chain.

Format: {address}::{module name}::{function name}

Both module name and function name are case-sensitive.

Example: 0x1::aptos_coin::transfer

type_argumentsMoveType (string)[]required

Type arguments of the function

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

argumentsarrayrequired

Arguments of the function

TransactionPayload_ScriptPayload

Payload which runs a script that can run multiple functions

typestringrequired

Possible values: [script_payload]

Example: script_payload

code

object

required

Move script bytecode

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

Move function

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

type_argumentsMoveType (string)[]required

Type arguments of the function

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

argumentsarrayrequired

Arguments of the function

TransactionPayload_DeprecatedModuleBundlePayload

typestringrequired

Possible values: [module_bundle_payload]

Example: 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.

typestringrequired

Possible values: [multisig_payload]

Example: multisig_payload

multisig_addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

transaction_payload

object

oneOf

MultisigTransactionPayload_EntryFunctionPayload

Payload which runs a single entry function

typestringrequired

Possible values: [entry_function_payload]

Example: entry_function_payload

functionEntryFunctionId (string)required

Entry function id is string representation of a entry function defined on-chain.

Format: {address}::{module name}::{function name}

Both module name and function name are case-sensitive.

Example: 0x1::aptos_coin::transfer

type_argumentsMoveType (string)[]required

Type arguments of the function

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

argumentsarrayrequired

Arguments of the function

signature

object

An enum representing the different transaction signatures available

oneOf

TransactionSignature_Ed25519Signature

A single Ed25519 signature

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

TransactionSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

TransactionSignature_MultiAgentSignature

Multi agent signature for multi agent transactions

This allows you to have transactions across multiple accounts

typestringrequired

Possible values: [multi_agent_signature]

Example: 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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_SingleKeySignature

A single key signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiKeySignature

A multi key signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

typestringrequired

Possible values: [no_account_signature]

Example: no_account_signature

secondary_signer_addresseshex[]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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_SingleKeySignature

A single key signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiKeySignature

A multi key signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

typestringrequired

Possible values: [no_account_signature]

Example: 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

typestringrequired

Possible values: [fee_payer_signature]

Example: 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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_SingleKeySignature

A single key signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiKeySignature

A multi key signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

typestringrequired

Possible values: [no_account_signature]

Example: no_account_signature

secondary_signer_addresseshex[]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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_SingleKeySignature

A single key signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiKeySignature

A multi key signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

typestringrequired

Possible values: [no_account_signature]

Example: no_account_signature

]

fee_payer_addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiEd25519Signature

A Ed25519 multi-sig signature

This allows k-of-n signing for a transaction

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_SingleKeySignature

A single key signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

AccountSignature_MultiKeySignature

A multi key signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

AccountSignature_NoAccountSignature

A placeholder to represent the absence of account signature

typestringrequired

Possible values: [no_account_signature]

Example: 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

typestringrequired

Possible values: [ed25519_signature]

Example: ed25519_signature

public_keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signaturehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

multi_ed25519_signature

typestringrequired

Possible values: [multi_ed25519_signature]

Example: multi_ed25519_signature

public_keyshex[]required

The public keys for the Ed25519 signature

signatureshex[]required

Signature associated with the public keys in the same order

thresholduint8required

The number of signatures required for a successful transaction

bitmaphexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

single_key_signature

typestringrequired

Possible values: [single_key_signature]

Example: single_key_signature

public_key

object

required

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

multi_key_signature

typestringrequired

Possible values: [multi_key_signature]

Example: multi_key_signature

public_keys

object[]

required

Array [

oneOf

PublicKey_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Secp256r1Ecdsa

typestringrequired

Possible values: [secp256r1_ecdsa]

Example: secp256r1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

PublicKey_FederatedKeyless

typestringrequired

Possible values: [federated_keyless]

Example: federated_keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures

object[]

required

Array [

indexuint8required

signature

object

required

oneOf

Signature_Ed25519

typestringrequired

Possible values: [ed25519]

Example: ed25519

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Secp256k1Ecdsa

typestringrequired

Possible values: [secp256k1_ecdsa]

Example: secp256k1_ecdsa

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_WebAuthn

typestringrequired

Possible values: [web_authn]

Example: web_authn

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Signature_Keyless

typestringrequired

Possible values: [keyless]

Example: keyless

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

]

signatures_requireduint8required

no_account_signature

typestringrequired

Possible values: [no_account_signature]

Example: no_account_signature

events

object[]

required

Events generated by the transaction

Array [

guid

object

required

creation_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

account_addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

sequence_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

datarequired

The JSON representation of the event

]

timestampuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

Transaction_GenesisTransaction

typestringrequired

Possible values: [genesis_transaction]

Example: genesis_transaction

versionuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

hashHashValue (string)required

state_change_hashHashValue (string)required

event_root_hashHashValue (string)required

state_checkpoint_hashHashValue (string)

gas_useduint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

successbooleanrequired

Whether the transaction was successful

vm_statusstringrequired

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

accumulator_root_hashHashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

typestringrequired

Possible values: [delete_module]

Example: delete_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

moduleMoveModuleId (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.

Example: 0x1::aptos_coin

WriteSetChange_DeleteResource

Delete a resource

typestringrequired

Possible values: [delete_resource]

Example: delete_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

resourceMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

WriteSetChange_DeleteTableItem

Delete a table item

typestringrequired

Possible values: [delete_table_item]

Example: delete_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Deleted table data

keyrequired

Deleted key

key_typestringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

typestringrequired

Possible values: [write_module]

Example: write_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

A Move module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

nameIdentifierWrapper (string)required

friendsMoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

]

structs

object[]

required

Structs of the module

Array [

nameIdentifierWrapper (string)required

is_nativebooleanrequired

Whether the struct is a native struct of Move

is_eventbooleanrequired

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

abilitiesMoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraintsMoveAbility (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 [

nameIdentifierWrapper (string)required

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

typestringrequired

Possible values: [write_resource]

Example: write_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

A parsed Move resource

typeMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

dataobjectrequired

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.

Example: {"authentication_key":"0x0000000000000000000000000000000000000000000000000000000000000001","coin_register_events":{"counter":"0","guid":{"id":{"addr":"0x1","creation_num":"0"}}},"self_address":"0x1","sequence_number":"0"}

WriteSetChange_WriteTableItem

Change set to write a table item

typestringrequired

Possible values: [write_table_item]

Example: write_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Decoded table data

keyrequired

Key of table in JSON

key_typestringrequired

Type of key

valuerequired

Value of table in JSON

value_typestringrequired

Type of value

]

payload

object

required

The writeset payload of the Genesis transaction

oneOf

GenesisPayload_WriteSetPayload

A writeset payload, used only for genesis

typestringrequired

Possible values: [write_set_payload]

Example: write_set_payload

write_set

object

required

The associated writeset with a payload

oneOf

WriteSet_ScriptWriteSet

typestringrequired

Possible values: [script_write_set]

Example: script_write_set

execute_ashexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

script

object

required

Payload which runs a script that can run multiple functions

code

object

required

Move script bytecode

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

Move function

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

type_argumentsMoveType (string)[]required

Type arguments of the function

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

argumentsarrayrequired

Arguments of the function

WriteSet_DirectWriteSet

typestringrequired

Possible values: [direct_write_set]

Example: direct_write_set

changes

object[]

required

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

typestringrequired

Possible values: [delete_module]

Example: delete_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

moduleMoveModuleId (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.

Example: 0x1::aptos_coin

WriteSetChange_DeleteResource

Delete a resource

typestringrequired

Possible values: [delete_resource]

Example: delete_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

resourceMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

WriteSetChange_DeleteTableItem

Delete a table item

typestringrequired

Possible values: [delete_table_item]

Example: delete_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Deleted table data

keyrequired

Deleted key

key_typestringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

typestringrequired

Possible values: [write_module]

Example: write_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

A Move module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

nameIdentifierWrapper (string)required

friendsMoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

]

structs

object[]

required

Structs of the module

Array [

nameIdentifierWrapper (string)required

is_nativebooleanrequired

Whether the struct is a native struct of Move

is_eventbooleanrequired

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

abilitiesMoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraintsMoveAbility (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 [

nameIdentifierWrapper (string)required

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

typestringrequired

Possible values: [write_resource]

Example: write_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

A parsed Move resource

typeMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

dataobjectrequired

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.

Example: {"authentication_key":"0x0000000000000000000000000000000000000000000000000000000000000001","coin_register_events":{"counter":"0","guid":{"id":{"addr":"0x1","creation_num":"0"}}},"self_address":"0x1","sequence_number":"0"}

WriteSetChange_WriteTableItem

Change set to write a table item

typestringrequired

Possible values: [write_table_item]

Example: write_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Decoded table data

keyrequired

Key of table in JSON

key_typestringrequired

Type of key

valuerequired

Value of table in JSON

value_typestringrequired

Type of value

]

events

object[]

required

Array [

guid

object

required

creation_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

account_addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

sequence_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

datarequired

The JSON representation of the event

]

events

object[]

required

Events emitted during genesis

Array [

guid

object

required

creation_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

account_addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

sequence_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

datarequired

The JSON representation of the event

]

Transaction_BlockMetadataTransaction

typestringrequired

Possible values: [block_metadata_transaction]

Example: block_metadata_transaction

versionuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

hashHashValue (string)required

state_change_hashHashValue (string)required

event_root_hashHashValue (string)required

state_checkpoint_hashHashValue (string)

gas_useduint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

successbooleanrequired

Whether the transaction was successful

vm_statusstringrequired

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

accumulator_root_hashHashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

typestringrequired

Possible values: [delete_module]

Example: delete_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

moduleMoveModuleId (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.

Example: 0x1::aptos_coin

WriteSetChange_DeleteResource

Delete a resource

typestringrequired

Possible values: [delete_resource]

Example: delete_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

resourceMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

WriteSetChange_DeleteTableItem

Delete a table item

typestringrequired

Possible values: [delete_table_item]

Example: delete_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Deleted table data

keyrequired

Deleted key

key_typestringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

typestringrequired

Possible values: [write_module]

Example: write_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

A Move module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

nameIdentifierWrapper (string)required

friendsMoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

]

structs

object[]

required

Structs of the module

Array [

nameIdentifierWrapper (string)required

is_nativebooleanrequired

Whether the struct is a native struct of Move

is_eventbooleanrequired

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

abilitiesMoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraintsMoveAbility (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 [

nameIdentifierWrapper (string)required

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

typestringrequired

Possible values: [write_resource]

Example: write_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

A parsed Move resource

typeMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

dataobjectrequired

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.

Example: {"authentication_key":"0x0000000000000000000000000000000000000000000000000000000000000001","coin_register_events":{"counter":"0","guid":{"id":{"addr":"0x1","creation_num":"0"}}},"self_address":"0x1","sequence_number":"0"}

WriteSetChange_WriteTableItem

Change set to write a table item

typestringrequired

Possible values: [write_table_item]

Example: write_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Decoded table data

keyrequired

Key of table in JSON

key_typestringrequired

Type of key

valuerequired

Value of table in JSON

value_typestringrequired

Type of value

]

idHashValue (string)required

epochuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

rounduint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

events

object[]

required

The events emitted at the block creation

Array [

guid

object

required

creation_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

account_addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

sequence_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

datarequired

The JSON representation of the event

]

previous_block_votes_bitvecuint8[]required

Previous block votes

proposerhexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

failed_proposer_indicesuint32[]required

The indices of the proposers who failed to propose

timestampuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

Transaction_StateCheckpointTransaction

typestringrequired

Possible values: [state_checkpoint_transaction]

Example: state_checkpoint_transaction

versionuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

hashHashValue (string)required

state_change_hashHashValue (string)required

event_root_hashHashValue (string)required

state_checkpoint_hashHashValue (string)

gas_useduint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

successbooleanrequired

Whether the transaction was successful

vm_statusstringrequired

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

accumulator_root_hashHashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

typestringrequired

Possible values: [delete_module]

Example: delete_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

moduleMoveModuleId (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.

Example: 0x1::aptos_coin

WriteSetChange_DeleteResource

Delete a resource

typestringrequired

Possible values: [delete_resource]

Example: delete_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

resourceMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

WriteSetChange_DeleteTableItem

Delete a table item

typestringrequired

Possible values: [delete_table_item]

Example: delete_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Deleted table data

keyrequired

Deleted key

key_typestringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

typestringrequired

Possible values: [write_module]

Example: write_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

A Move module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

nameIdentifierWrapper (string)required

friendsMoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

]

structs

object[]

required

Structs of the module

Array [

nameIdentifierWrapper (string)required

is_nativebooleanrequired

Whether the struct is a native struct of Move

is_eventbooleanrequired

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

abilitiesMoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraintsMoveAbility (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 [

nameIdentifierWrapper (string)required

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

typestringrequired

Possible values: [write_resource]

Example: write_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

A parsed Move resource

typeMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

dataobjectrequired

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.

Example: {"authentication_key":"0x0000000000000000000000000000000000000000000000000000000000000001","coin_register_events":{"counter":"0","guid":{"id":{"addr":"0x1","creation_num":"0"}}},"self_address":"0x1","sequence_number":"0"}

WriteSetChange_WriteTableItem

Change set to write a table item

typestringrequired

Possible values: [write_table_item]

Example: write_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Decoded table data

keyrequired

Key of table in JSON

key_typestringrequired

Type of key

valuerequired

Value of table in JSON

value_typestringrequired

Type of value

]

timestampuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

Transaction_BlockEpilogueTransaction

typestringrequired

Possible values: [block_epilogue_transaction]

Example: block_epilogue_transaction

versionuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

hashHashValue (string)required

state_change_hashHashValue (string)required

event_root_hashHashValue (string)required

state_checkpoint_hashHashValue (string)

gas_useduint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

successbooleanrequired

Whether the transaction was successful

vm_statusstringrequired

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

accumulator_root_hashHashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

typestringrequired

Possible values: [delete_module]

Example: delete_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

moduleMoveModuleId (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.

Example: 0x1::aptos_coin

WriteSetChange_DeleteResource

Delete a resource

typestringrequired

Possible values: [delete_resource]

Example: delete_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

resourceMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

WriteSetChange_DeleteTableItem

Delete a table item

typestringrequired

Possible values: [delete_table_item]

Example: delete_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Deleted table data

keyrequired

Deleted key

key_typestringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

typestringrequired

Possible values: [write_module]

Example: write_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

A Move module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

nameIdentifierWrapper (string)required

friendsMoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

]

structs

object[]

required

Structs of the module

Array [

nameIdentifierWrapper (string)required

is_nativebooleanrequired

Whether the struct is a native struct of Move

is_eventbooleanrequired

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

abilitiesMoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraintsMoveAbility (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 [

nameIdentifierWrapper (string)required

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

typestringrequired

Possible values: [write_resource]

Example: write_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

A parsed Move resource

typeMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

dataobjectrequired

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.

Example: {"authentication_key":"0x0000000000000000000000000000000000000000000000000000000000000001","coin_register_events":{"counter":"0","guid":{"id":{"addr":"0x1","creation_num":"0"}}},"self_address":"0x1","sequence_number":"0"}

WriteSetChange_WriteTableItem

Change set to write a table item

typestringrequired

Possible values: [write_table_item]

Example: write_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Decoded table data

keyrequired

Key of table in JSON

key_typestringrequired

Type of key

valuerequired

Value of table in JSON

value_typestringrequired

Type of value

]

timestampuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

block_end_info

object

block_gas_limit_reachedbooleanrequired

block_output_limit_reachedbooleanrequired

block_effective_block_gas_unitsuint64required

block_approx_output_sizeuint64required

Transaction_ValidatorTransaction

oneOf

ValidatorTransaction_JWKUpdateTransaction

validator_transaction_typestringrequired

Possible values: [observed_jwk_update]

Example: observed_jwk_update

versionuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

hashHashValue (string)required

state_change_hashHashValue (string)required

event_root_hashHashValue (string)required

state_checkpoint_hashHashValue (string)

gas_useduint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

successbooleanrequired

Whether the transaction was successful

vm_statusstringrequired

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

accumulator_root_hashHashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

typestringrequired

Possible values: [delete_module]

Example: delete_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

moduleMoveModuleId (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.

Example: 0x1::aptos_coin

WriteSetChange_DeleteResource

Delete a resource

typestringrequired

Possible values: [delete_resource]

Example: delete_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

resourceMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

WriteSetChange_DeleteTableItem

Delete a table item

typestringrequired

Possible values: [delete_table_item]

Example: delete_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Deleted table data

keyrequired

Deleted key

key_typestringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

typestringrequired

Possible values: [write_module]

Example: write_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

A Move module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

nameIdentifierWrapper (string)required

friendsMoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

]

structs

object[]

required

Structs of the module

Array [

nameIdentifierWrapper (string)required

is_nativebooleanrequired

Whether the struct is a native struct of Move

is_eventbooleanrequired

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

abilitiesMoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraintsMoveAbility (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 [

nameIdentifierWrapper (string)required

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

typestringrequired

Possible values: [write_resource]

Example: write_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

A parsed Move resource

typeMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

dataobjectrequired

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.

Example: {"authentication_key":"0x0000000000000000000000000000000000000000000000000000000000000001","coin_register_events":{"counter":"0","guid":{"id":{"addr":"0x1","creation_num":"0"}}},"self_address":"0x1","sequence_number":"0"}

WriteSetChange_WriteTableItem

Change set to write a table item

typestringrequired

Possible values: [write_table_item]

Example: write_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Decoded table data

keyrequired

Key of table in JSON

key_typestringrequired

Type of key

valuerequired

Value of table in JSON

value_typestringrequired

Type of value

]

events

object[]

required

Array [

guid

object

required

creation_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

account_addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

sequence_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

datarequired

The JSON representation of the event

]

timestampuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

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.

issuerstringrequired

versionuint64required

jwks

object[]

required

Array [

anyOf

RSA_JWK

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

kidstringrequired

ktystringrequired

algstringrequired

estringrequired

nstringrequired

UnsupportedJWK

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

iduint8[]required

payloaduint8[]required

]

multi_sig

object

required

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

signer_indicesuint64[]required

sighex

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

ValidatorTransaction_DKGResultTransaction

validator_transaction_typestringrequired

Possible values: [dkg_result]

Example: dkg_result

versionuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

hashHashValue (string)required

state_change_hashHashValue (string)required

event_root_hashHashValue (string)required

state_checkpoint_hashHashValue (string)

gas_useduint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

successbooleanrequired

Whether the transaction was successful

vm_statusstringrequired

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

accumulator_root_hashHashValue (string)required

changes

object[]

required

Final state of resources changed by the transaction

Array [

oneOf

WriteSetChange_DeleteModule

Delete a module

typestringrequired

Possible values: [delete_module]

Example: delete_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

moduleMoveModuleId (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.

Example: 0x1::aptos_coin

WriteSetChange_DeleteResource

Delete a resource

typestringrequired

Possible values: [delete_resource]

Example: delete_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

resourceMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

WriteSetChange_DeleteTableItem

Delete a table item

typestringrequired

Possible values: [delete_table_item]

Example: delete_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Deleted table data

keyrequired

Deleted key

key_typestringrequired

Deleted key type

WriteSetChange_WriteModule

Write a new module or update an existing one

typestringrequired

Possible values: [write_module]

Example: write_module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

Move module bytecode along with it's ABI

bytecodehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

abi

object

A Move module

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

nameIdentifierWrapper (string)required

friendsMoveModuleId (string)[]required

Friends of the module

exposed_functions

object[]

required

Public functions of the module

Array [

nameIdentifierWrapper (string)required

visibilityMoveFunctionVisibility (string)required

Move function visibility

Possible values: [private, public, friend]

is_entrybooleanrequired

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

is_viewbooleanrequired

Whether the function is a view function or not

generic_type_params

object[]

required

Generic type params associated with the Move function

Array [

constraintsMoveAbility (string)[]required

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

]

paramsMoveType (string)[]required

Parameters associated with the move function

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

returnMoveType (string)[]required

Return type of the function

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

]

structs

object[]

required

Structs of the module

Array [

nameIdentifierWrapper (string)required

is_nativebooleanrequired

Whether the struct is a native struct of Move

is_eventbooleanrequired

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

abilitiesMoveAbility (string)[]required

Abilities associated with the struct

generic_type_params

object[]

required

Generic types associated with the struct

Array [

constraintsMoveAbility (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 [

nameIdentifierWrapper (string)required

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

]

]

WriteSetChange_WriteResource

Write a resource or update an existing one

typestringrequired

Possible values: [write_resource]

Example: write_resource

addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

state_key_hashstringrequired

State key hash

data

object

required

A parsed Move resource

typeMoveStructTag (string)required

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

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.

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

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

dataobjectrequired

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.

Example: {"authentication_key":"0x0000000000000000000000000000000000000000000000000000000000000001","coin_register_events":{"counter":"0","guid":{"id":{"addr":"0x1","creation_num":"0"}}},"self_address":"0x1","sequence_number":"0"}

WriteSetChange_WriteTableItem

Change set to write a table item

typestringrequired

Possible values: [write_table_item]

Example: write_table_item

state_key_hashstringrequired

handlehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

keyhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

valuehexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

data

object

Decoded table data

keyrequired

Key of table in JSON

key_typestringrequired

Type of key

valuerequired

Value of table in JSON

value_typestringrequired

Type of value

]

events

object[]

required

Array [

guid

object

required

creation_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

account_addresshexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

sequence_numberuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

typeMoveType (string)required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

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

datarequired

The JSON representation of the event

]

timestampuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

dkg_transcript

object

required

epochuint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

authorhexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

payloadhexrequired

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

typestringrequired

Possible values: [validator_transaction]

Example: 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

messagestringrequired

A message describing the error

error_codeAptosErrorCode (string)required

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

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]

vm_error_codeuint64

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

messagestringrequired

A message describing the error

error_codeAptosErrorCode (string)required

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

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]

vm_error_codeuint64

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

messagestringrequired

A message describing the error

error_codeAptosErrorCode (string)required

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

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]

vm_error_codeuint64

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

messagestringrequired

A message describing the error

error_codeAptosErrorCode (string)required

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

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]

vm_error_codeuint64

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

messagestringrequired

A message describing the error

error_codeAptosErrorCode (string)required

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

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]

vm_error_codeuint64

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

messagestringrequired

A message describing the error

error_codeAptosErrorCode (string)required

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

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]

vm_error_codeuint64

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
}