APaptoslabs
View

Execute view function of a module

Changed on

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.

post/view

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/view
  • Auth
    none declared

Query parameters

ledger_versionstring uint64

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

Ledger version to get state of account

If not provided, it will be the latest version

Request body

functionstring 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_argumentsMoveType[] required

Type arguments of the function

Example request

{
  "function": "0x1::aptos_coin::transfer"
}

Response

MoveValue[] required

Example response

[
  {
    "authentication_key": "0x0000000000000000000000000000000000000000000000000000000000000001",
    "coin_register_events": {
      "counter": "0",
      "guid": {
        "id": {
          "addr": "0x1",
          "creation_num": "0"
        }
      }
    },
    "self_address": "0x1",
    "sequence_number": "0"
  }
]

Changes

  • fddae5eeba26Revision changes
    • warning

      added the new node_not_bootstrapped enum value to the response property for the response status

    • warning

      added the new node_not_bootstrapped enum value to the response property for the response status

    • warning

      added the new node_not_bootstrapped enum value to the response property for the response status

    • warning

      added the new node_not_bootstrapped enum value to the response property for the response status

    • warning

      added the new node_not_bootstrapped enum value to the response property for the response status

    • warning

      added the new node_not_bootstrapped enum value to the response property for the response status

  • 10ecd1005697Revision changes
    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status