Execute view function of a module

POST

/view

curl --request POST \
  --url 'https://example.com/v1/view?ledger_version=32425224034' \
  --header 'Content-Type: application/json' \
  --data '{ "function": "0x1::aptos_coin::transfer", "type_arguments": [ "example" ], "arguments": [ "example" ] }'

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.

Parameters

Query Parameters

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

string format: uint64

Example

32425224034

Ledger version to get state of account

If not provided, it will be the latest version

Request Body ^required

View request for the Move View Function API

object

function

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.

string

Example

0x1::aptos_coin::transfer

type_arguments

required

Type arguments of the function

Array<string>

arguments

required

Arguments of the function

Array

Array<integer>

Responses

200

Array

Any of:

integer

Move u8 value

integer format: uint8

integer

Move u16 value

integer format: uint16

integer

Move u32 value

integer format: uint32

unknown

Move u64 value

string format: uint64

unknown

Move u128 value

string format: uint128

unknown

Move u256 value

string format: uint256

boolean

Move bool value

boolean

unknown

Move address value

string format: hex

Array

Move vector value

Array

unknown

Move bytes value

string format: hex

object

Move struct value

object

string

Move string value

string

Example

[
  "32425224034"
]

Array<integer>

Headers

X-APTOS-CHAIN-ID

required

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

required

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

required

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

required

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

required

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

required

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

required

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

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.

400

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

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

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

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

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas

403

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

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

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

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

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas

404

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

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

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

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

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas

410

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

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

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

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

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas

500

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

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

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

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

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas

503

Media type application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object

message

required

A message describing the error

string

error_code

required

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

string

Allowed 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 rejected_by_filter health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled

vm_error_code

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

integer format: uint64

Example

{
  "error_code": "account_not_found"
}

Headers

X-APTOS-CHAIN-ID

integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH

integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

integer format: uint64

The cost of the call in terms of gas