@algorandfoundation/algokit-utils / index / indexer
index.indexer
- executePaginatedRequest
- lookupAccountByAddress
- lookupAccountCreatedApplicationByAddress
- lookupAssetHoldings
- lookupTransactionById
- searchTransactions
Ƭ SearchForTransactions: ReturnType<Indexer["searchForTransactions"]>
▸ executePaginatedRequest<TResult, TRequest>(extractItems, buildRequest): Promise<TResult[]>
| Name | Type |
|---|---|
TResult |
TResult |
TRequest |
extends Object |
| Name | Type |
|---|---|
extractItems |
(response: any) => TResult[] |
buildRequest |
(nextToken?: string) => TRequest |
Promise<TResult[]>
▸ lookupAccountByAddress(accountAddress, indexer): Promise<AccountResponse>
| Name | Type | Description |
|---|---|---|
accountAddress |
string | Address |
The address of the account to look up |
indexer |
IndexerClient |
An indexer client |
Promise<AccountResponse>
The result of the look-up
Deprecated
Use indexer.lookupAccountByID(accountAddress).do().
Looks up an account by address using Indexer.
▸ lookupAccountCreatedApplicationByAddress(indexer, address, getAll?, paginationLimit?): Promise<algosdk.indexerModels.Application[]>
Looks up applications that were created by the given address; will automatically paginate through all data.
| Name | Type | Default value | Description |
|---|---|---|---|
indexer |
IndexerClient |
undefined |
An indexer instance |
address |
string | Address |
undefined |
The address of the creator to look up |
getAll |
undefined | boolean |
undefined |
Whether or not to include deleted applications |
paginationLimit? |
number |
undefined |
The number of records to return per paginated request, default 1000 |
Promise<algosdk.indexerModels.Application[]>
The list of application results
▸ lookupAssetHoldings(indexer, assetId, options?, paginationLimit?): Promise<algosdk.indexerModels.MiniAssetHolding[]>
Looks up asset holdings for the given asset; will automatically paginate through all data.
| Name | Type | Description |
|---|---|---|
indexer |
IndexerClient |
An indexer instance |
assetId |
number | bigint |
The ID of the asset to look up holdings for |
options? |
LookupAssetHoldingsOptions |
Optional options to control the lookup |
paginationLimit? |
number |
The number of records to return per paginated request, default 1000 |
Promise<algosdk.indexerModels.MiniAssetHolding[]>
The list of application results
▸ lookupTransactionById(transactionId, indexer): Promise<TransactionResponse>
| Name | Type | Description |
|---|---|---|
transactionId |
string |
The ID of the transaction to look up |
indexer |
IndexerClient |
An indexer client |
Promise<TransactionResponse>
The result of the look-up
Deprecated
Use indexer.lookupTransactionByID(transactionId).do().
Looks up a transaction by ID using Indexer.
▸ searchTransactions(indexer, searchCriteria, paginationLimit?): Promise<algosdk.indexerModels.TransactionsResponse>
Allows transactions to be searched for the given criteria.
| Name | Type | Description |
|---|---|---|
indexer |
IndexerClient |
An indexer client |
searchCriteria |
(s: default) => default |
The criteria to search for |
paginationLimit? |
number |
The number of records to return per paginated request, default 1000 |
Promise<algosdk.indexerModels.TransactionsResponse>
The search results