Skip to main content
GET
/
accounts
/
{address}
/
modules
Get account modules
curl --request GET \
  --url https://api.us1.shinami.com/aptos/node/v1/accounts/{address}/modules \
  --header 'Authorization: Bearer <token>'
[
  {
    "bytecode": 6.195948399647823e+76,
    "abi": {
      "address": 6.195948399647823e+76,
      "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>"
            }
          ]
        }
      ]
    }
  }
]

Authorizations

Authorization
string
header
required

Authorization: Bearer SHINAMI_ACCESS_KEY.

Path Parameters

address
string<hex>
required

Address of account with or without a 0x prefix 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.

Example:

6.195948399647823e+76

Query Parameters

ledger_version
string<uint64>

Ledger version to get state of account

If not provided, it will be the latest 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.

Example:

"32425224034"

start
string

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. Representation of a StateKey as a hex string. This is used for cursor based pagination.

Example:

"0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879"

limit
integer<uint16>

Max number of account modules to retrieve

If not provided, defaults to default page size.

Response

bytecode
string<hex>
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.

Example:

6.195948399647823e+76

abi
object

A Move module