Indexer
The Indexer API, Transaction Stream Service, and Custom Processors are currently in beta. Please report any problems you encounter by creating an issue in the aptos-indexer-processors repo.
The Aptos Indexer is an API you can use to get:
- Aggregate data (ex. How many NFTs exist?)
- Historical data (ex. What transactions has this account submitted?)
- Data that is hard to get from the simpler Aptos Node API (ex. What account owns a token named “ExampleToken”?).
For example, you can use the Indexer API to look up the fungible asset balances of any account like so:
Loading...
The Indexer tracks every transaction that happens on-chain, then exposes that data through a GraphQL API.
Using the Indexer API
Learn how to use the Indexer API, what each table represents, and how to add custom data to the Indexer.
Accessing the API →
Learn how to query the Indexer API.Indexer Table Reference →
Detailed reference for Indexer tables and their schemas.Architecture →
Detailed layout of the Indexer’s architecture.Example Queries
To help get you started, here are the most common queries the Indexer is used for.
Get Fungible Asset Balances →
Get all fungible assets an account currently owns.Get Account Transactions →
Get all transactions impacting an account.Get Aptos Name →
Retrieve the Aptos name associated with an account (via the ANS).Get Fungible Asset Info →
Get detailed information about a specific fungible asset.Get NFT Collections →
Retrieve NFT collections owned by a specific account.Get NFTs →
Retrieve individual NFTs owned by a specific account.Get Token Metadata →
Get metadata information for a specific token.Count Delegators in Staking Pool →
Retrieve the number of active delegators in a staking pool.Customizing the Indexer (Advanced)
If the hosted Indexer API is not enough, you can customize and host your own versions of the Indexer.
Architecture →
Detailed layout of the Indexer’s architecture.Indexer SDK →
Create a custom processor with the Indexer SDKTransaction Streaming Service →
GRPC transaction streaming service, consumed by the IndexerSelf-hosted Indexer API →
Host your own Indexer APILegacy Indexer
Find information about the legacy indexer here.