Class IndexerClient

Provides methods for retrieving data from Aptos Indexer. For more detailed Queries specification see https://cloud.hasura.io/public/graphiql?endpoint=https://indexer.mainnet.aptoslabs.com/v1/graphql

Hierarchy

IndexerClient
- Provider

Constructors

constructor

new IndexerClient(endpoint: string): IndexerClient
Parameters
- endpoint: string
  
  URL of the Aptos Indexer API endpoint.
Returns IndexerClient
- Defined in src/providers/indexer.ts:76

Properties

endpoint

endpoint: string

Methods

getAccountCoinsData

getAccountCoinsData(ownerAddress: MaybeHexString, options?: PaginationArgs): Promise<GetAccountCoinsDataQuery>
Queries an account coin data

Returns
GetAccountCoinsDataQuery response type
Parameters
- ownerAddress: MaybeHexString
  
  Owner address
- Optional options: PaginationArgs
Returns Promise<GetAccountCoinsDataQuery>
- Defined in src/providers/indexer.ts:155

getAccountNFTs

getAccountNFTs(ownerAddress: MaybeHexString, options?: PaginationArgs): Promise<GetAccountCurrentTokensQuery>
Queries an Aptos account's NFTs by owner address

Returns
GetAccountCurrentTokensQuery response type
Parameters
- ownerAddress: MaybeHexString
  
  Hex-encoded 32 byte Aptos account address
- Optional options: PaginationArgs
Returns Promise<GetAccountCurrentTokensQuery>
- Defined in src/providers/indexer.ts:124

getAccountTokensCount

getAccountTokensCount(ownerAddress: MaybeHexString): Promise<GetAccountTokensCountQuery>
Gets the count of tokens owned by an account

Returns
AccountTokensCountQuery response type
Parameters
- ownerAddress: MaybeHexString
  
  Owner address
Returns Promise<GetAccountTokensCountQuery>
- Defined in src/providers/indexer.ts:171

getAccountTransactionsCount

getAccountTransactionsCount(accountAddress: MaybeHexString): Promise<GetAccountTransactionsCountQuery>
Gets the count of transactions submitted by an account

Returns
GetAccountTransactionsCountQuery response type
Parameters
- accountAddress: MaybeHexString
Returns Promise<GetAccountTransactionsCountQuery>
- Defined in src/providers/indexer.ts:187

getAccountTransactionsData

getAccountTransactionsData(accountAddress: MaybeHexString, options?: PaginationArgs): Promise<GetAccountTransactionsDataQuery>
Queries an account transactions data

Returns
GetAccountTransactionsDataQuery response type
Parameters
- accountAddress: MaybeHexString
- Optional options: PaginationArgs
Returns Promise<GetAccountTransactionsDataQuery>
- Defined in src/providers/indexer.ts:203

getCollectionAddress

getCollectionAddress(creatorAddress: MaybeHexString, collectionName: string, extraArgs?: {
tokenStandard?: TokenStandard;
}): Promise<string>
Queries a collection address.

Returns
the collection address
Parameters
- creatorAddress: MaybeHexString
  
  the collection creator address
- collectionName: string
  
  the collection name
- Optional extraArgs: {
  tokenStandard?: TokenStandard;
  }
  - Optional tokenStandard?: TokenStandard
Returns Promise<string>
- Defined in src/providers/indexer.ts:482

getCollectionData

getCollectionData(creatorAddress: MaybeHexString, collectionName: string, extraArgs?: {
options?: PaginationArgs;
tokenStandard?: TokenStandard;
}): Promise<GetCollectionDataQuery>
Queries data of a specific collection by the collection creator address and the collection name.

if, for some reason, a creator account has 2 collections with the same name in v1 and v2, can pass an optional tokenStandard parameter to query a specific standard

Returns
GetCollectionDataQuery response type
Parameters
- creatorAddress: MaybeHexString
  
  the collection creator address
- collectionName: string
  
  the collection name
- Optional extraArgs: {
  options?: PaginationArgs;
  tokenStandard?: TokenStandard;
  }
  - Optional options?: PaginationArgs
  - Optional tokenStandard?: TokenStandard
Returns Promise<GetCollectionDataQuery>
- Defined in src/providers/indexer.ts:444

getCollectionsWithOwnedTokens

getCollectionsWithOwnedTokens(ownerAddress: MaybeHexString, extraArgs?: {
options?: PaginationArgs;
tokenStandard?: TokenStandard;
}): Promise<GetCollectionsWithOwnedTokensQuery>
Queries for all collections that an account has tokens for.

Returns
GetCollectionsWithOwnedTokensQuery response type
Parameters
- ownerAddress: MaybeHexString
  
  the account address that owns the tokens
- Optional extraArgs: {
  options?: PaginationArgs;
  tokenStandard?: TokenStandard;
  }
  - Optional options?: PaginationArgs
  - Optional tokenStandard?: TokenStandard
Returns Promise<GetCollectionsWithOwnedTokensQuery>
- Defined in src/providers/indexer.ts:499

getDelegatedStakingActivities

getDelegatedStakingActivities(delegatorAddress: MaybeHexString, poolAddress: MaybeHexString): Promise<GetDelegatedStakingActivitiesQuery>
Queries delegated staking activities

Returns
GetDelegatedStakingActivitiesQuery response type
Parameters
- delegatorAddress: MaybeHexString
  
  Delegator address
- poolAddress: MaybeHexString
  
  Pool address
Returns Promise<GetDelegatedStakingActivitiesQuery>
- Defined in src/providers/indexer.ts:223

getIndexerLedgerInfo

getIndexerLedgerInfo(): Promise<GetIndexerLedgerInfoQuery>
Queries Indexer Ledger Info

Returns
GetLedgerInfoQuery response type

Returns Promise<GetIndexerLedgerInfoQuery>
- Defined in src/providers/indexer.ts:111

getNumberOfDelegators

getNumberOfDelegators(poolAddress: MaybeHexString): Promise<GetNumberOfDelegatorsQuery>
Queries current number of delegators in a pool

Returns
GetNumberOfDelegatorsQuery response type
Parameters
- poolAddress: MaybeHexString
Returns Promise<GetNumberOfDelegatorsQuery>
- Defined in src/providers/indexer.ts:316

getOwnedTokens

getOwnedTokens(ownerAddress: MaybeHexString, extraArgs?: {
options?: PaginationArgs;
tokenStandard?: TokenStandard;
}): Promise<GetOwnedTokensQuery>
Queries account's current owned tokens. This query returns all tokens (v1 and v2 standards) an account owns, including NFTs, fungible, soulbound, etc. If you want to get only the token from a specific standrd, you can pass an optional tokenStandard param

Example
An example of how to pass a specific token standard
```
{
   tokenStandard:"v2"
}
```
Returns
GetOwnedTokensQuery response type
Parameters
- ownerAddress: MaybeHexString
  
  The token owner address we want to get the tokens for
- Optional extraArgs: {
  options?: PaginationArgs;
  tokenStandard?: TokenStandard;
  }
  - Optional options?: PaginationArgs
  - Optional tokenStandard?: TokenStandard
Returns Promise<GetOwnedTokensQuery>
- Defined in src/providers/indexer.ts:339

getTokenActivities

getTokenActivities(idHash: string, options?: PaginationArgs): Promise<GetTokenActivitiesQuery>
Queries a token activities by token id hash

Returns
GetTokenActivitiesQuery response type
Parameters
- idHash: string
  
  token id hash
- Optional options: PaginationArgs
Returns Promise<GetTokenActivitiesQuery>
- Defined in src/providers/indexer.ts:141

getTokenActivitiesCount

getTokenActivitiesCount(tokenId: string): Promise<GetTokenActivitiesCountQuery>
Gets the count of token's activities

Returns
GetTokenActivitiesCountQuery response type
Parameters
- tokenId: string
  
  Token ID
Returns Promise<GetTokenActivitiesCountQuery>
- Defined in src/providers/indexer.ts:247

getTokenData

getTokenData(tokenId: string): Promise<GetTokenDataQuery>
Queries token data

Returns
GetTokenDataQuery response type
Parameters
- tokenId: string
  
  Token ID
Returns Promise<GetTokenDataQuery>
- Defined in src/providers/indexer.ts:261

getTokenOwnedFromCollectionAddress

getTokenOwnedFromCollectionAddress(ownerAddress: MaybeHexString, collectionAddress: string, extraArgs?: {
options?: PaginationArgs;
tokenStandard?: TokenStandard;
}): Promise<GetTokenOwnedFromCollectionQuery>
Queries all tokens of a specific collection that an account owns by the collection address

Returns
GetTokenOwnedFromCollectionQuery response type
Parameters
- ownerAddress: MaybeHexString
  
  owner address that owns the tokens
- collectionAddress: string
  
  the collection address
- Optional extraArgs: {
  options?: PaginationArgs;
  tokenStandard?: TokenStandard;
  }
  - Optional options?: PaginationArgs
  - Optional tokenStandard?: TokenStandard
Returns Promise<GetTokenOwnedFromCollectionQuery>
- Defined in src/providers/indexer.ts:376

getTokenOwnedFromCollectionNameAndCreatorAddress

getTokenOwnedFromCollectionNameAndCreatorAddress(ownerAddress: MaybeHexString, collectionName: string, creatorAddress: MaybeHexString, extraArgs?: {
options?: PaginationArgs;
tokenStandard?: TokenStandard;
}): Promise<GetTokenOwnedFromCollectionQuery>
Queries all tokens of a specific collection that an account owns by the collection name and collection creator address

Returns
GetTokenOwnedFromCollectionQuery response type
Parameters
- ownerAddress: MaybeHexString
  
  owner address that owns the tokens
- collectionName: string
  
  the collection name
- creatorAddress: MaybeHexString
  
  the collection creator address
- Optional extraArgs: {
  options?: PaginationArgs;
  tokenStandard?: TokenStandard;
  }
  - Optional options?: PaginationArgs
  - Optional tokenStandard?: TokenStandard
Returns Promise<GetTokenOwnedFromCollectionQuery>
- Defined in src/providers/indexer.ts:420

getTokenOwnersData

getTokenOwnersData(tokenId: string, propertyVersion: number): Promise<GetTokenOwnersDataQuery>
Queries token owners data

Returns
GetTokenOwnersDataQuery response type
Parameters
- tokenId: string
  
  Token ID
- propertyVersion: number
  
  Property version
Returns Promise<GetTokenOwnersDataQuery>
- Defined in src/providers/indexer.ts:276

getTopUserTransactions

getTopUserTransactions(limit: number): Promise<GetTopUserTransactionsQuery>
Queries top user transactions

Returns
GetTopUserTransactionsQuery response type
Parameters
- limit: number
Returns Promise<GetTopUserTransactionsQuery>
- Defined in src/providers/indexer.ts:290

getUserTransactions

getUserTransactions(startVersion?: number, options?: PaginationArgs): Promise<GetUserTransactionsQuery>
Queries top user transactions

Returns
GetUserTransactionsQuery response type
Parameters
- Optional startVersion: number
- Optional options: PaginationArgs
Returns Promise<GetUserTransactionsQuery>
- Defined in src/providers/indexer.ts:303

queryIndexer

queryIndexer<T>(graphqlQuery: GraphqlQuery): Promise<T>
Builds a axios client call to fetch data from Aptos Indexer.
Type Parameters
- T
Parameters
- graphqlQuery: GraphqlQuery
  
  A GraphQL query to pass in the data axios call.
Returns Promise<T>
- Defined in src/providers/indexer.ts:96

`Static` validateAddress

validateAddress(address: string): void
Indexer only accepts address in the long format, i.e a 66 chars long -> 0x<64 chars> This method makes sure address is 66 chars long.
Parameters
- address: string
Returns void
- Defined in src/providers/indexer.ts:85

Class IndexerClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

endpoint: string

Returns IndexerClient

Properties

endpoint

Methods

getAccountCoinsData

Returns

Parameters

ownerAddress: MaybeHexString

Optional options: PaginationArgs

Returns Promise<GetAccountCoinsDataQuery>

getAccountNFTs

Returns

Parameters

ownerAddress: MaybeHexString

Optional options: PaginationArgs

Returns Promise<GetAccountCurrentTokensQuery>

getAccountTokensCount

Returns

Parameters

ownerAddress: MaybeHexString

Returns Promise<GetAccountTokensCountQuery>

getAccountTransactionsCount

Returns

Parameters

accountAddress: MaybeHexString

Returns Promise<GetAccountTransactionsCountQuery>

getAccountTransactionsData

Returns

Parameters

accountAddress: MaybeHexString

Optional options: PaginationArgs

Returns Promise<GetAccountTransactionsDataQuery>

getCollectionAddress

Returns

Parameters

creatorAddress: MaybeHexString

collectionName: string

Optional extraArgs: { tokenStandard?: TokenStandard; }

Optional tokenStandard?: TokenStandard

Returns Promise<string>

getCollectionData

Returns

Parameters

creatorAddress: MaybeHexString

collectionName: string

Optional extraArgs: { options?: PaginationArgs; tokenStandard?: TokenStandard; }

Optional options?: PaginationArgs

Optional tokenStandard?: TokenStandard

Returns Promise<GetCollectionDataQuery>

getCollectionsWithOwnedTokens

Returns

Parameters

ownerAddress: MaybeHexString

Optional extraArgs: { options?: PaginationArgs; tokenStandard?: TokenStandard; }

Optional options?: PaginationArgs

Optional tokenStandard?: TokenStandard

Returns Promise<GetCollectionsWithOwnedTokensQuery>

getDelegatedStakingActivities

Returns

Parameters

delegatorAddress: MaybeHexString

poolAddress: MaybeHexString

Returns Promise<GetDelegatedStakingActivitiesQuery>

getIndexerLedgerInfo

Returns

Returns Promise<GetIndexerLedgerInfoQuery>

getNumberOfDelegators

Returns

Parameters

poolAddress: MaybeHexString

`Optional` options: PaginationArgs

`Optional` options: PaginationArgs

`Optional` options: PaginationArgs

`Optional` extraArgs: {
tokenStandard?: TokenStandard;
}

`Optional` tokenStandard?: TokenStandard

`Optional` extraArgs: {
options?: PaginationArgs;
tokenStandard?: TokenStandard;
}

`Optional` options?: PaginationArgs

`Optional` tokenStandard?: TokenStandard

`Optional` extraArgs: {
options?: PaginationArgs;
tokenStandard?: TokenStandard;
}

`Optional` options?: PaginationArgs

`Optional` tokenStandard?: TokenStandard

`Optional` extraArgs: {
options?: PaginationArgs;
tokenStandard?: TokenStandard;
}

`Optional` options?: PaginationArgs

`Optional` tokenStandard?: TokenStandard

`Optional` options: PaginationArgs

`Optional` extraArgs: {
options?: PaginationArgs;
tokenStandard?: TokenStandard;
}

`Optional` options?: PaginationArgs

`Optional` tokenStandard?: TokenStandard

`Optional` extraArgs: {
options?: PaginationArgs;
tokenStandard?: TokenStandard;
}

`Optional` options?: PaginationArgs

`Optional` tokenStandard?: TokenStandard

`Optional` startVersion: number

`Optional` options: PaginationArgs

`Static` validateAddress