Indexer
We have several offerings for getting indexed data from the Aptos blockchain.
- Query the Indexer API to get basic data about transactions, fungible assets, and tokens
- Index your custom contract with the Indexer SDK
- Stream raw transactions from Transaction Stream Service to your processor or service
Indexer API
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:
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 the architecture.
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.Self-hosted Indexer API →
Host your own Indexer APIExample 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.Indexer SDK
If the hosted Indexer API is not enough or if you want to index your custom contract, you can create a processor with the Indexer SDK.
Quickstart Guide →
Get started with the Indexer SDKDocumentation →
Read documentation about the Indexer SDKTransaction Stream Service
Transaction Stream Service is a GRPC service that streams raw transactions to your processor or service. If you’re using the Indexer SDK, you’ll need an authorization token to connect to Transaction Stream Service.
Aptos-Hosted Transaction Stream Service →
Get access to the Aptos-hosted Transaction Stream ServiceLegacy Indexer
Find information about the legacy indexer here.