Execute view function of a module

POST 
/view

Execute the Move function with the given parameters and return its execution result.

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.

Request

Query Parameters

ledger_version uint64

Ledger version to get state of account

If not provided, it will be the latest version

application/json

Body

required

function EntryFunctionId (string)required

Entry function id is string representation of a entry function defined on-chain.

Format: {address}::{module name}::{function name}

Both module name and function name are case-sensitive.

type_arguments MoveType (string)[]required

Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$

Type arguments of the function

arguments undefined[]required

Arguments of the function

application/x.aptos.view_function+bcs

Body

required

• Array [

integer

• ]

Responses

200

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

• X-APTOS-CURSOR

  string

  Cursor to be used for endpoints that support cursor-based pagination. Pass this to the start field of the endpoint on the next call to get the next page of results.

application/json

Schema

Schema

• Array [

anyOf

MOD1

integer

MOD2

integer

MOD3

integer

U64

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.

string

U128

A string containing a 128-bit unsigned integer.

We represent u128 values as a string to ensure compatibility with languages such as JavaScript that do not parse u128s in JSON natively.

string

U256

A string containing a 256-bit unsigned integer.

We represent u256 values as a string to ensure compatibility with languages such as JavaScript that do not parse u256s in JSON natively.

string

MOD7

boolean

Address

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.

string

MOD9

Array [

0

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

]

HexEncodedBytes

All bytes (Vec<u8&gt;) 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.

string

MoveStructValue

This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.

To clarify, you might query for 0x1::account::Account and see the example data.

Move bool type value is serialized into boolean.

Move u8, u16 and u32 type value is serialized into integer.

Move u64, u128 and u256 type value is serialized into string.

Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example:

• 0x1
• 0x1668f6be25668c1a17cd8caf6b8d2f25

Move vector type value is serialized into array, except vector<u8> which is serialized into a HexEncodedBytes string with 0x prefix. For example:

• vector<u64>{255, 255} => ["255", "255"]
• vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

\{
  field1_name: field1_value,
  field2_name: field2_value,
  ......
\}

For example: { "created": "0xa550c18", "role_id": "0" }

Special serialization for Move stdlib types:

• 0x1::string::String is serialized into string. For example, struct value 0x1::string::String{bytes: b"Hello World!"} is serialized as "Hello World!" in JSON.

object

MOD12

string

• ]

Example (from schema)

[
  0,
  0,
  0,
  "32425224034",
  "340282366920938463463374607431768211454",
  "340282366920938463463374607431768211454",
  true,
  "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
  [
    null
  ],
  "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
  {
    "authentication_key": "0x0000000000000000000000000000000000000000000000000000000000000001",
    "coin_register_events": {
      "counter": "0",
      "guid": {
        "id": {
          "addr": "0x1",
          "creation_num": "0"
        }
      }
    },
    "self_address": "0x1",
    "sequence_number": "0"
  },
  "string"
]

application/x-bcs

Schema

Schema

• Array [

integer

• ]

Example (from schema)

[
  0
]

400

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

403

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

404

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

410

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

500

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

503

Response Headers

• X-APTOS-CHAIN-ID

  integer

  Chain ID of the current chain

• X-APTOS-LEDGER-VERSION

  integer

  Current ledger version of the chain

• X-APTOS-LEDGER-OLDEST-VERSION

  integer

  Oldest non-pruned ledger version of the chain

• X-APTOS-LEDGER-TIMESTAMPUSEC

  integer

  Current timestamp of the chain

• X-APTOS-EPOCH

  integer

  Current epoch of the chain

• X-APTOS-BLOCK-HEIGHT

  integer

  Current block height of the chain

• X-APTOS-OLDEST-BLOCK-HEIGHT

  integer

  Oldest non-pruned block height of the chain

• X-APTOS-GAS-USED

  integer

  The cost of the call in terms of gas

application/json

Schema

Schema

message stringrequired

A message describing the error

error_code AptosErrorCode (string)required

Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]

These codes provide more granular error information beyond just the HTTP status code of the response.

vm_error_code uint64

A code providing VM error details when submitting transactions to the VM

Example (from schema)

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

Loading...