Get account modules

GET

accounts

{address}

modules

curl --request GET \
  --url https://aptos-mainnet.s.chainbase.online/{api-key}/v1/accounts/{address}/modules

[
  {
    "bytecode": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
    "abi": {
      "address": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
      "name": "<string>",
      "friends": [
        "0x1::aptos_coin"
      ],
      "exposed_functions": [
        {
          "name": "<string>",
          "visibility": "private",
          "is_entry": true,
          "generic_type_params": [
            {
              "constraints": [
                "<string>"
              ]
            }
          ],
          "params": [
            "<string>"
          ],
          "return": [
            "<string>"
          ]
        }
      ],
      "structs": [
        {
          "name": "<string>",
          "is_native": true,
          "abilities": [
            "<string>"
          ],
          "generic_type_params": [
            {
              "constraints": [
                "<string>"
              ]
            }
          ],
          "fields": [
            {
              "name": "<string>",
              "type": "<string>"
            }
          ]
        }
      ]
    }
  }
]

Path Parameters

address

string

required

Address of account with or without a 0x prefix

Example:

"0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"

Query Parameters

ledger_version

string

Ledger version to get state of account

If not provided, it will be the latest version

Example:

"32425224034"

start

string

Cursor specifying where to start for pagination

This cursor cannot be derived manually client-side. Instead, you must call this endpoint once without this query parameter specified, and then use the cursor returned in the X-Aptos-Cursor header in the response.

Example:

"0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879"

limit

integer

Max number of account modules to retrieve

If not provided, defaults to default page size.

Response

200

application/json

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.

Example:

"0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"

abi

object

A Move module

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.

Example:

"0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"

abi.name

string

required

abi.friends

string[]

required

Friends of the module

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.

abi.exposed_functions

object[]

required

Public functions of the module

Move function

abi.exposed_functions.name

string

required

abi.exposed_functions.visibility

enum<string>

required

Move function visibility

Available options:

private,

public,

friend

abi.exposed_functions.is_entry

boolean

required

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

abi.exposed_functions.generic_type_params

object[]

required

Generic type params associated with the Move function

Move function generic type param

abi.exposed_functions.params

string[]

required

Parameters associated with the move function

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.exposed_functions.return

string[]

required

Return type of the function

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

object[]

required

Structs of the module

A move struct

abi.structs.name

string

required

abi.structs.is_native

boolean

required

Whether the struct is a native struct of Move

abi.structs.abilities

string[]

required

Abilities associated with the struct

abi.structs.generic_type_params

object[]

required

Generic types associated with the struct

Move generic type param

abi.structs.fields

object[]

required

Fields associated with the struct

Move struct field

abi.structs.fields.name

string

required

abi.structs.fields.type

string

required

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

curl --request GET \
  --url https://aptos-mainnet.s.chainbase.online/{api-key}/v1/accounts/{address}/modules

[
  {
    "bytecode": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
    "abi": {
      "address": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
      "name": "<string>",
      "friends": [
        "0x1::aptos_coin"
      ],
      "exposed_functions": [
        {
          "name": "<string>",
          "visibility": "private",
          "is_entry": true,
          "generic_type_params": [
            {
              "constraints": [
                "<string>"
              ]
            }
          ],
          "params": [
            "<string>"
          ],
          "return": [
            "<string>"
          ]
        }
      ],
      "structs": [
        {
          "name": "<string>",
          "is_native": true,
          "abilities": [
            "<string>"
          ],
          "generic_type_params": [
            {
              "constraints": [
                "<string>"
              ]
            }
          ],
          "fields": [
            {
              "name": "<string>",
              "type": "<string>"
            }
          ]
        }
      ]
    }
  }
]

API Reference

Web3 API

SQL API

Path Parameters

Query Parameters

Response