Get table item

POST

https://apt.nownodes.io/v1/tables/{table_handle}/item

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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.

Body

application/json

Table Item request for the GetTableItem API

key_typeMoveTyperequired

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}>

Copied!

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_typeMoveTyperequired

Copied!

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

keyanyrequired

The value of the table item's key

Parameters

table_handleAddress<hex>requiredpath

Table handle hex encoded 32-byte string

ledger_versionU64<uint64>query

Ledger version to get state of account

If not provided, it will be the latest version

Response

200OK

400Bad Request

403Forbidden

404Not Found

410Gone

500Internal Server Error

503Service Unavailable

Get table item

curl -X POST 'https://apt.nownodes.io/v1/tables/{table_handle}/item' \
  -H 'Content-Type: application/json' \
  -d '{
    "key_type": "string",
    "value_type": "string"
  }'

const response = await fetch('https://apt.nownodes.io/v1/tables/{table_handle}/item', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "key_type": "string",
      "value_type": "string"
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://apt.nownodes.io/v1/tables/{table_handle}/item')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "key_type": "string",
    "value_type": "string"
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "key_type": "string",
  "value_type": "string"
}

response = requests.post('https://apt.nownodes.io/v1/tables/{table_handle}/item', json=payload)
data = response.json()

const response = await fetch('https://apt.nownodes.io/v1/tables/{table_handle}/item', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "key_type": "string",
      "value_type": "string"
    }),
});

const data = await response.json();

const endpoint = "https://apt.nownodes.io/v1/tables/{table_handle}/item";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "key_type": "string",
    "value_type": "string"
  });
console.log(result);

const response = await fetch('https://apt.nownodes.io/v1/tables/{table_handle}/item', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "key_type": "string",
      "value_type": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "key_type": "string",
  "value_type": "string"
}

response = requests.post('https://apt.nownodes.io/v1/tables/{table_handle}/item', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://apt.nownodes.io/v1/tables/{table_handle}/item')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "key_type": "string",
    "value_type": "string"
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{
  "key_type": "string",
  "value_type": "string"
}

[
  0
]

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}

{
  "message": "string",
  "error_code": "account_not_found",
  "vm_error_code": 0
}