Overview

API References Overview

Aptos

Indexer GraphQL API
Fullnode REST API
Gas Station
- Gas Station API
Wallet Services
- Invisible Wallet API

Sui

Node Service
Gas Station
- Gas Station API
Wallet Services
- Invisible Wallet API
- zkLogin wallet API

Overview

API References Overview

Aptos

Indexer GraphQL API
Fullnode REST API
Gas Station
- Gas Station API
Wallet Services
- Invisible Wallet API

Sui

Node Service
Gas Station
- Gas Station API
Wallet Services
- Invisible Wallet API
- zkLogin wallet API

Execute view function of a module

post https://api.shinami.com/aptos/node/v1/view

Description

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.

Authentication

Authentication is via an 'Authorization: Bearer YOUR_API_ACCESS_KEY' header (which you must add to the sample requests).

Query Params

ledger_version

string

Ledger version to get state of account

If not provided, it will be the latest version

Body Params

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.

type_arguments

array of strings

required

Type arguments of the function

type_arguments*

arguments

array

required

Arguments of the function

arguments*

Headers

Authorization

string

required

An API Access Key tied to the network you want to interact with (Testnet, Mainnet).

Responses

Response body

Headers

object

X-APTOS-CHAIN-ID

uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

uint64

Current timestamp of the chain

X-APTOS-EPOCH

uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

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.

Response body

object

message

string

required

A message describing the error

error_code

string

required

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

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

vm_error_code

uint64

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

Headers

object

X-APTOS-CHAIN-ID

uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

uint64

Current timestamp of the chain

X-APTOS-EPOCH

uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

uint64

The cost of the call in terms of gas

Response body

object

message

string

required

A message describing the error

error_code

string

required

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

Headers

object

X-APTOS-CHAIN-ID

uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

uint64

Current timestamp of the chain

X-APTOS-EPOCH

uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

uint64

The cost of the call in terms of gas

Response body

object

message

string

required

A message describing the error

error_code

string

required

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

Headers

object

X-APTOS-CHAIN-ID

uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

uint64

Current timestamp of the chain

X-APTOS-EPOCH

uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

uint64

The cost of the call in terms of gas

Response body

object

message

string

required

A message describing the error

error_code

string

required

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

Headers

object

X-APTOS-CHAIN-ID

uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

uint64

Current timestamp of the chain

X-APTOS-EPOCH

uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

uint64

The cost of the call in terms of gas

Response body

object

message

string

required

A message describing the error

error_code

string

required

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

Headers

object

X-APTOS-CHAIN-ID

uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

uint64

Current timestamp of the chain

X-APTOS-EPOCH

uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

uint64

The cost of the call in terms of gas

Response body

object

message

string

required

A message describing the error

error_code

string

required

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

Headers

object

X-APTOS-CHAIN-ID

uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION

uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION

uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC

uint64

Current timestamp of the chain

X-APTOS-EPOCH

uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT

uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT

uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED

uint64

The cost of the call in terms of gas

Updated 27 days ago

Estimate gas price

Gas Station

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.shinami.com/aptos/node/v1/view \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
 
1
[
2
  null
3
]

Updated 27 days ago

Estimate gas price

Gas Station

Did this page help you?

Headers

Response

X-APTOS-CHAIN-ID	Chain ID of the current chain
X-APTOS-LEDGER-VERSION	Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION	Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC	Current timestamp of the chain
X-APTOS-EPOCH	Current epoch of the chain
X-APTOS-BLOCK-HEIGHT	Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT	Oldest non-pruned block height of the chain
X-APTOS-GAS-USED	The cost of the call in terms of gas
X-APTOS-CURSOR	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.

Overview
API References Overview

Aptos
Indexer GraphQL API
Fullnode REST API
View
Execute view function of a modulepost
Transactions
Estimate gas priceget
Encode submissionpost
Simulate transactionpost
Submit batch transactionspost
Get account transactionsget
Get transaction by versionget
Wait for transaction by hashget
Get transaction by hashget
Submit transactionpost
Get transactionsget
Tables
Get raw table itempost
Get table itempost
General
Get ledger infoget
Check basic node healthget
Show some basic info of the node.get
Show OpenAPI explorerget
Events
Get events by event handleget
Get events by creation numberget
Blocks
Get blocks by versionget
Get blocks by heightget
Accounts
Get account moduleget
Get account resourceget
Get account modulesget
Get account balanceget
Get account resourcesget
Get accountget
Overview
Gas Station
Gas Station API
Wallet Services
Invisible Wallet API

Sui
Node Service
WebSocket API (deprecated; being deactivated soon)
Transaction Builder API
Write API
Read API: network and Move data
Read API: objects and coins
Read API: events and transactions
Overview
Gas Station
Gas Station API
Wallet Services
zkLogin wallet API
Invisible Wallet API

Overview
API References Overview

Aptos
Indexer GraphQL API
Fullnode REST API
View
Execute view function of a modulepost
Transactions
Estimate gas priceget
Encode submissionpost
Simulate transactionpost
Submit batch transactionspost
Get account transactionsget
Get transaction by versionget
Wait for transaction by hashget
Get transaction by hashget
Submit transactionpost
Get transactionsget
Tables
Get raw table itempost
Get table itempost
General
Get ledger infoget
Check basic node healthget
Show some basic info of the node.get
Show OpenAPI explorerget
Events
Get events by event handleget
Get events by creation numberget
Blocks
Get blocks by versionget
Get blocks by heightget
Accounts
Get account moduleget
Get account resourceget
Get account modulesget
Get account balanceget
Get account resourcesget
Get accountget
Overview
Gas Station
Gas Station API
Wallet Services
Invisible Wallet API

Sui
Node Service
WebSocket API (deprecated; being deactivated soon)
Transaction Builder API
Write API
Read API: network and Move data
Read API: objects and coins
Read API: events and transactions
Overview
Gas Station
Gas Station API
Wallet Services
zkLogin wallet API
Invisible Wallet API

200

400

403

404

410

500

503