Get account module

Retrieves an individual module from a given account and at a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used.

The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410.

Path Parameters

address

string

required

Address of account with or without a 0x prefix

module_name

string

required

Name of module to retrieve e.g. coin

Query Parameters

ledger_version

string

Ledger version to get state of account

If not provided, it will be the latest version

Response

200 - application/json

Move module bytecode along with it's ABI

bytecode

string

required

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

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

abi

object

A Move module

Show child attributes

abi.address

string

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.

abi.exposed_functions

object[]

required

Public functions of the module

Show child attributes

abi.exposed_functions.generic_type_params

object[]

required

Generic type params associated with the Move function

Show child attributes

abi.exposed_functions.generic_type_params.constraints

string[]

required

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

abi.exposed_functions.is_entry

boolean

required

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

abi.exposed_functions.name

string

required

abi.exposed_functions.params

string[]

required

Parameters associated with the move function

abi.exposed_functions.return

string[]

required

Return type of the function

abi.exposed_functions.visibility

enum<string>

required

Move function visibility

Available options:

private,

public,

friend

abi.friends

string[]

required

Friends of the module

abi.name

string

required

abi.structs

object[]

required

Structs of the module

Show child attributes

abi.structs.abilities

string[]

required

Abilities associated with the struct

abi.structs.fields

object[]

required

Fields associated with the struct

Show child attributes

abi.structs.fields.name

string

required

abi.structs.fields.type

string

required

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

Vector type value examples:
  - `vector<u8>`
  - `vector<vector<u64>>`
  - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`

Struct type value examples:
  - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
  - `0x1::account::Account`

Note:
  1. Empty chars should be ignored when comparing 2 struct tag ids.
  2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

abi.structs.generic_type_params

object[]

required

Generic types associated with the struct

Show child attributes

abi.structs.generic_type_params.constraints

string[]

required

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

abi.structs.is_native

boolean

required

Whether the struct is a native struct of Move

abi.structs.name

string

required