Class SearchApi

Inheritance

object

SearchApi

Implements

ISearchApi

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 SearchApi : ISearchApi

Constructors

SearchApi(HttpClient)

Declaration

public SearchApi(HttpClient httpClient)

Parameters

Type	Name	Description
HttpClient	httpClient

Properties

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
bool

Methods

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

Declaration

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

Parameters

Type	Name	Description
HttpResponseMessage	response
IReadOnlyDictionary<string, IEnumerable<string>>	headers
CancellationToken	cancellationToken

Returns

Type	Description
Task<SearchApi.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

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

Search for accounts.

Declaration

public Task<AccountsResponse> searchForAccountsAsync(ulong? applicationId = null, ulong? assetId = null, Address? authAddr = null, ulong? currencyGreaterThan = null, ulong? currencyLessThan = null, string? exclude = null, bool? includeAll = null, ulong? limit = null, string? next = null, ulong? round = null)

Parameters

Type	Name	Description
ulong?	applicationId
ulong?	assetId
Address	authAddr
ulong?	currencyGreaterThan
ulong?	currencyLessThan
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?	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.
ulong?	round	Include results for the specified round. For performance reasons, this parameter may be disabled on some configurations.

Returns

Type	Description
Task<AccountsResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public Task<AccountsResponse> searchForAccountsAsync(CancellationToken cancellationToken, ulong? applicationId = null, ulong? assetId = null, Address? authAddr = null, ulong? currencyGreaterThan = null, ulong? currencyLessThan = null, string? exclude = null, bool? includeAll = null, ulong? limit = null, string? next = null, ulong? round = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken
ulong?	applicationId
ulong?	assetId
Address	authAddr
ulong?	currencyGreaterThan
ulong?	currencyLessThan
string	exclude
bool?	includeAll
ulong?	limit
string	next
ulong?	round

Returns

Type	Description
Task<AccountsResponse>

searchForApplicationsAsync(ulong?, string?, bool?, ulong?, string?)

Search for applications

Declaration

public Task<ApplicationsResponse> searchForApplicationsAsync(ulong? applicationId = null, string? creator = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
ulong?	applicationId
string	creator	Filter just applications with the given creator address.
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
Task<ApplicationsResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public Task<ApplicationsResponse> searchForApplicationsAsync(CancellationToken cancellationToken, ulong? applicationId = null, string? creator = null, bool? includeAll = null, ulong? limit = null, string? next = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken
ulong?	applicationId
string	creator
bool?	includeAll
ulong?	limit
string	next

Returns

Type	Description
Task<ApplicationsResponse>

searchForAssetsAsync(ulong?, string?, bool?, ulong?, string?, string?, string?)

Search for assets.

Declaration

public Task<AssetsResponse> searchForAssetsAsync(ulong? assetId = null, string? creator = null, bool? includeAll = null, ulong? limit = null, string? name = null, string? next = null, string? unit = null)

Parameters

Type	Name	Description
ulong?	assetId
string	creator	Filter just assets with the given creator address.
bool?	includeAll
ulong?	limit	Maximum number of results to return. There could be additional pages even if the limit is not reached.
string	name	Filter just assets with the given name.
string	next	The next page of results. Use the next token provided by the previous results.
string	unit	Filter just assets with the given unit.

Returns

Type	Description
Task<AssetsResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public Task<AssetsResponse> searchForAssetsAsync(CancellationToken cancellationToken, ulong? assetId = null, string? creator = null, bool? includeAll = null, ulong? limit = null, string? name = null, string? next = null, string? unit = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken
ulong?	assetId
string	creator
bool?	includeAll
ulong?	limit
string	name
string	next
string	unit

Returns

Type	Description
Task<AssetsResponse>

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

Search for transactions. Transactions are returned oldest to newest unless the address parameter is used, in which case results are returned newest to oldest.

Declaration

public Task<TransactionsResponse> searchForTransactionsAsync(Address? address = null, string? addressRole = null, string? afterTime = null, ulong? applicationId = null, ulong? assetId = 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
Address	address	Only include transactions with this address in one of the transaction fields.
string	addressRole
string	afterTime
ulong?	applicationId
ulong?	assetId
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
Task<TransactionsResponse>

Exceptions

Type	Condition
ApiException	A server side error occurred.

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

Declaration

public Task<TransactionsResponse> searchForTransactionsAsync(CancellationToken cancellationToken, Address? address = null, string? addressRole = null, string? afterTime = null, ulong? applicationId = null, ulong? assetId = 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
CancellationToken	cancellationToken
Address	address
string	addressRole
string	afterTime
ulong?	applicationId
ulong?	assetId
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
Task<TransactionsResponse>

Implements

ISearchApi