Get table item

post https://api.shinami.com/aptos/node/v1/tables/{table_handle}/item

Description

Get a table item at a specific ledger version from the table identified by {table_handle} in the path and the "key" (TableItemRequest) provided in the request body.

This is a POST endpoint because the "key" for requesting a specific table item (TableItemRequest) could be quite complex, as each of its fields could themselves be composed of other structs. This makes it impractical to express using query params, meaning GET isn't an option.

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

Path Params

table_handle

string

required

Table handle hex encoded 32-byte string

Query Params

ledger_version

string

Ledger version to get state of account

If not provided, it will be the latest version

Body Params

key_type

string

required

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

value_type

string

required

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

key

string

required

The value of the table item's key

Headers

Authorization

string

required

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

Responses

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.

200

400

403

404

410

500

503