Wait for transaction by hash

GET

/transactions/wait_by_hash/{txn_hash}

curl --request GET \
  --url https://example.com/v1/transactions/wait_by_hash/example

Same as /transactions/by_hash, but will wait for a pending transaction to be committed. To be used as a long poll optimization by clients, to reduce latency caused by polling. The “long” poll is generally a second or less but dictated by the server; the client must deal with the result as if the request was a normal /transactions/by_hash request, e.g., by retrying if the transaction is pending.

Parameters

Path Parameters

txn_hash

required

string

Hash of transaction to retrieve

Responses

200

One of: discriminator: type

object

Enum of the different types of transactions in Aptos

object

type

required

string

Allowed values: pending_transaction

hash

required

string

sender

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

sequence_number

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

max_gas_amount

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

gas_unit_price

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

expiration_timestamp_secs

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

payload

required

One of: discriminator: type

object

An enum of the possible transaction payloads

object

type

required

string

Allowed values: entry_function_payload

function

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.

string

type_arguments

required

Type arguments of the function

Array<string>

arguments

required

Arguments of the function

Array

object

An enum of the possible transaction payloads

object

type

required

string

Allowed values: script_payload

code

required

Move script bytecode

object

bytecode

required

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

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

string format: hex

abi

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

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

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

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

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

type_arguments

required

Type arguments of the function

Array<string>

arguments

required

Arguments of the function

Array

object

An enum of the possible transaction payloads

object

type

required

string

Allowed values: module_bundle_payload

object

An enum of the possible transaction payloads

object

type

required

string

Allowed values: multisig_payload

multisig_address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

transaction_payload

One of: discriminator: type

object

object

type

required

string

Allowed values: entry_function_payload

function

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.

string

type_arguments

required

Type arguments of the function

Array<string>

arguments

required

Arguments of the function

Array

signature

One of: discriminator: type

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: multi_agent_signature

sender

required

One of: discriminator: type

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

secondary_signer_addresses

required

The other involved parties’ addresses

Array<string>

secondary_signers

required

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

Array<object>

One of: discriminator: type

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: fee_payer_signature

sender

required

One of: discriminator: type

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

secondary_signer_addresses

required

The other involved parties’ addresses

Array<string>

secondary_signers

required

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

Array<object>

One of: discriminator: type

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

fee_payer_address

required

string format: hex

fee_payer_signer

required

object

One of:

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: single_sender

One of: discriminator: type

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: no_account_signature

replay_protection_nonce

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.

string format: uint64

object

Enum of the different types of transactions in Aptos

object

type

required

string

Allowed values: user_transaction

version

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

hash

required

string

state_change_hash

required

string

event_root_hash

required

string

state_checkpoint_hash

string

gas_used

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

success

required

Whether the transaction was successful

boolean

vm_status

required

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

string

accumulator_root_hash

required

string

changes

required

Final state of resources changed by the transaction

Array<object>

One of: discriminator: type

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

module

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.

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

resource

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

data

Deleted table data

object

key

required

Deleted key

key_type

required

Deleted key type

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

Move module bytecode along with it’s ABI

object

bytecode

required

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

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

string format: hex

abi

A Move module

object

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

name

required

string

friends

required

Friends of the module

Array<string>

exposed_functions

required

Public functions of the module

Array<object>

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

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

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

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

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

structs

required

Structs of the module

Array<object>

A move struct

object

name

required

string

is_native

required

Whether the struct is a native struct of Move

boolean

is_event

required

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

boolean

abilities

required

Abilities associated with the struct

Array<string>

generic_type_params

required

Generic types associated with the struct

Array<object>

Move generic type param

object

constraints

required

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

Array<string>

fields

required

Fields associated with the struct

Array<object>

Move struct field

object

name

required

string

type

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

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

A parsed Move resource

object

type

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

data

required

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.

object

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

value

required

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

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

string format: hex

data

Decoded table data

object

key

required

Key of table in JSON

key_type

required

Type of key

string

value

required

Value of table in JSON

value_type

required

Type of value

string

sender

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

sequence_number

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

max_gas_amount

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

gas_unit_price

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

expiration_timestamp_secs

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

payload

required

One of: discriminator: type

object

An enum of the possible transaction payloads

object

type

required

string

Allowed values: entry_function_payload

function

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.

string

type_arguments

required

Type arguments of the function

Array<string>

arguments

required

Arguments of the function

Array

object

An enum of the possible transaction payloads

object

type

required

string

Allowed values: script_payload

code

required

Move script bytecode

object

bytecode

required

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

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

string format: hex

abi

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

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

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

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

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

type_arguments

required

Type arguments of the function

Array<string>

arguments

required

Arguments of the function

Array

object

An enum of the possible transaction payloads

object

type

required

string

Allowed values: module_bundle_payload

object

An enum of the possible transaction payloads

object

type

required

string

Allowed values: multisig_payload

multisig_address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

transaction_payload

One of: discriminator: type

object

object

type

required

string

Allowed values: entry_function_payload

function

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.

string

type_arguments

required

Type arguments of the function

Array<string>

arguments

required

Arguments of the function

Array

signature

One of: discriminator: type

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: multi_agent_signature

sender

required

One of: discriminator: type

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

secondary_signer_addresses

required

The other involved parties’ addresses

Array<string>

secondary_signers

required

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

Array<object>

One of: discriminator: type

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: fee_payer_signature

sender

required

One of: discriminator: type

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

secondary_signer_addresses

required

The other involved parties’ addresses

Array<string>

secondary_signers

required

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

Array<object>

One of: discriminator: type

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

fee_payer_address

required

string format: hex

fee_payer_signer

required

object

One of:

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: single_sender

One of: discriminator: type

object

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

object

type

required

string

Allowed values: ed25519_signature

public_key

required

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

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

string format: hex

signature

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_ed25519_signature

public_keys

required

The public keys for the Ed25519 signature

Array<string>

signatures

required

Signature associated with the public keys in the same order

Array<string>

threshold

required

The number of signatures required for a successful transaction

integer format: uint8

bitmap

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: single_key_signature

public_key

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

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

object

type

required

string

Allowed values: multi_key_signature

public_keys

required

Array<object>

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256r1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: federated_keyless

value

required

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

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

string format: hex

signatures

required

Array<object>

object

index

required

integer format: uint8

signature

required

One of: discriminator: type

object

object

type

required

string

Allowed values: ed25519

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: secp256k1_ecdsa

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: web_authn

value

required

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

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

string format: hex

object

object

type

required

string

Allowed values: keyless

value

required

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

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

string format: hex

signatures_required

required

integer format: uint8

object

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

object

type

required

string

Allowed values: no_account_signature

object

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

object

type

required

string

Allowed values: abstraction_signature

function_info

required

string

auth_data

required

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

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

string format: hex

object

An enum representing the different transaction signatures available

object

type

required

string

Allowed values: no_account_signature

replay_protection_nonce

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.

string format: uint64

events

required

Events generated by the transaction

Array<object>

An event from a transaction

object

guid

required

object

creation_number

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

account_address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

sequence_number

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

type

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

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

data

required

The JSON representation of the event

timestamp

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

object

Enum of the different types of transactions in Aptos

object

type

required

string

Allowed values: genesis_transaction

version

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

hash

required

string

state_change_hash

required

string

event_root_hash

required

string

state_checkpoint_hash

string

gas_used

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

success

required

Whether the transaction was successful

boolean

vm_status

required

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

string

accumulator_root_hash

required

string

changes

required

Final state of resources changed by the transaction

Array<object>

One of: discriminator: type

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

module

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.

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

resource

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

data

Deleted table data

object

key

required

Deleted key

key_type

required

Deleted key type

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

Move module bytecode along with it’s ABI

object

bytecode

required

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

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

string format: hex

abi

A Move module

object

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

name

required

string

friends

required

Friends of the module

Array<string>

exposed_functions

required

Public functions of the module

Array<object>

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

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

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

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

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

structs

required

Structs of the module

Array<object>

A move struct

object

name

required

string

is_native

required

Whether the struct is a native struct of Move

boolean

is_event

required

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

boolean

abilities

required

Abilities associated with the struct

Array<string>

generic_type_params

required

Generic types associated with the struct

Array<object>

Move generic type param

object

constraints

required

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

Array<string>

fields

required

Fields associated with the struct

Array<object>

Move struct field

object

name

required

string

type

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

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

A parsed Move resource

object

type

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

data

required

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.

object

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

value

required

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

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

string format: hex

data

Decoded table data

object

key

required

Key of table in JSON

key_type

required

Type of key

string

value

required

Value of table in JSON

value_type

required

Type of value

string

payload

required

One of: discriminator: type

object

The writeset payload of the Genesis transaction

object

type

required

string

Allowed values: write_set_payload

write_set

required

One of: discriminator: type

object

The associated writeset with a payload

object

type

required

string

Allowed values: script_write_set

execute_as

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

script

required

Payload which runs a script that can run multiple functions

object

code

required

Move script bytecode

object

bytecode

required

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

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

string format: hex

abi

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

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

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

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

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

type_arguments

required

Type arguments of the function

Array<string>

arguments

required

Arguments of the function

Array

object

The associated writeset with a payload

object

type

required

string

Allowed values: direct_write_set

changes

required

Array<object>

One of: discriminator: type

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

module

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.

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

resource

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

data

Deleted table data

object

key

required

Deleted key

key_type

required

Deleted key type

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

Move module bytecode along with it’s ABI

object

bytecode

required

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

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

string format: hex

abi

A Move module

object

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

name

required

string

friends

required

Friends of the module

Array<string>

exposed_functions

required

Public functions of the module

Array<object>

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

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

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

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

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

structs

required

Structs of the module

Array<object>

A move struct

object

name

required

string

is_native

required

Whether the struct is a native struct of Move

boolean

is_event

required

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

boolean

abilities

required

Abilities associated with the struct

Array<string>

generic_type_params

required

Generic types associated with the struct

Array<object>

Move generic type param

object

constraints

required

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

Array<string>

fields

required

Fields associated with the struct

Array<object>

Move struct field

object

name

required

string

type

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

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

A parsed Move resource

object

type

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

data

required

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.

object

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

value

required

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

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

string format: hex

data

Decoded table data

object

key

required

Key of table in JSON

key_type

required

Type of key

string

value

required

Value of table in JSON

value_type

required

Type of value

string

events

required

Array<object>

An event from a transaction

object

guid

required

object

creation_number

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

account_address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

sequence_number

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

type

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

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

data

required

The JSON representation of the event

events

required

Events emitted during genesis

Array<object>

An event from a transaction

object

guid

required

object

creation_number

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

account_address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

sequence_number

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

type

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

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

data

required

The JSON representation of the event

object

Enum of the different types of transactions in Aptos

object

type

required

string

Allowed values: block_metadata_transaction

version

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

hash

required

string

state_change_hash

required

string

event_root_hash

required

string

state_checkpoint_hash

string

gas_used

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

success

required

Whether the transaction was successful

boolean

vm_status

required

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

string

accumulator_root_hash

required

string

changes

required

Final state of resources changed by the transaction

Array<object>

One of: discriminator: type

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

module

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.

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

resource

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

data

Deleted table data

object

key

required

Deleted key

key_type

required

Deleted key type

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

Move module bytecode along with it’s ABI

object

bytecode

required

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

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

string format: hex

abi

A Move module

object

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

name

required

string

friends

required

Friends of the module

Array<string>

exposed_functions

required

Public functions of the module

Array<object>

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

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

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

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

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

structs

required

Structs of the module

Array<object>

A move struct

object

name

required

string

is_native

required

Whether the struct is a native struct of Move

boolean

is_event

required

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

boolean

abilities

required

Abilities associated with the struct

Array<string>

generic_type_params

required

Generic types associated with the struct

Array<object>

Move generic type param

object

constraints

required

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

Array<string>

fields

required

Fields associated with the struct

Array<object>

Move struct field

object

name

required

string

type

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

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

A parsed Move resource

object

type

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

data

required

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.

object

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

value

required

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

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

string format: hex

data

Decoded table data

object

key

required

Key of table in JSON

key_type

required

Type of key

string

value

required

Value of table in JSON

value_type

required

Type of value

string

id

required

string

epoch

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

round

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

events

required

The events emitted at the block creation

Array<object>

An event from a transaction

object

guid

required

object

creation_number

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

account_address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

sequence_number

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

type

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

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

data

required

The JSON representation of the event

previous_block_votes_bitvec

required

Previous block votes

Array<integer>

proposer

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

failed_proposer_indices

required

The indices of the proposers who failed to propose

Array<integer>

timestamp

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

block_metadata_extension

object

One of:

object

object

type

required

string

Allowed values: v0

object

object

type

required

string

Allowed values: v1

randomness

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

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

string format: hex

object

Enum of the different types of transactions in Aptos

object

type

required

string

Allowed values: state_checkpoint_transaction

version

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

hash

required

string

state_change_hash

required

string

event_root_hash

required

string

state_checkpoint_hash

string

gas_used

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

success

required

Whether the transaction was successful

boolean

vm_status

required

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

string

accumulator_root_hash

required

string

changes

required

Final state of resources changed by the transaction

Array<object>

One of: discriminator: type

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

module

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.

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

resource

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

data

Deleted table data

object

key

required

Deleted key

key_type

required

Deleted key type

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

Move module bytecode along with it’s ABI

object

bytecode

required

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

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

string format: hex

abi

A Move module

object

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

name

required

string

friends

required

Friends of the module

Array<string>

exposed_functions

required

Public functions of the module

Array<object>

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

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

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

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

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

structs

required

Structs of the module

Array<object>

A move struct

object

name

required

string

is_native

required

Whether the struct is a native struct of Move

boolean

is_event

required

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

boolean

abilities

required

Abilities associated with the struct

Array<string>

generic_type_params

required

Generic types associated with the struct

Array<object>

Move generic type param

object

constraints

required

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

Array<string>

fields

required

Fields associated with the struct

Array<object>

Move struct field

object

name

required

string

type

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

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

A parsed Move resource

object

type

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

data

required

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.

object

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

value

required

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

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

string format: hex

data

Decoded table data

object

key

required

Key of table in JSON

key_type

required

Type of key

string

value

required

Value of table in JSON

value_type

required

Type of value

string

timestamp

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

object

Enum of the different types of transactions in Aptos

object

type

required

string

Allowed values: block_epilogue_transaction

version

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

hash

required

string

state_change_hash

required

string

event_root_hash

required

string

state_checkpoint_hash

string

gas_used

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

success

required

Whether the transaction was successful

boolean

vm_status

required

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

string

accumulator_root_hash

required

string

changes

required

Final state of resources changed by the transaction

Array<object>

One of: discriminator: type

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

module

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.

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

resource

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

data

Deleted table data

object

key

required

Deleted key

key_type

required

Deleted key type

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

Move module bytecode along with it’s ABI

object

bytecode

required

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

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

string format: hex

abi

A Move module

object

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

name

required

string

friends

required

Friends of the module

Array<string>

exposed_functions

required

Public functions of the module

Array<object>

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

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

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

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

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

structs

required

Structs of the module

Array<object>

A move struct

object

name

required

string

is_native

required

Whether the struct is a native struct of Move

boolean

is_event

required

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

boolean

abilities

required

Abilities associated with the struct

Array<string>

generic_type_params

required

Generic types associated with the struct

Array<object>

Move generic type param

object

constraints

required

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

Array<string>

fields

required

Fields associated with the struct

Array<object>

Move struct field

object

name

required

string

type

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

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

A parsed Move resource

object

type

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

data

required

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.

object

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

value

required

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

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

string format: hex

data

Decoded table data

object

key

required

Key of table in JSON

key_type

required

Type of key

string

value

required

Value of table in JSON

value_type

required

Type of value

string

timestamp

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

block_end_info

object

block_gas_limit_reached

required

boolean

block_output_limit_reached

required

boolean

block_effective_block_gas_units

required

integer format: uint64

block_approx_output_size

required

integer format: uint64

object

Enum of the different types of transactions in Aptos

object

type

required

string

Allowed values: validator_transaction

One of: discriminator: type

object

object

validator_transaction_type

required

string

Allowed values: observed_jwk_update

version

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

hash

required

string

state_change_hash

required

string

event_root_hash

required

string

state_checkpoint_hash

string

gas_used

required

A string containing a 64-bit unsigned integer.

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

string format: uint64

success

required

Whether the transaction was successful

boolean

vm_status

required

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

string

accumulator_root_hash

required

string

changes

required

Final state of resources changed by the transaction

Array<object>

One of: discriminator: type

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

module

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.

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_resource

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

resource

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_table_item

state_key_hash

required

string

handle

required

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

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

string format: hex

key

required

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

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

string format: hex

data

Deleted table data

object

key

required

Deleted key

key_type

required

Deleted key type

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_module

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

state_key_hash

required

State key hash

string

data

required

Move module bytecode along with it’s ABI

object

bytecode

required

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

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

string format: hex

abi

A Move module

object

address

required

A hex encoded 32 byte Aptos account address.

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

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

string format: hex

name

required

string

friends

required

Friends of the module

Array<string>

exposed_functions

required

Public functions of the module

Array<object>

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

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

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

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

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

structs

required

Structs of the module

Array<object>

A move struct

object

name

required

string

is_native

required

Whether the struct is a native struct of Move

boolean

is_event

required

Whether the struct is marked with the #[event] annotation

boolean

abilities

required

Abilities associated with the struct

Array<string>

generic_type_params

required

Generic types associated with the struct

Array<object>

Move generic type param

object

constraints

required

Move abilities tied to the generic type param and associated with the type that uses it

Array<string>

fields

required

Fields associated with the struct

Array<object>

Move struct field

object

name

required

string

type

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).

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_resource

address

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

string format: hex

state_key_hash

required

State key hash

string

data

required

A parsed Move resource

object

type

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

data

required

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.

object

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_table_item

state_key_hash

required

string

handle

required

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

key

required

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

value

required

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

data

Decoded table data

object

key

required

Key of table in JSON

key_type

required

Type of key

string

value

required

Value of table in JSON

value_type

required

Type of value

string

events

required

Array<object>

An event from a transaction

object

guid

required

object

creation_number

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

string format: uint64

account_address

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

string format: hex

sequence_number

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

string format: uint64

type

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).

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

data

required

The JSON representation of the event

timestamp

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

string format: uint64

quorum_certified_update

required

A more API-friendly representation of the on-chain aptos_types::jwks::QuorumCertifiedUpdate.

object

update

required

A more API-friendly representation of the on-chain aptos_types::jwks::ProviderJWKs.

object

issuer

required

string

version

required

integer format: uint64

jwks

required

Array<object>

Any of:

object

Move type 0x1::jwks::RSA_JWK in rust. See its doc in Move for more details.

object

kid

required

string

kty

required

string

alg

required

string

e

required

string

n

required

string

object

Move type 0x1::jwks::UnsupportedJWK in rust. See its doc in Move for more details.

object

id

required

Array<integer>

payload

required

Array<integer>

multi_sig

required

A more API-friendly representation of the on-chain aptos_types::aggregate_signature::AggregateSignature.

object

signer_indices

required

Array<integer>

sig

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

object

object

validator_transaction_type

required

string

Allowed values: dkg_result

version

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

string format: uint64

hash

required

string

state_change_hash

required

string

event_root_hash

required

string

state_checkpoint_hash

string

gas_used

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

string format: uint64

success

required

Whether the transaction was successful

boolean

vm_status

required

The VM status of the transaction, can tell useful information in a failure

string

accumulator_root_hash

required

string

changes

required

Final state of resources changed by the transaction

Array<object>

One of: discriminator: type

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_module

address

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

string format: hex

state_key_hash

required

State key hash

string

module

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.

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_resource

address

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

string format: hex

state_key_hash

required

State key hash

string

resource

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: delete_table_item

state_key_hash

required

string

handle

required

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

key

required

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

data

Deleted table data

object

key

required

Deleted key

key_type

required

Deleted key type

string

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_module

address

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

string format: hex

state_key_hash

required

State key hash

string

data

required

Move module bytecode along with it’s ABI

object

bytecode

required

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

abi

A Move module

object

address

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

string format: hex

name

required

string

friends

required

Friends of the module

Array<string>

exposed_functions

required

Public functions of the module

Array<object>

Move function

object

name

required

string

visibility

required

Move function visibility

string

Allowed values: private public friend

is_entry

required

Whether the function can be called as an entry function directly in a transaction

boolean

is_view

required

Whether the function is a view function or not

boolean

generic_type_params

required

Generic type params associated with the Move function

Array<object>

Move function generic type param

object

constraints

required

Move abilities tied to the generic type param and associated with the function that uses it

Array<string>

params

required

Parameters associated with the move function

Array<string>

return

required

Return type of the function

Array<string>

structs

required

Structs of the module

Array<object>

A move struct

object

name

required

string

is_native

required

Whether the struct is a native struct of Move

boolean

is_event

required

Whether the struct is marked with the #[event] annotation

boolean

abilities

required

Abilities associated with the struct

Array<string>

generic_type_params

required

Generic types associated with the struct

Array<object>

Move generic type param

object

constraints

required

Move abilities tied to the generic type param and associated with the type that uses it

Array<string>

fields

required

Fields associated with the struct

Array<object>

Move struct field

object

name

required

string

type

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).

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_resource

address

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

string format: hex

state_key_hash

required

State key hash

string

data

required

A parsed Move resource

object

type

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.

string

/^0x[0-9a-zA-Z:_<>]+$/

data

required

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.

object

object

A final state change of a transaction on a resource or module

object

type

required

string

Allowed values: write_table_item

state_key_hash

required

string

handle

required

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

key

required

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

value

required

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

data

Decoded table data

object

key

required

Key of table in JSON

key_type

required

Type of key

string

value

required

Value of table in JSON

value_type

required

Type of value

string

events

required

Array<object>

An event from a transaction

object

guid

required

object

creation_number

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

string format: uint64

account_address

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

string format: hex

sequence_number

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

string format: uint64

type

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).

string

/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/

data

required

The JSON representation of the event

timestamp

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

string format: uint64

dkg_transcript

required

object

epoch

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

string format: uint64

author

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

string format: hex

payload

required

All bytes (Vec) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

string format: hex

Example

{
  "type": "pending_transaction",
  "sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1",
  "sequence_number": "32425224034",
  "max_gas_amount": "32425224034",
  "gas_unit_price": "32425224034",
  "expiration_timestamp_secs": "32425224034",
  "payload": {
    "type": "entry_function_payload",
    "function": "0x1::aptos_coin::transfer"
  },
  "signature": {
    "type": "ed25519_signature",
    "public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1",
    "signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1"
  },
  "replay_protection_nonce": "32425224034"
}

Array<integer>

Headers

X-APTOS-CHAIN-ID

required

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

required

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

required

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

required

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

required

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

required

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

required

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

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.

400

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

These codes provide more granular error information beyond just the HTTP status code of the response.

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas

403

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

These codes provide more granular error information beyond just the HTTP status code of the response.

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas

404

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

These codes provide more granular error information beyond just the HTTP status code of the response.

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas

410

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

These codes provide more granular error information beyond just the HTTP status code of the response.

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas

500

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

These codes provide more granular error information beyond just the HTTP status code of the response.

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas

503

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

These codes provide more granular error information beyond just the HTTP status code of the response.

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas