OAS 3.0.0

Aptos Node API

The Aptos Node API is a RESTful API for client applications to interact with the Aptos blockchain.

Base URL

Client Libraries

Shell

Ruby

Node.js

PHP

Python

cURL Shell

Accounts

Access to accounts, resources, and modules

Endpoints

GET/accounts/{address}GET/accounts/{address}/resources GET/accounts/{address}/balance/{asset_type}GET/accounts/{address}/modules GET/accounts/{address}/resource/{resource_type}GET/accounts/{address}/module/{module_name}

Get account

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.

Path Parameters

address
required
string hex

Address of account with or without a 0x prefix

Example0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Query Parameters

ledger_version
string uint64

Ledger version to get state of account

If not provided, it will be the latest version

Example32425224034

Responses

200
application/json
400
application/json
403
application/json
404
application/json
410
application/json
500
application/json
503
application/json

GET/accounts/{address}

Shell cURL

curl --request GET \
  --url https://api.mainnet.aptoslabs.com/v1/accounts/0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Show Schema

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

Get account resources

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.

Path Parameters

address
required
string hex

Address of account with or without a 0x prefix

Example0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Query Parameters

ledger_version
string uint64

Ledger version to get state of account

If not provided, it will be the latest version

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

Example0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879
limit
integer uint16

Max number of account resources to retrieve

If not provided, defaults to default page size.

Responses

200
application/json
400
application/json
403
application/json
404
application/json
410
application/json
500
application/json
503
application/json

GET/accounts/{address}/resources

Shell cURL

curl --request GET \
  --url https://api.mainnet.aptoslabs.com/v1/accounts/0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 /resources

Show Schema

[
  {
    "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 resources

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.

Path Parameters

address
required
string hex

Address of account with or without a 0x prefix

Example0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
asset_type
required
string hex

A hex encoded 32 byte Aptos account address or a struct tag.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x or Format: {address}::{module name}::{struct name}

Example0x1::aptos_coin::AptosCoin

Query Parameters

ledger_version
string uint64

Ledger version to get state of account

If not provided, it will be the latest version

Example32425224034

Responses

200
application/json
400
application/json
403
application/json
404
application/json
410
application/json
500
application/json
503
application/json

GET/accounts/{address}/balance/{asset_type}

Shell cURL

curl --request GET \
  --url https://api.mainnet.aptoslabs.com/v1/accounts/0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 /balance/0x1::aptos_coin::AptosCoin

Show Schema

Get account 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.

Path Parameters

address
required
string hex

Address of account with or without a 0x prefix

Example0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Query Parameters

ledger_version
string uint64

Ledger version to get state of account

If not provided, it will be the latest version

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

Example0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879
limit
integer uint16

Max number of account modules to retrieve

If not provided, defaults to default page size.

Responses

200
application/json
400
application/json
403
application/json
404
application/json
410
application/json
500
application/json
503
application/json

GET/accounts/{address}/modules

Shell cURL

curl --request GET \
  --url https://api.mainnet.aptoslabs.com/v1/accounts/0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 /modules

Show Schema

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

Get account resource

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.

Path Parameters

address
required
string hex

Address of account with or without a 0x prefix

Example0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
resource_type
required
string ^0x[0-9a-zA-Z:_<>]+$

Name of struct to retrieve e.g. 0x1::account::Account

Example0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

Query Parameters

ledger_version
string uint64

Ledger version to get state of account

If not provided, it will be the latest version

Example32425224034

Responses

200
application/json
400
application/json
403
application/json
404
application/json
410
application/json
500
application/json
503
application/json

GET/accounts/{address}/resource/{resource_type}

Shell cURL

curl --request GET \
  --url https://api.mainnet.aptoslabs.com/v1/accounts/0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 /resource/0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>

Show Schema

{
  "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"
  }
}

Models

ledger_version

Value

Response

.,,uod8B8bou,,. ..,uod8BBBBBBBBBBBBBBBBRPFT?l!i:. ||||||||||||||!?TFPRBBBBBBBBBBBBBBB8m=, |||| '""^^!!||||||||||TFPRBBBVT!:...! |||| '""^^!!|||||?!:.......! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! ||||, ||||.........` |||||!!-._ ||||.......;. ':!|||||||||!!-._ ||||.....bBBBBWdou,. bBBBBB86foi!|||||||!!-..:|||!..bBBBBBBBBBBBBBBY! ::!?TFPRBBBBBB86foi!||||||||!!bBBBBBBBBBBBBBBY..! :::::::::!?TFPRBBBBBB86ftiaabBBBBBBBBBBBBBBY....! :::;`"^!:;::::::!?TFPRBBBBBBBBBBBBBBBBBBBY......! ;::::::...''^::::::::::!?TFPRBBBBBBBBBBY........! .ob86foi;::::::::::::::::::::::::!?TFPRBY..........` .b888888888886foi;:::::::::::::::::::::::..........` .b888888888888888888886foi;::::::::::::::::...........b888888888888888888888888888886foi;:::::::::......`!Tf998888888888888888888888888888888886foi;:::....` '"^!|Tf9988888888888888888888888888888888!::..` '"^!|Tf998888888888888888888888889!! '` '"^!|Tf9988888888888888888!!` iBBbo. '"^!|Tf998888888889!` WBBBBbo. '"^!|Tf9989!` YBBBP^' '"^!` `

Aptos Node API

Accounts​ # Copy link to "Accounts"

Get account​ # Copy link to "Get account"

Get account resources​ # Copy link to "Get account resources"

Get account resources​ # Copy link to "Get account resources"

Get account modules​ # Copy link to "Get account modules"

Get account resource​ # Copy link to "Get account resource"

Models

Accounts

Get account

Get account resources

Get account resources

Get account modules

Get account resource