1 of 1

Get Account Modules

Retrieves all account modules' bytecode for a given account at a specific ledger version.

This method will use 60 Compute Units.

Get Account Modules

Retrieves all account modules' bytecode for a given account at a specific ledger version.

This method will use 60 Compute Units.

Get account modules

Retrieves all account modules' bytecode for a given account at a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used.

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

GEThttps://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/modules

Path parameters

address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

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

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

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

Query parameters

ledger_versionU64 (string (uint64))

A string containing a 64-bit unsigned integer.

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

Example: "32425224034"

startStateKeyWrapper (string)

Representation of a StateKey as a hex string. This is used for cursor based pagination.

Example:

"0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879"

limitinteger (uint16)

Max number of account modules to retrieve

If not provided, defaults to default page size.

Response

Headers

X-APTOS-CHAIN-ID*integer (uint8)

X-APTOS-LEDGER-VERSION*integer (uint64)

X-APTOS-LEDGER-OLDEST-VERSION*integer (uint64)

X-APTOS-LEDGER-TIMESTAMPUSEC*integer (uint64)

X-APTOS-EPOCH*integer (uint64)

X-APTOS-BLOCK-HEIGHT*integer (uint64)

X-APTOS-OLDEST-BLOCK-HEIGHT*integer (uint64)

X-APTOS-CURSORstring

Body

bytecode*HexEncodedBytes (string (hex))

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

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

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

abiMoveModule (object)

A Move module

address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

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

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

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

name*IdentifierWrapper (string)

friends*array of MoveModuleId (string)

Friends of the module

itemsMoveModuleId (string)

Move module id is a string representation of Move module.

Format: {address}::{module name}

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

Module name is case-sensitive.

Example: "0x1::aptos_coin"

exposed_functions*array of MoveFunction (object)

Public functions of the module

name*IdentifierWrapper (string)

visibility*MoveFunctionVisibility (enum)

Move function visibility

privatepublicfriend

is_entry*boolean

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

generic_type_params*array of MoveFunctionGenericTypeParam (object)

Generic type params associated with the Move function

constraints*array of MoveAbility (string)

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

itemsMoveAbility (string)

params*array of MoveType (string)

Parameters associated with the move function

itemsMoveType (string)

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

return*array of MoveType (string)

Return type of the function

itemsMoveType (string)

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

structs*array of MoveStruct (object)

Structs of the module

name*IdentifierWrapper (string)

is_native*boolean

Whether the struct is a native struct of Move

abilities*array of MoveAbility (string)

Abilities associated with the struct

itemsMoveAbility (string)

generic_type_params*array of MoveStructGenericTypeParam (object)

Generic types associated with the struct

constraints*array of MoveAbility (string)

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

itemsMoveAbility (string)

fields*array of MoveStructField (object)

Fields associated with the struct

name*IdentifierWrapper (string)

type*MoveType (string)

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

Request

Response

Get account modules

Retrieves all account modules' bytecode for a given account at a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used.

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

GEThttps://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/modules

Path parameters

address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

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

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

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

Query parameters

ledger_versionU64 (string (uint64))

A string containing a 64-bit unsigned integer.

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

Example: "32425224034"

startStateKeyWrapper (string)

Representation of a StateKey as a hex string. This is used for cursor based pagination.

Example:

"0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879"

limitinteger (uint16)

Max number of account modules to retrieve

If not provided, defaults to default page size.

Response

Headers

X-APTOS-CHAIN-ID*integer (uint8)

X-APTOS-LEDGER-VERSION*integer (uint64)

X-APTOS-LEDGER-OLDEST-VERSION*integer (uint64)

X-APTOS-LEDGER-TIMESTAMPUSEC*integer (uint64)

X-APTOS-EPOCH*integer (uint64)

X-APTOS-BLOCK-HEIGHT*integer (uint64)

X-APTOS-OLDEST-BLOCK-HEIGHT*integer (uint64)

X-APTOS-CURSORstring

Body

bytecode*HexEncodedBytes (string (hex))

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

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

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

abiMoveModule (object)

A Move module

address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

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

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

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

name*IdentifierWrapper (string)

friends*array of MoveModuleId (string)

Friends of the module

itemsMoveModuleId (string)

Move module id is a string representation of Move module.

Format: {address}::{module name}

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

Module name is case-sensitive.

Example: "0x1::aptos_coin"

exposed_functions*array of MoveFunction (object)

Public functions of the module

name*IdentifierWrapper (string)

visibility*MoveFunctionVisibility (enum)

Move function visibility

privatepublicfriend

is_entry*boolean

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

generic_type_params*array of MoveFunctionGenericTypeParam (object)

Generic type params associated with the Move function

constraints*array of MoveAbility (string)

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

itemsMoveAbility (string)

params*array of MoveType (string)

Parameters associated with the move function

itemsMoveType (string)

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

return*array of MoveType (string)

Return type of the function

itemsMoveType (string)

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

structs*array of MoveStruct (object)

Structs of the module

name*IdentifierWrapper (string)

is_native*boolean

Whether the struct is a native struct of Move

abilities*array of MoveAbility (string)

Abilities associated with the struct

itemsMoveAbility (string)

generic_type_params*array of MoveStructGenericTypeParam (object)

Generic types associated with the struct

constraints*array of MoveAbility (string)

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

itemsMoveAbility (string)

fields*array of MoveStructField (object)

Fields associated with the struct

name*IdentifierWrapper (string)

type*MoveType (string)

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

Request

Response

const response = await fetch('https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/modules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "bytecode": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
    "abi": {
      "address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
      "name": "text",
      "friends": [
        "0x1::aptos_coin"
      ],
      "exposed_functions": [
        {
          "name": "text",
          "visibility": "private",
          "is_entry": false,
          "generic_type_params": [
            {
              "constraints": [
                "text"
              ]
            }
          ],
          "params": [
            "text"
          ],
          "return": [
            "text"
          ]
        }
      ],
      "structs": [
        {
          "name": "text",
          "is_native": false,
          "abilities": [
            "text"
          ],
          "generic_type_params": [
            {
              "constraints": [
                "text"
              ]
            }
          ],
          "fields": [
            {
              "name": "text",
              "type": "text"
            }
          ]
        }
      ]
    }
  }
]