Class LookupApi

Inheritance

object

LookupApi

Implements

ILookupApi

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Algorand.Indexer

Assembly: Algorand.dll

Syntax

public class LookupApi : ILookupApi

Constructors

LookupApi(HttpClient)

Declaration

public LookupApi(HttpClient httpClient)

Parameters

Type	Name	Description
System.Net.Http.HttpClient	httpClient

Properties

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
bool

Methods

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

Lookup an account's asset holdings, optionally for a specific ID.

Declaration

public 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	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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public 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
string	accountId
ulong?	applicationId
bool?	includeAll
ulong?	limit
string	next

Returns

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

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

Lookup an account's asset holdings, optionally for a specific ID.

Declaration

public 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	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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public 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
string	accountId
ulong?	assetId
bool?	includeAll
ulong?	limit
string	next

Returns

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

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

Lookup account information.

Declaration

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

Parameters

Type	Name	Description
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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

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

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
string	accountId
string	exclude
bool?	includeAll
ulong?	round

Returns

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

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

Lookup an account's created application parameters, optionally for a specific ID.

Declaration

public 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	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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public 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
string	accountId
ulong?	applicationId
bool?	includeAll
ulong?	limit
string	next

Returns

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

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

Lookup an account's created asset parameters, optionally for a specific ID.

Declaration

public 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	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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public 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
string	accountId
ulong?	assetId
bool?	includeAll
ulong?	limit
string	next

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?)

Lookup account transactions. Transactions are returned newest to oldest.

Declaration

public 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	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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public 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
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>

lookupApplicationByIDAsync(CancellationToken, ulong, bool?)

Declaration

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

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	applicationId
bool?	includeAll

Returns

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

lookupApplicationByIDAsync(ulong, bool?)

Lookup application.

Declaration

public 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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public 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
ulong	applicationId
ulong?	limit
ulong?	maxRound
ulong?	minRound
string	next
Address	senderAddress
string	txid

Returns

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

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

Lookup application logs.

Declaration

public 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	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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public 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
ulong	assetId
ulong?	currencyGreaterThan
ulong?	currencyLessThan
bool?	includeAll
ulong?	limit
string	next

Returns

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

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

Lookup the list of accounts who hold this asset

Declaration

public 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	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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

lookupAssetByIDAsync(CancellationToken, ulong, bool?)

Declaration

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

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	assetId
bool?	includeAll

Returns

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

lookupAssetByIDAsync(ulong, bool?)

Lookup asset information.

Declaration

public 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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public 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
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>

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

Lookup transactions for an asset. Transactions are returned oldest to newest.

Declaration

public 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	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>

Exceptions

Type	Condition
ApiException	A server side error occurred.

lookupBlockAsync(CancellationToken, ulong)

Declaration

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

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
ulong	roundNumber

Returns

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

lookupBlockAsync(ulong)

Lookup block.

Declaration

public Task<Block> lookupBlockAsync(ulong roundNumber)

Parameters

Type	Name	Description
ulong	roundNumber

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

lookupTransactionAsync(string)

Lookup a single transaction.

Declaration

public Task<TransactionResponse> lookupTransactionAsync(string txid)

Parameters

Type	Name	Description
string	txid

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

lookupTransactionAsync(CancellationToken, string)

Declaration

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

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
string	txid

Returns

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

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration

protected virtual Task<LookupApi.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Net.Http.HttpResponseMessage	response
System.Collections.Generic.IReadOnlyDictionary<TKey, TValue><string, System.Collections.Generic.IEnumerable<T><string>>	headers
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<TResult><LookupApi.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

Implements

ILookupApi