Struct IndexerClient 

pub struct IndexerClient { /* private fields */ }

Available on crate feature indexer only.

Client for the Aptos indexer GraphQL API.

The indexer provides access to indexed blockchain data including tokens, events, and transaction history. Queries are automatically retried with exponential backoff for transient failures.

Example

use aptos_sdk::api::IndexerClient;
use aptos_sdk::config::AptosConfig;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let config = AptosConfig::testnet();
    let client = IndexerClient::new(&config)?;
    // Use the client for GraphQL queries
    Ok(())
}

Implementations

impl IndexerClient

pub fn new(config: &AptosConfig) -> AptosResult<Self>

Creates a new indexer client.

TLS Security

This client uses reqwest with its default TLS configuration, which validates server certificates against the system’s certificate store. All Aptos indexer endpoints use HTTPS with valid certificates.

Errors

Returns an error if the indexer URL is not configured in the config, or if the HTTP client fails to build (e.g., invalid TLS configuration).

pub fn with_url(url: &str) -> AptosResult<Self>

Creates an indexer client with a custom URL.

Errors

Returns an error if the URL cannot be parsed.

pub async fn query<T: for<'de> Deserialize<'de> + Send + 'static>( &self, query: &str, variables: Option<Value>, ) -> AptosResult<T>

Executes a GraphQL query.

Errors

Returns an error if the HTTP request fails, the API returns an error status code, the response cannot be parsed as JSON, the GraphQL query contains errors, or the response data is missing.

pub async fn get_fungible_asset_balances( &self, address: AccountAddress, ) -> AptosResult<Vec<FungibleAssetBalance>>

Gets the account’s fungible asset balances.

Errors

Returns an error if the GraphQL query fails (see query for details).

pub async fn get_account_tokens( &self, address: AccountAddress, ) -> AptosResult<Vec<TokenBalance>>

Gets the account’s token (NFT) holdings.

Errors

Returns an error if the GraphQL query fails (see query for details).

pub async fn get_account_transactions( &self, address: AccountAddress, limit: Option<u32>, ) -> AptosResult<Vec<Transaction>>

Gets recent transactions for an account.

Errors

Returns an error if the GraphQL query fails (see query for details).

impl IndexerClient

pub async fn get_account_tokens_paginated( &self, address: AccountAddress, pagination: Option<PaginationParams>, ) -> AptosResult<Page<TokenBalance>>

Gets the account’s token (NFT) holdings with pagination.

Errors

Returns an error if the GraphQL query fails (see query for details).

pub async fn get_account_transactions_paginated( &self, address: AccountAddress, pagination: Option<PaginationParams>, ) -> AptosResult<Page<Transaction>>

Gets the account’s transaction history with pagination.

Errors

Returns an error if the GraphQL query fails (see query for details).

pub async fn get_events_by_type( &self, event_type: &str, limit: Option<u32>, ) -> AptosResult<Vec<Event>>

Gets events by type.

Errors

Returns an error if the GraphQL query fails (see query for details).

pub async fn get_events_by_account( &self, address: AccountAddress, limit: Option<u32>, ) -> AptosResult<Vec<Event>>

Gets events involving an account.

Errors

Returns an error if the GraphQL query fails (see query for details).

pub async fn get_collection( &self, collection_address: AccountAddress, ) -> AptosResult<Collection>

Gets a collection by its address.

Errors

Returns an error if the GraphQL query fails (see query for details), or if the collection is not found.

pub async fn get_collection_tokens( &self, collection_address: AccountAddress, pagination: Option<PaginationParams>, ) -> AptosResult<Page<TokenBalance>>

Gets tokens in a collection.

Errors

Returns an error if the GraphQL query fails (see query for details).

pub async fn get_coin_balances( &self, address: AccountAddress, ) -> AptosResult<Vec<CoinBalance>>

Gets coin balances for an account (legacy coin module).

Errors

Returns an error if the GraphQL query fails (see query for details).

pub async fn get_coin_activities( &self, address: AccountAddress, limit: Option<u32>, ) -> AptosResult<Vec<CoinActivity>>

Gets coin activities for an account.

Errors

Returns an error if the GraphQL query fails (see query for details).

pub async fn get_processor_status(&self) -> AptosResult<Vec<ProcessorStatus>>

Gets the processor status to check indexer health.

Errors

Returns an error if the GraphQL query fails (see query for details).

pub async fn get_indexer_version(&self) -> AptosResult<u64>

Gets the current indexer version (last processed transaction).

Errors

Returns an error if the processor status cannot be fetched, or if no processor status is available.

pub async fn check_indexer_lag( &self, reference_version: u64, max_lag: u64, ) -> AptosResult<bool>

Checks if the indexer is healthy by comparing with a reference version.

Errors

Returns an error if the indexer version cannot be fetched (see get_indexer_version for details).

Trait Implementations

impl Clone for IndexerClient

fn clone(&self) -> IndexerClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IndexerClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.