Get account modules
GET/accounts/:address/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.
Request
Path Parameters
Address of account with or without a 0x
prefix
Query Parameters
Ledger version to get state of account
If not provided, it will be the latest version
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.
Max number of account modules to retrieve
If not provided, defaults to default page size.
Responses
- 200
- 400
- 403
- 404
- 410
- 500
- 503
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
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.
- application/json
- application/x-bcs
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
]
All bytes (Vec0x
and fulfilled with
two hex digits per byte.
Unlike the Address
type, HexEncodedBytes will not trim any zeros.
0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
abi
object
A Move module
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.
0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Friends of the module
exposed_functions
object[]
required
Public functions of the module
Move function visibility
Possible values: [private
, public
, friend
]
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
structs
object[]
required
Structs of the module
Whether the struct is a native struct of Move
Whether the struct is marked with the #[event] annotation
Abilities associated with the struct
generic_type_params
object[]
required
Generic types associated with the struct
Move abilities tied to the generic type param and associated with the type that uses it
fields
object[]
required
Fields associated with the struct
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).
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
[
{
"bytecode": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"abi": {
"address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
"name": "string",
"friends": [
"0x1::aptos_coin"
],
"exposed_functions": [
{
"name": "string",
"visibility": "private",
"is_entry": true,
"is_view": true,
"generic_type_params": [
{
"constraints": [
"string"
]
}
],
"params": [
"string"
],
"return": [
"string"
]
}
],
"structs": [
{
"name": "string",
"is_native": true,
"is_event": true,
"abilities": [
"string"
],
"generic_type_params": [
{
"constraints": [
"string"
]
}
],
"fields": [
{
"name": "string",
"type": "string"
}
]
}
]
}
}
]
- Schema
- Example (from schema)
Schema
Array [
]
integer
[
0
]
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
These codes provide more granular error information beyond just the HTTP status code of the response.
Possible 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
, health_check_failed
, mempool_is_full
, internal_error
, web_framework_error
, bcs_not_supported
, api_disabled
]
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
These codes provide more granular error information beyond just the HTTP status code of the response.
Possible 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
, health_check_failed
, mempool_is_full
, internal_error
, web_framework_error
, bcs_not_supported
, api_disabled
]
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
These codes provide more granular error information beyond just the HTTP status code of the response.
Possible 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
, health_check_failed
, mempool_is_full
, internal_error
, web_framework_error
, bcs_not_supported
, api_disabled
]
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
These codes provide more granular error information beyond just the HTTP status code of the response.
Possible 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
, health_check_failed
, mempool_is_full
, internal_error
, web_framework_error
, bcs_not_supported
, api_disabled
]
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
These codes provide more granular error information beyond just the HTTP status code of the response.
Possible 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
, health_check_failed
, mempool_is_full
, internal_error
, web_framework_error
, bcs_not_supported
, api_disabled
]
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
These codes provide more granular error information beyond just the HTTP status code of the response.
Possible 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
, health_check_failed
, mempool_is_full
, internal_error
, web_framework_error
, bcs_not_supported
, api_disabled
]
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}