Skip to main content

/v1/accounts/{address}/module/{module_name} REST API Endpoint

Retrieves the bytecode of an individual module associated with a specified account at a particular ledger version. If the ledger version is not explicitly provided in the request, the latest ledger version is used.

Updated on
Oct 04, 2023

Path Parameters

address
string
REQUIRED

The address associated with the account

module_name
string
REQUIRED

The name of module to retrieve

Query Parameters

ledger_version
string

The ledger version at the time of retrieving the account module

Returns

bytecode
string

The bytecode representation of the module

abi
object

The Application Binary Interface (ABI) of the move module

address
string

The address of the Aptos account

name
string

The name of the module

friends
array

The module friends

exposed_functions
array

The public functions of the module

name
string

The module name

visibility
string

The visibility of the module i.e public, private or friend

is_entry
boolean

A flag indicating whether the function is an entry function

is_view
boolean

A flag indicating whether the function is a view function or not

generic_type_params
array

The generic type parameters associated with the Move function

constraints
array

Any constraints associated with the module

type
string

(Optional) Move type parameter name when present in the module ABI

params
array

The parameters associated with the move function

return
array

The return type of the module

structs
array

The list of fields defined within the module

name
string

The name of the module

is_native
boolean

A flag indicating whether the module is native, meaning it is implemented in a language other than Move

is_event
boolean

Whether the struct is a Move event struct

is_enum
boolean

Whether the struct is a Move enum

abilities
array

The list of abilities or capabilities provided by the module

generic_type_params
array

The generic type parameters associated with the module

constraints
array

Any constraints associated with the module

type
string

(Optional) Move type parameter name when present in the module ABI

variants
array

Enum variants when is_enum is true

fields
array

The list of fields defined within the module

name
string

The module name

type
string

The type of module

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free