Namespace: indexer
@algorandfoundation/algokit-utils / index / indexer
index.indexer
Table of contents
Type Aliases
Functions
- executePaginatedRequest
- lookupAccountByAddress
- lookupAccountCreatedApplicationByAddress
- lookupAssetHoldings
- lookupTransactionById
- searchTransactions
Type Aliases
SearchForTransactions
Ƭ SearchForTransactions: ReturnType<Indexer["searchForTransactions"]>
Defined in
Functions
executePaginatedRequest
▸ executePaginatedRequest<TResult, TRequest>(extractItems, buildRequest): Promise<TResult[]>
Type parameters
| Name | Type |
|---|---|
TResult | TResult |
TRequest | extends Object |
Parameters
| Name | Type |
|---|---|
extractItems | (response: any) => TResult[] |
buildRequest | (nextToken?: string) => TRequest |
Returns
Promise<TResult[]>
Defined in
lookupAccountByAddress
▸ lookupAccountByAddress(accountAddress, indexer): Promise<AccountResponse>
Parameters
| Name | Type | Description |
|---|---|---|
accountAddress | string | Address | The address of the account to look up |
indexer | IndexerClient | An indexer client |
Returns
Promise<AccountResponse>
The result of the look-up
Deprecated
Use indexer.lookupAccountByID(accountAddress).do().
Looks up an account by address using Indexer.
Defined in
lookupAccountCreatedApplicationByAddress
▸ 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.
Parameters
| 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 |
Returns
Promise<algosdk.indexerModels.Application[]>
The list of application results
Defined in
lookupAssetHoldings
▸ lookupAssetHoldings(indexer, assetId, options?, paginationLimit?): Promise<algosdk.indexerModels.MiniAssetHolding[]>
Looks up asset holdings for the given asset; will automatically paginate through all data.
Parameters
| 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 |
Returns
Promise<algosdk.indexerModels.MiniAssetHolding[]>
The list of application results
Defined in
lookupTransactionById
▸ lookupTransactionById(transactionId, indexer): Promise<TransactionResponse>
Parameters
| Name | Type | Description |
|---|---|---|
transactionId | string | The ID of the transaction to look up |
indexer | IndexerClient | An indexer client |
Returns
Promise<TransactionResponse>
The result of the look-up
Deprecated
Use indexer.lookupTransactionByID(transactionId).do().
Looks up a transaction by ID using Indexer.
Defined in
searchTransactions
▸ searchTransactions(indexer, searchCriteria, paginationLimit?): Promise<algosdk.indexerModels.TransactionsResponse>
Allows transactions to be searched for the given criteria.
Parameters
| 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 |
Returns
Promise<algosdk.indexerModels.TransactionsResponse>
The search results