Get account module

GET

/accounts/{address}/module/{module_name}

curl --request GET \
  --url 'https://example.com/v1/accounts/0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1/module/example?ledger_version=32425224034'

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.

Parameters

Path Parameters

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

Example

0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Address of account with or without a 0x prefix

module_name

required

string

Name of module to retrieve e.g. coin

Query Parameters

ledger_version

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

Example

32425224034

Ledger version to get state of account

If not provided, it will be the latest version

Responses

200

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:_<, >]+)$/

Example

{
  "bytecode": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1",
  "abi": {
    "address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1",
    "friends": [
      "0x1::aptos_coin"
    ],
    "exposed_functions": [
      {
        "visibility": "private"
      }
    ]
  }
}

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