The Indexer API allows you to access rich data about tokens, fungible assets, and accounts on-chain using GraphQL queries. You can access it here.
For common queries, check out the sidebar for examples to work from. When building your own, this reference guide should help you determine which tables are most relevant, and how to format your queries.
To ensure your queries filter data efficiently, check out the available indexes for each table.
Some indexes are composite B-tree indexes, meaning they consist of multiple columns.
B-tree indexes are ordered and perform optimally when queries utilize a left-most prefix of the indexed columns.
The value of a token property after the transaction. Ex. “100”
before_value
String
The value of a token property before the transaction. Ex. “50”
entry_function_id_str
String
The identifier of the function called in this transaction. Ex. “0x1::aptos_account::transfer”
event_account_address
String
This is an Aptos account address related to the event. This address must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
event_index
bigint
Yes
Index of the event within the transaction. Ex. 1
from_address
String
This is an Aptos account address from which the token was sent. This address must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
is_fungible_v2
Boolean
Indicates whether the token is fungible. Soon to be deprecated. Ex. False for NFTs.
property_version_v1
bigint
The version of the token’s properties under schema version 1. This field is only for token standard v1. It is always 0 for v2. Ex. 0
to_address
String
This is an Aptos account address to which the token was sent. This address must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
token_amount
bigint
The amount of the token transferred in this activity. Ex. 3
token_data_id
String
Unique identifier for this particular token’s data. For token standard v1, this is derived from a combination of creator_address, collection_name, and token_name. This ID must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
token_standard
String
Aptos standard that the collection adheres to. Ex. “v1”
transaction_timestamp
String
Timestamp when the transaction occurred. Ex. “2024-04-17T02:14:25.68771”
transaction_version
bigint
Yes
Blockchain version of the transaction. Ex. 10000000
type
String
Type of transfer - like “deposit” or “withdrawal”. Ex. “0x3::token::DepositEvent”
Has an aggregate view for summary data called current_token_ownerships_v2_aggregate
This table tracks who owns which NFTs. This includes both v1 and v2 tokens. Fungible tokens are not tracked as consistently.
Field
Type
Primary Key
Description
composed_nfts_aggregate
Join
Aggregate information about the composed NFTs, such as count or other statistics.
current_token_data
Join
Detailed information about the token’s current data; structure is defined in a related table.
amount
bigint
The amount of the token owned. Example: 1 for an NFT.
composed_nfts
Array
An array containing the IDs of NFTs that compose this token, if applicable.
is_fungible_v2
Boolean
Indicates whether the token is fungible. Example: true or null
is_soulbound_v2
Boolean
Indicates whether the token is soulbound (non-transferable once owned). Example: true or null
last_transaction_timestamp
String
Timestamp of the last transaction involving the token. Example: “2024-04-17T02:14:25.68771”
last_transaction_version
bigint
The version number of the last transaction involving the token. Example: 20747031
non_transferrable_by_owner
Boolean
Indicates whether the token is non-transferrable by the owner. Example: true or null
owner_address
String
Yes
The Aptos account address that currently owns the token. Addresses must be 66 characters so may be 0 padded. Example: “0xa815a9a09105973084bfc31530e7c8f002846787c2f0521e1e34dc144ad83b89”
property_version_v1
bigint
Yes
The version number of the token’s properties as of the last update. This field is only for token standard v1. It is always 0 for v2. Example: 0
storage_id
String
Yes
A unique identifier used for storage purposes. IDs must be 66 characters long, so may be 0 padded. Ex. “0xd8d41ff9f67d17d7dee061b5b683b92013b420cb6a30c21fc7c287454792d7a8”
table_type_v1
String
The Move function type. Example: “0x3::token::TokenStore”
token_data_id
String
Yes
A unique identifier for the token data, typically a hash or a numeric ID. Ex. “0x3d911af2dc3e47848fbba17b8694cf526942be183b84f8393a6c048232fb976d”
token_properties_mutated_v1
Object
Properties of the token that have been mutated from the original. Often in JSON or similar format. Example:
token_standard
String
The standard used to generate this token. Ex. “v1” or “v2”
Unique identifier for the collection. IDs must be 66 characters long, and so may be 0 padded. Ex. “0xa815a9a09105973084bfc31530e7c8f002846787c2f0521e1e34dc144ad83b88”
collection_name
String
The formal name of the collection. Ex. “Mythic Dragons”
creator_address
String
This is an Aptos account address that created the collection. Addresses must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
current_supply
bigint
Current supply of tokens in this collection. Ex. 500
description
String
Description of the collection. Ex. “A collection of rare digital dragons.”
last_transaction_timestamp
String
Timestamp of the last transaction involving this collection. Ex. “2024-04-17T02:14:25.68771”
last_transaction_version
bigint
Blockchain version of the last transaction involving this collection. Ex. 3000000002
max_supply
bigint
Maximum possible quantity of tokens in this collection. If the max supply is 0, there is no limit on the supply. Ex. 1000
mutable_description
String
Changeable description of the collection. Ex. “Updated collection description.”
mutable_uri
Boolean
True if the uri is changeable by the creator. Ex. True
table_handle_v1
String
Legacy identifier handle for the collection in earlier schema versions. Ex. “handle_12345”
token_standard
String
Aptos standard that the collection adheres to. Ex. “v1”
total_minted_v2
bigint
Total number of tokens minted in this collection under schema version 2. Ex. 800
Unique identifier for the collection. IDs must be 66 characters long, and so may be 0 padded. Ex. “0xa815a9a09105973084bfc31530e7c8f002846787c2f0521e1e34dc144ad83b89”
collection_name
String
The formal name of the collection. Ex. “Mythic Dragons”
This is an Aptos account address that created the collection. Addresses must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
distinct_tokens
bigint
The count of distinct tokens owned within this collection. Ex. 150
last_transaction_version
bigint
The version number of the last transaction involving this collection. Ex. 3000000002
owner_address
String
Yes
This is an Aptos account address that currently owns the token. Addresses must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
This tracks the metadata tied to each fungible asset (ex. decimals of precision). It includes v1 token data. This is a current_ table.
Field
Type
Primary Key
Description
asset_type
String
Yes
The type of the asset, described by a Move resource. Ex. “0x1::aptos_coin::AptosCoin”
creator_address
String
This is an Aptos account address that created the asset. Addresses must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
decimals
bigint
Number of decimal places for token value, typically for fungible tokens. Ex. 18
The amount of the asset involved in the activity. Ex. 1000
asset_type
String
Yes
The type of the asset, described by a Move resource. For fungible assets, this will be the address of the metadata object. Ex. “0x1::aptos_coin::AptosCoin”
block_height
bigint
The blockchain id at which this activity occurred. Ex. 1500000
entry_function_id_str
String
The identifier of the function called in this transaction. Ex. “0x1::aptos_account::transfer”
event_index
bigint
Index of the event within the transaction. Ex. 1
gas_fee_payer_address
String
This is an Aptos account address that paid the gas fee for the transaction. Addresses must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
is_frozen
Boolean
True if this activity is a freeze asset activity. Ex. null
is_gas_fee
Boolean
Indicates whether this activity involved a gas fee. Ex. True
is_transaction_success
Boolean
Indicates whether the transaction was successful. Ex. True
metadata
Object
Use the Hasura explorer to see fields for metadata in this table.
owner_address
String
This is an Aptos account address that owns the asset. Addresses must be 66 characters long, and so may be 0 padded. Ex. “0xa815a9a09105973084bfc31530e7c8f002846787c2f0521e1e34dc144ad83b89”
storage_id
String
Identifier for the storage used in the transaction. IDs must be 66 characters long, and so may be 0 padded. Ex. “0xa815a9a09105973084bfc31530e7c8f002846787c2f0521e1e34dc144ad83b89”
storage_refund_amount
bigint
Amount refunded for storage after the transaction. This is always in APT octas. Ex. 50
token_standard
String
Aptos standard that the collection adheres to. Ex. “v1”
transaction_timestamp
String
Timestamp when the transaction occurred. Ex. “2024-04-17T02:14:25.68771”
transaction_version
bigint
Blockchain version of the transaction. Ex. 2
type
String
Type of the transaction, described by a Move entry function. Ex. “0x1::coin::WithdrawEvent”
Has an aggregate view for summary data called current_fungible_asset_balances_aggregate
This tracks the asset balances of each account on-chain. It includes v1 token data.
Field
Type
Primary Key
Description
amount
bigint
The amount of the asset owned. Ex. 2000
asset_type
String
The type of the asset, described by a Move resource. For v2 tokens this is the address of the fungible asset metadata object. For v1 it’s the fully qualified path of the move resource. Ex. “0x1::aptos_coin::AptosCoin”
is_frozen
Boolean
Indicates whether the account is frozen. Ex. False
is_primary
Boolean
Indicates whether this is the primary balance of the owner. Ex. True
last_transaction_timestamp
String
Timestamp of the last transaction involving this balance. Ex. “2024-04-17T02:14:25.68771”
last_transaction_version
bigint
Blockchain version of the last transaction involving this balance. Ex. 30000000
metadata
Object
Use the Hasura explorer to see fields for metadata in current_fungible_asset_balances.
owner_address
String
This is an Aptos account address that owns the asset. Addresses must be 66 characters long, and so may be 0 padded. Ex. “0xa815a9a09105973084bfc31530e7c8f002846787c2f0521e1e34dc144ad83b89”
storage_id
String
Yes
Identifier for the storage associated with this balance. IDs must be 66 characters long, and so may be 0 padded. Ex. “0xa815a9a09105973084bfc31530e7c8f002846787c2f0521e1e34dc144ad83b89”
token_standard
String
Aptos standard that the collection adheres to. Ex. “v1”
With AIP-6 we added the ability for staking pools to be formed with delegated funds (delegation pools). Once these pools hold over 1M APT, they can become a staking pool (validator node).
The domain associated with this Aptos name. Ex. “example.crypto”
domain_with_suffix
String
The full domain name including any suffix. Ex. “example.crypto.aptos”
expiration_timestamp
String
Timestamp when the domain registration expires. Ex. “2024-04-17T02:14:25.68771”
is_active
Boolean
Indicates whether the domain is currently active. Ex. True
is_domain_owner
Boolean
Indicates whether the registered address is the owner of the domain. Ex. False
is_primary
Boolean
Indicates whether this is the primary domain for the registered address. Ex. True
last_transaction_version
bigint
The version number of the last transaction involving this domain. Ex. 5000000
owner_address
String
This is an Aptos account address that owns the domain. Addresses must be 66 characters long, and so may be 0 padded. Ex. “0x123abc456def7890abcdef1234567890abcdef1234”
registered_address
String
This is an Aptos account address registered to the domain. Addresses must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
subdomain
String
Any subdomain part of the domain name. Ex. “sub.example”
token_name
String
The name of the token associated with this domain. Ex. “ExampleToken”
token_standard
String
Aptos standard that the collection adheres to. Ex. “v1”
This table maps tokens, standards, and addresses to human readable names.
Field
Type
Primary Key
Description
domain
String
Yes
The domain associated with this Aptos name. Ex. “example.crypto”
expiration_timestamp
String
Timestamp when the domain registration expires. Ex. “2024-04-17T02:14:25.68771”
is_deleted
Boolean
Indicates whether the domain registration has been deleted. Ex. False
last_transaction_version
bigint
The version number of the last transaction involving this domain. Ex. 5000000
registered_address
String
This is an Aptos account address registered to the domain. Addresses must be 66 characters long, and so may be 0 padded. Ex. “0x50bc83f01d48ab3b9c00048542332201ab9cbbea61bda5f48bf81dc506caa78a”
subdomain
String
Yes
Any subdomain part of the domain name. Ex. “sub.example”
token_name
String
The name of the token associated with this domain. Ex. “ExampleToken”
token_standard
String
Yes
Aptos standard that the collection adheres to. Ex. “v1”
The following tables are planned for deprecation, or are already deprecated. See the notes section for any direct replacements or notes on how to migrate if you currently depend on one of these tables. Please do not use any of the below tables for production services.