Get Account Module

Retrieves an individual module from a given account and at a specific ledger version.

Get account module

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.

GEThttps://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/accounts/{address}/module/{module_name}

Path parameters

address*Address (string (hex))

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.

module_name*IdentifierWrapper (string)

Name of module to retrieve e.g. coin

Query parameters

Response

200400403404410500503

Headers

Body

application/jsonapplication/x-bcs

bytecode*HexEncodedBytes (string (hex))

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.

abiMoveModule (object)

A Move module

Request

JavaScriptCurl

const response = await fetch('https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/accounts/{address}/module/{module_name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "bytecode": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
  "abi": {
    "address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
    "name": "text",
    "friends": [
      "0x1::aptos_coin"
    ],
    "exposed_functions": [
      {
        "name": "text",
        "visibility": "private",
        "is_entry": false,
        "generic_type_params": [
          {
            "constraints": [
              "text"
            ]
          }
        ],
        "params": [
          "text"
        ],
        "return": [
          "text"
        ]
      }
    ],
    "structs": [
      {
        "name": "text",
        "is_native": false,
        "abilities": [
          "text"
        ],
        "generic_type_params": [
          {
            "constraints": [
              "text"
            ]
          }
        ],
        "fields": [
          {
            "name": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}