Accounts

Access to accounts, resources, and modules

Get account

get

Return the authentication key and the sequence number for an account address. Optionally, a ledger version can be specified. If the ledger version is not specified in the request, the latest ledger version is used.

Authorizations
Path parameters
addressstring · hexRequired

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: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
ledger_versionstring · uint64Optional

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
Responses
200Success
application/json
get
GET /v1/accounts/{address} HTTP/1.1
Host: apt.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "sequence_number": "32425224034",
  "authentication_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
}

Get account resources

get

Retrieves all account resources for a given account and 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.

Authorizations
Path parameters
addressstring · hexRequired

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: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
ledger_versionstring · uint64Optional

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
startstringOptional

Representation of a StateKey as a hex string. This is used for cursor based pagination.

Example: 0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879
limitinteger · uint16Optional

Max number of account resources to retrieve

If not provided, defaults to default page size.

Responses
200Success
application/json
get
GET /v1/accounts/{address}/resources HTTP/1.1
Host: apt.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  {
    "type": "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>",
    "data": {
      "authentication_key": "0x0000000000000000000000000000000000000000000000000000000000000001",
      "coin_register_events": {
        "counter": "0",
        "guid": {
          "id": {
            "addr": "0x1",
            "creation_num": "0"
          }
        }
      },
      "self_address": "0x1",
      "sequence_number": "0"
    }
  }
]

Get account modules

get

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.

Authorizations
Path parameters
addressstring · hexRequired

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: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
ledger_versionstring · uint64Optional

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
startstringOptional

Representation of a StateKey as a hex string. This is used for cursor based pagination.

Example: 0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879
limitinteger · uint16Optional

Max number of account modules to retrieve

If not provided, defaults to default page size.

Responses
200Success
application/json
get
GET /v1/accounts/{address}/modules HTTP/1.1
Host: apt.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

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

Get account resource

get

Retrieves an individual resource 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.

Authorizations
Path parameters
addressstring · hexRequired

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: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
resource_typestringRequired

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

  1. move_module_address, module_name and struct_name, all joined by ::
  2. struct generic type parameters joined by ,

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).

See doc for more details.

Example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>Pattern: ^0x[0-9a-zA-Z:_<>]+$
Query parameters
ledger_versionstring · uint64Optional

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
Responses
200Success
application/json
get
GET /v1/accounts/{address}/resource/{resource_type} HTTP/1.1
Host: apt.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "type": "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>",
  "data": {
    "authentication_key": "0x0000000000000000000000000000000000000000000000000000000000000001",
    "coin_register_events": {
      "counter": "0",
      "guid": {
        "id": {
          "addr": "0x1",
          "creation_num": "0"
        }
      }
    },
    "self_address": "0x1",
    "sequence_number": "0"
  }
}

Get account module

get

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.

Authorizations
Path parameters
addressstring · hexRequired

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: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
module_namestringRequired

Name of module to retrieve e.g. coin

Query parameters
ledger_versionstring · uint64Optional

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
Responses
200Success
application/json
get
GET /v1/accounts/{address}/module/{module_name} HTTP/1.1
Host: apt.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

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