Interface ILookupApi

Namespace: Algorand.Indexer

Assembly: Algorand.dll

Syntax

public interface ILookupApi

Methods

lookupAccountAppLocalStatesAsync(string, ulong?, bool?, ulong?, string?)

Declaration

Task<ApplicationLocalStatesResponse> lookupAccountAppLocalStatesAsync(string accountId, ulong? applicationId = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
string	accountId
ulong?	applicationId
bool?	includeAll
ulong?	limit
string	next

Returns

Type	Description
System.Threading.Tasks.Task<TResult><ApplicationLocalStatesResponse>

lookupAccountAppLocalStatesAsync(CancellationToken, string, ulong?, bool?, ulong?, string?)

Declaration

Task<ApplicationLocalStatesResponse> lookupAccountAppLocalStatesAsync(CancellationToken cancellationToken, string accountId, ulong? applicationId = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
string	accountId
ulong?	applicationId
bool?	includeAll
ulong?	limit	Maximum number of results to return. There could be additional pages even if the limit is not reached.
string	next	The next page of results. Use the next token provided by the previous results.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><ApplicationLocalStatesResponse>

lookupAccountAssetsAsync(string, ulong?, bool?, ulong?, string?)

Declaration

Task<AssetHoldingsResponse> lookupAccountAssetsAsync(string accountId, ulong? assetId = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
string	accountId
ulong?	assetId
bool?	includeAll
ulong?	limit
string	next

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AssetHoldingsResponse>

lookupAccountAssetsAsync(CancellationToken, string, ulong?, bool?, ulong?, string?)

Declaration

Task<AssetHoldingsResponse> lookupAccountAssetsAsync(CancellationToken cancellationToken, string accountId, ulong? assetId = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
string	accountId
ulong?	assetId
bool?	includeAll
ulong?	limit	Maximum number of results to return. There could be additional pages even if the limit is not reached.
string	next	The next page of results. Use the next token provided by the previous results.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AssetHoldingsResponse>

lookupAccountByIDAsync(string, string?, bool?, ulong?)

Declaration

Task<AccountResponse> lookupAccountByIDAsync(string accountId, string? exclude = null, bool? includeAll = null, ulong? round = null)

Parameters

Type	Name	Description
string	accountId
string	exclude
bool?	includeAll
ulong?	round

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AccountResponse>

lookupAccountByIDAsync(CancellationToken, string, string?, bool?, ulong?)

Declaration

Task<AccountResponse> lookupAccountByIDAsync(CancellationToken cancellationToken, string accountId, string? exclude = null, bool? includeAll = null, ulong? round = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
string	accountId
string	exclude	Exclude additional items such as asset holdings, application local data stored for this account, asset parameters created by this account, and application parameters created by this account.
bool?	includeAll
ulong?	round	Include results for the specified round.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AccountResponse>

lookupAccountCreatedApplicationsAsync(string, ulong?, bool?, ulong?, string?)

Declaration

Task<ApplicationsResponse> lookupAccountCreatedApplicationsAsync(string accountId, ulong? applicationId = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
string	accountId
ulong?	applicationId
bool?	includeAll
ulong?	limit
string	next

Returns

Type	Description
System.Threading.Tasks.Task<TResult><ApplicationsResponse>

lookupAccountCreatedApplicationsAsync(CancellationToken, string, ulong?, bool?, ulong?, string?)

Declaration

Task<ApplicationsResponse> lookupAccountCreatedApplicationsAsync(CancellationToken cancellationToken, string accountId, ulong? applicationId = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
string	accountId
ulong?	applicationId
bool?	includeAll
ulong?	limit	Maximum number of results to return. There could be additional pages even if the limit is not reached.
string	next	The next page of results. Use the next token provided by the previous results.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><ApplicationsResponse>

lookupAccountCreatedAssetsAsync(string, ulong?, bool?, ulong?, string?)

Declaration

Task<AssetsResponse> lookupAccountCreatedAssetsAsync(string accountId, ulong? assetId = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
string	accountId
ulong?	assetId
bool?	includeAll
ulong?	limit
string	next

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AssetsResponse>

lookupAccountCreatedAssetsAsync(CancellationToken, string, ulong?, bool?, ulong?, string?)

Declaration

Task<AssetsResponse> lookupAccountCreatedAssetsAsync(CancellationToken cancellationToken, string accountId, ulong? assetId = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
string	accountId
ulong?	assetId
bool?	includeAll
ulong?	limit	Maximum number of results to return. There could be additional pages even if the limit is not reached.
string	next	The next page of results. Use the next token provided by the previous results.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AssetsResponse>

lookupAccountTransactionsAsync(string, string?, ulong?, string?, ulong?, ulong?, ulong?, ulong?, ulong?, string?, string?, bool?, ulong?, string?, string?, string?)

Declaration

Task<TransactionsResponse> lookupAccountTransactionsAsync(string accountId, string? afterTime = null, ulong? assetId = null, string? beforeTime = null, ulong? currencyGreaterThan = null, ulong? currencyLessThan = null, ulong? limit = null, ulong? maxRound = null, ulong? minRound = null, string? next = null, string? notePrefix = null, bool? rekeyTo = null, ulong? round = null, string? sigType = null, string? txType = null, string? txid = null)

Parameters

Type	Name	Description
string	accountId
string	afterTime
ulong?	assetId
string	beforeTime
ulong?	currencyGreaterThan
ulong?	currencyLessThan
ulong?	limit
ulong?	maxRound
ulong?	minRound
string	next
string	notePrefix
bool?	rekeyTo
ulong?	round
string	sigType
string	txType
string	txid

Returns

Type	Description
System.Threading.Tasks.Task<TResult><TransactionsResponse>

lookupAccountTransactionsAsync(CancellationToken, string, string?, ulong?, string?, ulong?, ulong?, ulong?, ulong?, ulong?, string?, string?, bool?, ulong?, string?, string?, string?)

Declaration

Task<TransactionsResponse> lookupAccountTransactionsAsync(CancellationToken cancellationToken, string accountId, string? afterTime = null, ulong? assetId = null, string? beforeTime = null, ulong? currencyGreaterThan = null, ulong? currencyLessThan = null, ulong? limit = null, ulong? maxRound = null, ulong? minRound = null, string? next = null, string? notePrefix = null, bool? rekeyTo = null, ulong? round = null, string? sigType = null, string? txType = null, string? txid = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
string	accountId
string	afterTime
ulong?	assetId
string	beforeTime
ulong?	currencyGreaterThan
ulong?	currencyLessThan
ulong?	limit	Maximum number of results to return. There could be additional pages even if the limit is not reached.
ulong?	maxRound
ulong?	minRound
string	next	The next page of results. Use the next token provided by the previous results.
string	notePrefix
bool?	rekeyTo
ulong?	round	Include results for the specified round.
string	sigType
string	txType
string	txid	Lookup the specific transaction by ID.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><TransactionsResponse>

lookupApplicationByIDAsync(CancellationToken, ulong, bool?)

Declaration

Task<ApplicationResponse> lookupApplicationByIDAsync(CancellationToken cancellationToken, ulong applicationId, bool? includeAll = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
ulong	applicationId
bool?	includeAll

Returns

Type	Description
System.Threading.Tasks.Task<TResult><ApplicationResponse>

lookupApplicationByIDAsync(ulong, bool?)

Declaration

Task<ApplicationResponse> lookupApplicationByIDAsync(ulong applicationId, bool? includeAll = null)

Parameters

Type	Name	Description
ulong	applicationId
bool?	includeAll

Returns

Type	Description
System.Threading.Tasks.Task<TResult><ApplicationResponse>

lookupApplicationLogsByIDAsync(CancellationToken, ulong, ulong?, ulong?, ulong?, string?, Address?, string?)

Declaration

Task<ApplicationLogsResponse> lookupApplicationLogsByIDAsync(CancellationToken cancellationToken, ulong applicationId, ulong? limit = null, ulong? maxRound = null, ulong? minRound = null, string? next = null, Address? senderAddress = null, string? txid = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
ulong	applicationId
ulong?	limit	Maximum number of results to return. There could be additional pages even if the limit is not reached.
ulong?	maxRound
ulong?	minRound
string	next	The next page of results. Use the next token provided by the previous results.
Address	senderAddress
string	txid	Lookup the specific transaction by ID.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><ApplicationLogsResponse>

lookupApplicationLogsByIDAsync(ulong, ulong?, ulong?, ulong?, string?, Address?, string?)

Declaration

Task<ApplicationLogsResponse> lookupApplicationLogsByIDAsync(ulong applicationId, ulong? limit = null, ulong? maxRound = null, ulong? minRound = null, string? next = null, Address? senderAddress = null, string? txid = null)

Parameters

Type	Name	Description
ulong	applicationId
ulong?	limit
ulong?	maxRound
ulong?	minRound
string	next
Address	senderAddress
string	txid

Returns

Type	Description
System.Threading.Tasks.Task<TResult><ApplicationLogsResponse>

lookupAssetBalancesAsync(CancellationToken, ulong, ulong?, ulong?, bool?, ulong?, string?)

Declaration

Task<AssetBalancesResponse> lookupAssetBalancesAsync(CancellationToken cancellationToken, ulong assetId, ulong? currencyGreaterThan = null, ulong? currencyLessThan = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
ulong	assetId
ulong?	currencyGreaterThan
ulong?	currencyLessThan
bool?	includeAll
ulong?	limit	Maximum number of results to return. There could be additional pages even if the limit is not reached.
string	next	The next page of results. Use the next token provided by the previous results.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AssetBalancesResponse>

lookupAssetBalancesAsync(ulong, ulong?, ulong?, bool?, ulong?, string?)

Declaration

Task<AssetBalancesResponse> lookupAssetBalancesAsync(ulong assetId, ulong? currencyGreaterThan = null, ulong? currencyLessThan = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
ulong	assetId
ulong?	currencyGreaterThan
ulong?	currencyLessThan
bool?	includeAll
ulong?	limit
string	next

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AssetBalancesResponse>

lookupAssetByIDAsync(CancellationToken, ulong, bool?)

Declaration

Task<AssetResponse> lookupAssetByIDAsync(CancellationToken cancellationToken, ulong assetId, bool? includeAll = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
ulong	assetId
bool?	includeAll

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AssetResponse>

lookupAssetByIDAsync(ulong, bool?)

Declaration

Task<AssetResponse> lookupAssetByIDAsync(ulong assetId, bool? includeAll = null)

Parameters

Type	Name	Description
ulong	assetId
bool?	includeAll

Returns

Type	Description
System.Threading.Tasks.Task<TResult><AssetResponse>

lookupAssetTransactionsAsync(CancellationToken, ulong, Address?, string?, string?, string?, ulong?, ulong?, bool?, ulong?, ulong?, ulong?, string?, string?, bool?, ulong?, string?, string?, string?)

Declaration

Task<TransactionsResponse> lookupAssetTransactionsAsync(CancellationToken cancellationToken, ulong assetId, Address? address = null, string? addressRole = null, string? afterTime = null, string? beforeTime = null, ulong? currencyGreaterThan = null, ulong? currencyLessThan = null, bool? excludeCloseTo = null, ulong? limit = null, ulong? maxRound = null, ulong? minRound = null, string? next = null, string? notePrefix = null, bool? rekeyTo = null, ulong? round = null, string? sigType = null, string? txType = null, string? txid = null)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
ulong	assetId
Address	address	Only include transactions with this address in one of the transaction fields.
string	addressRole
string	afterTime
string	beforeTime
ulong?	currencyGreaterThan
ulong?	currencyLessThan
bool?	excludeCloseTo
ulong?	limit	Maximum number of results to return. There could be additional pages even if the limit is not reached.
ulong?	maxRound
ulong?	minRound
string	next	The next page of results. Use the next token provided by the previous results.
string	notePrefix
bool?	rekeyTo
ulong?	round	Include results for the specified round.
string	sigType
string	txType
string	txid	Lookup the specific transaction by ID.

Returns

Type	Description
System.Threading.Tasks.Task<TResult><TransactionsResponse>

lookupAssetTransactionsAsync(ulong, Address?, string?, string?, string?, ulong?, ulong?, bool?, ulong?, ulong?, ulong?, string?, string?, bool?, ulong?, string?, string?, string?)

Declaration

Task<TransactionsResponse> lookupAssetTransactionsAsync(ulong assetId, Address? address = null, string? addressRole = null, string? afterTime = null, string? beforeTime = null, ulong? currencyGreaterThan = null, ulong? currencyLessThan = null, bool? excludeCloseTo = null, ulong? limit = null, ulong? maxRound = null, ulong? minRound = null, string? next = null, string? notePrefix = null, bool? rekeyTo = null, ulong? round = null, string? sigType = null, string? txType = null, string? txid = null)

Parameters

Type	Name	Description
ulong	assetId
Address	address
string	addressRole
string	afterTime
string	beforeTime
ulong?	currencyGreaterThan
ulong?	currencyLessThan
bool?	excludeCloseTo
ulong?	limit
ulong?	maxRound
ulong?	minRound
string	next
string	notePrefix
bool?	rekeyTo
ulong?	round
string	sigType
string	txType
string	txid

Returns

Type	Description
System.Threading.Tasks.Task<TResult><TransactionsResponse>

lookupBlockAsync(CancellationToken, ulong)

Declaration

Task<Block> lookupBlockAsync(CancellationToken cancellationToken, ulong roundNumber)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
ulong	roundNumber

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Block>

lookupBlockAsync(ulong)

Declaration

Task<Block> lookupBlockAsync(ulong roundNumber)

Parameters

Type	Name	Description
ulong	roundNumber

Returns

Type	Description
System.Threading.Tasks.Task<TResult><Block>

lookupTransactionAsync(string)

Declaration

Task<TransactionResponse> lookupTransactionAsync(string txid)

Parameters

Type	Name	Description
string	txid

Returns

Type	Description
System.Threading.Tasks.Task<TResult><TransactionResponse>

lookupTransactionAsync(CancellationToken, string)

Declaration

Task<TransactionResponse> lookupTransactionAsync(CancellationToken cancellationToken, string txid)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.
string	txid

Returns

Type	Description
System.Threading.Tasks.Task<TResult><TransactionResponse>