Accounts

Get account module

Changed on Oct 9, 2025

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 Lumio nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410.

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

Request

Base URL
/v1 (relative, and the document was published on a file host, not at the API’s origin)
URL
/v1/accounts/{address}/module/{module_name}
Auth
none declared

Path parameters

addressstring hex required

A hex encoded 32 byte Lumio 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.

Address of account with or without a 0x prefix

module_namestring required

Name of module to retrieve e.g. coin

Query parameters

ledger_versionstring 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

Ledger version to get state of account

If not provided, it will be the latest version

Response

bytecodestring hex 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 response

{
  "abi": {
    "friends": [
      "0x1::lumio_coin"
    ]
  }
}

Changes

Oct 9, 20255bfbbc5f3ce7 Revision changes
- breaking
  the mandatory response header X-APTOS-BLOCK-HEIGHT removed for the status 200
- breaking
  the mandatory response header X-APTOS-CHAIN-ID removed for the status 200
- breaking
  the mandatory response header X-APTOS-EPOCH removed for the status 200
- breaking
  the mandatory response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 200
- breaking
  the mandatory response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 200
- breaking
  the mandatory response header X-APTOS-LEDGER-VERSION removed for the status 200
- breaking
  the mandatory response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 200
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 400
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 403
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 404
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 410
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 500
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 503
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 400
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 403
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 404
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 410
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 500
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 503
- warning
  the optional response header X-APTOS-CURSOR removed for the status 200
- warning
  the optional response header X-APTOS-EPOCH removed for the status 400
- warning
  the optional response header X-APTOS-EPOCH removed for the status 403
- warning
  the optional response header X-APTOS-EPOCH removed for the status 404
- warning
  the optional response header X-APTOS-EPOCH removed for the status 410
- warning
  the optional response header X-APTOS-EPOCH removed for the status 500
- warning
  the optional response header X-APTOS-EPOCH removed for the status 503
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 200
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 400
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 403
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 404
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 410
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 500
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 503
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 400
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 403
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 404
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 410
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 500
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 503
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 400
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 403
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 404
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 410
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 500
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 503
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 400
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 403
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 404
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 410
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 500
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 503
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 400
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 403
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 404
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 410
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 500
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 503
Jun 3, 20256a8502f67ac1 Revision changes
- warning
  added the new rejected_by_filter enum value to the response property for the response status
- warning
  added the new rejected_by_filter enum value to the response property for the response status
- warning
  added the new rejected_by_filter enum value to the response property for the response status
- warning
  added the new rejected_by_filter enum value to the response property for the response status
- warning
  added the new rejected_by_filter enum value to the response property for the response status
- warning
  added the new rejected_by_filter enum value to the response property for the response status

Operation history (5 revisions)