POST
/
view
Execute view function of a module
curl --request POST \
  --url https://api.us1.shinami.com/aptos/node/v1/view \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "function": "0x1::aptos_coin::transfer",
  "type_arguments": [
    "<string>"
  ],
  "arguments": [
    "<any>"
  ]
}'
[
  {
    "authentication_key": "0x0000000000000000000000000000000000000000000000000000000000000001",
    "coin_register_events": {
      "counter": "0",
      "guid": {
        "id": {
          "addr": "0x1",
          "creation_num": "0"
        }
      }
    },
    "self_address": "0x1",
    "sequence_number": "0"
  }
]

Authorizations

​
Authorization
string
header
required

Authorization: Bearer SHINAMI_ACCESS_KEY.

Query Parameters

​
ledger_version
string<uint64>

Ledger version to get state of account

If not provided, it will be the latest version

Example:

"32425224034"

Body

View request for the Move View Function API

​
function
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.

Example:

"0x1::aptos_coin::transfer"

​
type_arguments
string[]
required

Type arguments of the function

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples:
  - `vector<u8>`
  - `vector<vector<u64>>`
  - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`

Struct type value 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).
​
arguments
any[]
required

Arguments of the function

Response

The response is of type object[].