Class IndexerApi
an IndexerClient for communicating with the REST API.
Inheritance
Inherited Members
Namespace: Algorand.V2
Assembly: Algorand.dll
Syntax
public class IndexerApi
Constructors
| Improve this Doc View SourceIndexerApi(String, String, Int32)
Construct an AlgodClient for communicating with the REST API.
Declaration
public IndexerApi(string host, string token, int timeout = -1)
Parameters
Type | Name | Description |
---|---|---|
System.String | host | using a URI format.If the scheme is not supplied the client will use HTTP. |
System.String | token | authentication token. |
System.Int32 | timeout | time out. |
Methods
| Improve this Doc View SourceLookupAccountByID(String, Nullable<Int64>)
Lookup account information.
Declaration
public AccountResponse LookupAccountByID(string accountId, long? round = default(long? ))
Parameters
Type | Name | Description |
---|---|---|
System.String | accountId | account string |
System.Nullable<System.Int64> | round | Include results for the specified round. (optional) |
Returns
Type | Description |
---|---|
AccountResponse | AccountResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupAccountTransactions(String, Nullable<Int64>, String, String, String, String, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>)
Lookup account transactions.
Declaration
public TransactionsResponse LookupAccountTransactions(string accountId, long? limit = default(long? ), string next = null, string notePrefix = null, string txType = null, string sigType = null, string txid = null, long? round = default(long? ), long? minRound = default(long? ), long? maxRound = default(long? ), long? assetId = default(long? ), DateTime? beforeTime = default(DateTime? ), DateTime? afterTime = default(DateTime? ), long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), bool? rekeyTo = default(bool? ))
Parameters
Type | Name | Description |
---|---|---|
System.String | accountId | account string |
System.Nullable<System.Int64> | limit | Maximum number of results to return. (optional) |
System.String | next | The next page of results. Use the next token provided by the previous results. (optional) |
System.String | notePrefix | Specifies a prefix which must be contained in the note field. (optional) |
System.String | txType | (optional) |
System.String | sigType | SigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig (optional) |
System.String | txid | Lookup the specific transaction by ID. (optional) |
System.Nullable<System.Int64> | round | Include results for the specified round. (optional) |
System.Nullable<System.Int64> | minRound | Include results at or after the specified min-round. (optional) |
System.Nullable<System.Int64> | maxRound | Include results at or before the specified max-round. (optional) |
System.Nullable<System.Int64> | assetId | Asset ID (optional) |
System.Nullable<System.DateTime> | beforeTime | Include results before the given time. Must be an RFC 3339 formatted string. (optional) |
System.Nullable<System.DateTime> | afterTime | Include results after the given time. Must be an RFC 3339 formatted string. (optional) |
System.Nullable<System.Int64> | currencyGreaterThan | Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional) |
System.Nullable<System.Int64> | currencyLessThan | Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional) |
System.Nullable<System.Boolean> | rekeyTo | Include results which include the rekey-to field. (optional) |
Returns
Type | Description |
---|---|
TransactionsResponse | TransactionsResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupApplicationByID(Nullable<Int64>)
Lookup application.
Declaration
public ApplicationResponse LookupApplicationByID(long? applicationId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | applicationId |
Returns
Type | Description |
---|---|
ApplicationResponse | ApplicationResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupAssetBalances(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>)
Lookup the list of accounts who hold this asset
Declaration
public AssetBalancesResponse LookupAssetBalances(long? assetId, long? limit = default(long? ), string next = null, long? round = default(long? ), long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ))
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | assetId | |
System.Nullable<System.Int64> | limit | Maximum number of results to return. (optional) |
System.String | next | The next page of results. Use the next token provided by the previous results. (optional) |
System.Nullable<System.Int64> | round | Include results for the specified round. (optional) |
System.Nullable<System.Int64> | currencyGreaterThan | Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional) |
System.Nullable<System.Int64> | currencyLessThan | Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional) |
Returns
Type | Description |
---|---|
AssetBalancesResponse | AssetBalancesResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupAssetByID(Nullable<Int64>)
Lookup asset information.
Declaration
public AssetResponse LookupAssetByID(long? assetId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | assetId |
Returns
Type | Description |
---|---|
AssetResponse | AssetResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupAssetTransactions(Nullable<Int64>, Nullable<Int64>, String, String, String, String, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>, Nullable<Int64>, String, String, Nullable<Boolean>, Nullable<Boolean>)
Lookup transactions for an asset.
Declaration
public TransactionsResponse LookupAssetTransactions(long? assetId, long? limit = default(long? ), string next = null, string notePrefix = null, string txType = null, string sigType = null, string txid = null, long? round = default(long? ), long? minRound = default(long? ), long? maxRound = default(long? ), DateTime? beforeTime = default(DateTime? ), DateTime? afterTime = default(DateTime? ), long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string address = null, string addressRole = null, bool? excludeCloseTo = default(bool? ), bool? rekeyTo = default(bool? ))
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | assetId | |
System.Nullable<System.Int64> | limit | Maximum number of results to return. (optional) |
System.String | next | The next page of results. Use the next token provided by the previous results. (optional) |
System.String | notePrefix | Specifies a prefix which must be contained in the note field. (optional) |
System.String | txType | (optional) |
System.String | sigType | SigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig (optional) |
System.String | txid | Lookup the specific transaction by ID. (optional) |
System.Nullable<System.Int64> | round | Include results for the specified round. (optional) |
System.Nullable<System.Int64> | minRound | Include results at or after the specified min-round. (optional) |
System.Nullable<System.Int64> | maxRound | Include results at or before the specified max-round. (optional) |
System.Nullable<System.DateTime> | beforeTime | Include results before the given time. Must be an RFC 3339 formatted string. (optional) |
System.Nullable<System.DateTime> | afterTime | Include results after the given time. Must be an RFC 3339 formatted string. (optional) |
System.Nullable<System.Int64> | currencyGreaterThan | Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional) |
System.Nullable<System.Int64> | currencyLessThan | Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional) |
System.String | address | Only include transactions with this address in one of the transaction fields. (optional) |
System.String | addressRole | Combine with the address parameter to define what type of address to search for. (optional) |
System.Nullable<System.Boolean> | excludeCloseTo | Combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true. (optional) |
System.Nullable<System.Boolean> | rekeyTo | Include results which include the rekey-to field. (optional) |
Returns
Type | Description |
---|---|
TransactionsResponse | TransactionsResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupBlock(Nullable<Int64>)
Lookup block.
Declaration
public Block LookupBlock(long? roundNumber)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | roundNumber | Round number |
Returns
Type | Description |
---|---|
Block | Block |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupTransactions(String)
Lookup a single transaction.
Declaration
public TransactionResponse LookupTransactions(string txid)
Parameters
Type | Name | Description |
---|---|---|
System.String | txid |
Returns
Type | Description |
---|---|
TransactionResponse | TransactionResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
MakeHealthCheck()
Returns 200 if healthy.
Declaration
public HealthCheck MakeHealthCheck()
Returns
Type | Description |
---|---|
HealthCheck | HealthCheck |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SearchForAccounts(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>)
Search for accounts.
Declaration
public AccountsResponse SearchForAccounts(long? assetId = default(long? ), long? limit = default(long? ), string next = null, long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string authAddr = null, long? round = default(long? ), long? applicationId = default(long? ))
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | assetId | Asset ID (optional) |
System.Nullable<System.Int64> | limit | Maximum number of results to return. (optional) |
System.String | next | The next page of results. Use the next token provided by the previous results. (optional) |
System.Nullable<System.Int64> | currencyGreaterThan | Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional) |
System.Nullable<System.Int64> | currencyLessThan | Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional) |
System.String | authAddr | Include accounts configured to use this spending key. (optional) |
System.Nullable<System.Int64> | round | Include results for the specified round. For performance reasons, this parameter may be disabled on some configurations. (optional) |
System.Nullable<System.Int64> | applicationId | Application ID (optional) |
Returns
Type | Description |
---|---|
AccountsResponse | AccountsResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SearchForApplications(Nullable<Int64>, Nullable<Int64>, String)
Search for applications
Declaration
public ApplicationsResponse SearchForApplications(long? applicationId = default(long? ), long? limit = default(long? ), string next = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | applicationId | Application ID (optional) |
System.Nullable<System.Int64> | limit | Maximum number of results to return. (optional) |
System.String | next | The next page of results. Use the next token provided by the previous results. (optional) |
Returns
Type | Description |
---|---|
ApplicationsResponse | ApplicationsResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SearchForAssets(Nullable<Int64>, String, String, String, String, Nullable<Int64>)
Search for assets.
Declaration
public AssetsResponse SearchForAssets(long? limit = default(long? ), string next = null, string creator = null, string name = null, string unit = null, long? assetId = default(long? ))
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | limit | Maximum number of results to return. (optional) |
System.String | next | The next page of results. Use the next token provided by the previous results. (optional) |
System.String | creator | Filter just assets with the given creator address. (optional) |
System.String | name | Filter just assets with the given name. (optional) |
System.String | unit | Filter just assets with the given unit. (optional) |
System.Nullable<System.Int64> | assetId | Asset ID (optional) |
Returns
Type | Description |
---|---|
AssetsResponse | AssetsResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SearchForTransactions(Nullable<Int64>, String, String, String, String, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>, Nullable<Int64>, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int64>)
Search for transactions.
Declaration
public TransactionsResponse SearchForTransactions(long? limit = default(long? ), string next = null, string notePrefix = null, string txType = null, string sigType = null, string txid = null, long? round = default(long? ), long? minRound = default(long? ), long? maxRound = default(long? ), long? assetId = default(long? ), DateTime? beforeTime = default(DateTime? ), DateTime? afterTime = default(DateTime? ), long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string address = null, string addressRole = null, bool? excludeCloseTo = default(bool? ), bool? rekeyTo = default(bool? ), long? applicationId = default(long? ))
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | limit | Maximum number of results to return. (optional) |
System.String | next | The next page of results. Use the next token provided by the previous results. (optional) |
System.String | notePrefix | Specifies a prefix which must be contained in the note field. (optional) |
System.String | txType | (optional) |
System.String | sigType | SigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig (optional) |
System.String | txid | Lookup the specific transaction by ID. (optional) |
System.Nullable<System.Int64> | round | Include results for the specified round. (optional) |
System.Nullable<System.Int64> | minRound | Include results at or after the specified min-round. (optional) |
System.Nullable<System.Int64> | maxRound | Include results at or before the specified max-round. (optional) |
System.Nullable<System.Int64> | assetId | Asset ID (optional) |
System.Nullable<System.DateTime> | beforeTime | Include results before the given time. Must be an RFC 3339 formatted string. (optional) |
System.Nullable<System.DateTime> | afterTime | Include results after the given time. Must be an RFC 3339 formatted string. (optional) |
System.Nullable<System.Int64> | currencyGreaterThan | Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional) |
System.Nullable<System.Int64> | currencyLessThan | Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional) |
System.String | address | Only include transactions with this address in one of the transaction fields. (optional) |
System.String | addressRole | Combine with the address parameter to define what type of address to search for. (optional) |
System.Nullable<System.Boolean> | excludeCloseTo | Combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true. (optional) |
System.Nullable<System.Boolean> | rekeyTo | Include results which include the rekey-to field. (optional) |
System.Nullable<System.Int64> | applicationId | Application ID (optional) |
Returns
Type | Description |
---|---|
TransactionsResponse | TransactionsResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |