Interface IIndexerClient
Inherited Members
Namespace: Algorand.Unity
Assembly: cs.temp.dll.dll
Syntax
public interface IIndexerClient : IAlgoApiClient
Methods
LookupAccountAppLocalStates(String, Optional<UInt64>, Optional<Boolean>, Optional<UInt64>, String)
Declaration
AlgoApiRequest.Sent<ApplicationLocalStatesResponse> LookupAccountAppLocalStates(string accountId, Optional<ulong> applicationId = default(Optional<ulong>), Optional<bool> includeAll = default(Optional<bool>), Optional<ulong> limit = default(Optional<ulong>), string next = null)
Parameters
Type | Name | Description |
---|---|---|
String | accountId | account string |
Optional<UInt64> | applicationId | Application ID |
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
Optional<UInt64> | 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 |
---|---|
AlgoApiRequest.Sent<ApplicationLocalStatesResponse> |
Remarks
Lookup an account's asset holdings, optionally for a specific ID.
LookupAccountAssets(String, Optional<UInt64>, Optional<Boolean>, Optional<UInt64>, String)
Declaration
AlgoApiRequest.Sent<AssetHoldingsResponse> LookupAccountAssets(string accountId, Optional<ulong> assetId = default(Optional<ulong>), Optional<bool> includeAll = default(Optional<bool>), Optional<ulong> limit = default(Optional<ulong>), string next = null)
Parameters
Type | Name | Description |
---|---|---|
String | accountId | account string |
Optional<UInt64> | assetId | Asset ID |
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
Optional<UInt64> | 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 |
---|---|
AlgoApiRequest.Sent<AssetHoldingsResponse> |
Remarks
Lookup an account's asset holdings, optionally for a specific ID.
LookupAccountByID(String, Optional<UInt64>, Optional<Boolean>, ExcludeAccountFields)
Declaration
AlgoApiRequest.Sent<AccountResponse> LookupAccountByID(string accountId, Optional<ulong> round = default(Optional<ulong>), Optional<bool> includeAll = default(Optional<bool>), ExcludeAccountFields exclude = ExcludeAccountFields.Unknown)
Parameters
Type | Name | Description |
---|---|---|
String | accountId | account string |
Optional<UInt64> | round | Include results for the specified round. |
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
ExcludeAccountFields | 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. |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<AccountResponse> |
Remarks
Lookup account information.
LookupAccountCreatedApplications(String, Optional<UInt64>, Optional<Boolean>, Optional<UInt64>, String)
Declaration
AlgoApiRequest.Sent<ApplicationsResponse> LookupAccountCreatedApplications(string accountId, Optional<ulong> applicationId = default(Optional<ulong>), Optional<bool> includeAll = default(Optional<bool>), Optional<ulong> limit = default(Optional<ulong>), string next = null)
Parameters
Type | Name | Description |
---|---|---|
String | accountId | account string |
Optional<UInt64> | applicationId | Application ID |
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
Optional<UInt64> | 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 |
---|---|
AlgoApiRequest.Sent<ApplicationsResponse> |
Remarks
Lookup an account's created application parameters, optionally for a specific ID.
LookupAccountCreatedAssets(String, Optional<UInt64>, Optional<Boolean>, Optional<UInt64>, String)
Declaration
AlgoApiRequest.Sent<AssetsResponse> LookupAccountCreatedAssets(string accountId, Optional<ulong> assetId = default(Optional<ulong>), Optional<bool> includeAll = default(Optional<bool>), Optional<ulong> limit = default(Optional<ulong>), string next = null)
Parameters
Type | Name | Description |
---|---|---|
String | accountId | account string |
Optional<UInt64> | assetId | Asset ID |
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
Optional<UInt64> | 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 |
---|---|
AlgoApiRequest.Sent<AssetsResponse> |
Remarks
Lookup an account's created asset parameters, optionally for a specific ID.
LookupAccountTransactions(String, Byte[], Optional<Boolean>, String, Optional<UInt64>, DateTime, String, Optional<UInt64>, DateTime, Optional<UInt64>, Optional<UInt64>, Optional<UInt64>, Optional<UInt64>, SignatureType, String, Optional<UInt64>)
Declaration
AlgoApiRequest.Sent<TransactionsResponse> LookupAccountTransactions(string accountId, byte[] notePrefix = null, Optional<bool> rekeyTo = default(Optional<bool>), string next = null, Optional<ulong> maxRound = default(Optional<ulong>), DateTime afterTime = default(DateTime), string txType = null, Optional<ulong> limit = default(Optional<ulong>), DateTime beforeTime = default(DateTime), Optional<ulong> minRound = default(Optional<ulong>), Optional<ulong> currencyGreaterThan = default(Optional<ulong>), Optional<ulong> assetId = default(Optional<ulong>), Optional<ulong> currencyLessThan = default(Optional<ulong>), SignatureType sigType = SignatureType.None, string txid = null, Optional<ulong> round = default(Optional<ulong>))
Parameters
Type | Name | Description |
---|---|---|
String | accountId | account string |
Byte[] | notePrefix | Specifies a prefix which must be contained in the note field. |
Optional<Boolean> | rekeyTo | Include results which include the rekey-to field. |
String | next | The next page of results. Use the next token provided by the previous results. |
Optional<UInt64> | maxRound | Include results at or before the specified max-round. |
DateTime | afterTime | Include results after the given time. Must be an RFC 3339 formatted string. |
String | txType | |
Optional<UInt64> | limit | Maximum number of results to return. There could be additional pages even if the limit is not reached. |
DateTime | beforeTime | Include results before the given time. Must be an RFC 3339 formatted string. |
Optional<UInt64> | minRound | Include results at or after the specified min-round. |
Optional<UInt64> | 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<UInt64> | assetId | Asset ID |
Optional<UInt64> | 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. |
SignatureType | sigType | SigType filters just results using the specified type of signature:
|
String | txid | Lookup the specific transaction by ID. |
Optional<UInt64> | round | Include results for the specified round. |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<TransactionsResponse> |
Remarks
Lookup account transactions. Transactions are returned newest to oldest.
LookupApplicationBoxByIDAndName(UInt64, String)
Get box information for a given application.
Declaration
AlgoApiRequest.Sent<BoxResponse> LookupApplicationBoxByIDAndName(ulong applicationId, string boxName)
Parameters
Type | Name | Description |
---|---|---|
UInt64 | applicationId | |
String | boxName | A box name in goal-arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'. |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<BoxResponse> |
Remarks
Given an application ID and box name, returns base64 encoded box name and value. Box names must be in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, encode base 64 and use 'b64' prefix as in 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.
LookupApplicationByID(UInt64, Optional<Boolean>)
Declaration
AlgoApiRequest.Sent<ApplicationResponse> LookupApplicationByID(ulong applicationId, Optional<bool> includeAll = default(Optional<bool>))
Parameters
Type | Name | Description |
---|---|---|
UInt64 | applicationId | |
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<ApplicationResponse> |
Remarks
Lookup application.
LookupApplicationLogsByID(UInt64, Optional<UInt64>, String, String, Optional<UInt64>, Optional<UInt64>, Address)
Declaration
AlgoApiRequest.Sent<ApplicationLogsResponse> LookupApplicationLogsByID(ulong applicationId, Optional<ulong> limit = default(Optional<ulong>), string next = null, string txid = null, Optional<ulong> minRound = default(Optional<ulong>), Optional<ulong> maxRound = default(Optional<ulong>), Address senderAddress = default(Address))
Parameters
Type | Name | Description |
---|---|---|
UInt64 | applicationId | |
Optional<UInt64> | 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. |
String | txid | Lookup the specific transaction by ID. |
Optional<UInt64> | minRound | Include results at or after the specified min-round. |
Optional<UInt64> | maxRound | Include results at or before the specified max-round. |
Address | senderAddress | Only include transactions with this sender address. |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<ApplicationLogsResponse> |
Remarks
Lookup application logs.
LookupAssetBalances(UInt64, Optional<Boolean>, Optional<UInt64>, String, Optional<UInt64>, Optional<UInt64>)
Declaration
AlgoApiRequest.Sent<AssetBalancesResponse> LookupAssetBalances(ulong assetId, Optional<bool> includeAll = default(Optional<bool>), Optional<ulong> limit = default(Optional<ulong>), string next = null, Optional<ulong> currencyGreaterThan = default(Optional<ulong>), Optional<ulong> currencyLessThan = default(Optional<ulong>))
Parameters
Type | Name | Description |
---|---|---|
UInt64 | assetId | |
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
Optional<UInt64> | 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. |
Optional<UInt64> | 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<UInt64> | 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. |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<AssetBalancesResponse> |
Remarks
Lookup the list of accounts who hold this asset
LookupAssetByID(UInt64, Optional<Boolean>)
Declaration
AlgoApiRequest.Sent<AssetResponse> LookupAssetByID(ulong assetId, Optional<bool> includeAll = default(Optional<bool>))
Parameters
Type | Name | Description |
---|---|---|
UInt64 | assetId | |
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<AssetResponse> |
Remarks
Lookup asset information.
LookupAssetTransactions(UInt64, Byte[], Optional<Boolean>, String, Optional<UInt64>, DateTime, String, Optional<Boolean>, Optional<UInt64>, DateTime, Optional<UInt64>, Optional<UInt64>, Address, Optional<UInt64>, SignatureType, String, AddressRole, Optional<UInt64>)
Declaration
AlgoApiRequest.Sent<TransactionsResponse> LookupAssetTransactions(ulong assetId, byte[] notePrefix = null, Optional<bool> rekeyTo = default(Optional<bool>), string next = null, Optional<ulong> maxRound = default(Optional<ulong>), DateTime afterTime = default(DateTime), string txType = null, Optional<bool> excludeCloseTo = default(Optional<bool>), Optional<ulong> limit = default(Optional<ulong>), DateTime beforeTime = default(DateTime), Optional<ulong> minRound = default(Optional<ulong>), Optional<ulong> currencyGreaterThan = default(Optional<ulong>), Address address = default(Address), Optional<ulong> currencyLessThan = default(Optional<ulong>), SignatureType sigType = SignatureType.None, string txid = null, AddressRole addressRole = AddressRole.None, Optional<ulong> round = default(Optional<ulong>))
Parameters
Type | Name | Description |
---|---|---|
UInt64 | assetId | |
Byte[] | notePrefix | Specifies a prefix which must be contained in the note field. |
Optional<Boolean> | rekeyTo | Include results which include the rekey-to field. |
String | next | The next page of results. Use the next token provided by the previous results. |
Optional<UInt64> | maxRound | Include results at or before the specified max-round. |
DateTime | afterTime | Include results after the given time. Must be an RFC 3339 formatted string. |
String | txType | |
Optional<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<UInt64> | limit | Maximum number of results to return. There could be additional pages even if the limit is not reached. |
DateTime | beforeTime | Include results before the given time. Must be an RFC 3339 formatted string. |
Optional<UInt64> | minRound | Include results at or after the specified min-round. |
Optional<UInt64> | 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. |
Address | address | Only include transactions with this address in one of the transaction fields. |
Optional<UInt64> | 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. |
SignatureType | sigType | SigType filters just results using the specified type of signature:
|
String | txid | Lookup the specific transaction by ID. |
AddressRole | addressRole | Combine with the address parameter to define what type of address to search for. |
Optional<UInt64> | round | Include results for the specified round. |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<TransactionsResponse> |
Remarks
Lookup transactions for an asset. Transactions are returned oldest to newest.
LookupBlock(UInt64, Optional<Boolean>)
Declaration
AlgoApiRequest.Sent<BlockResponse> LookupBlock(ulong roundNumber, Optional<bool> headerOnly = default(Optional<bool>))
Parameters
Type | Name | Description |
---|---|---|
UInt64 | roundNumber | Round number |
Optional<Boolean> | headerOnly | Header only flag. When this is set to true, returned block does not contain the transactions |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<BlockResponse> |
Remarks
Lookup block.
LookupTransaction(String)
Declaration
AlgoApiRequest.Sent<TransactionResponse> LookupTransaction(string txid)
Parameters
Type | Name | Description |
---|---|---|
String | txid |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<TransactionResponse> |
Remarks
Lookup a single transaction.
MakeHealthCheck()
Returns 200 if healthy.
Declaration
AlgoApiRequest.Sent<HealthCheckResponse> MakeHealthCheck()
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<HealthCheckResponse> |
SearchForAccounts(String, Optional<UInt64>, Optional<UInt64>, Optional<UInt64>, Address, Optional<UInt64>, ExcludeAccountFields, Optional<UInt64>, Optional<UInt64>, Optional<Boolean>)
Declaration
AlgoApiRequest.Sent<AccountsResponse> SearchForAccounts(string next = null, Optional<ulong> applicationId = default(Optional<ulong>), Optional<ulong> limit = default(Optional<ulong>), Optional<ulong> currencyGreaterThan = default(Optional<ulong>), Address authAddr = default(Address), Optional<ulong> assetId = default(Optional<ulong>), ExcludeAccountFields exclude = ExcludeAccountFields.Unknown, Optional<ulong> currencyLessThan = default(Optional<ulong>), Optional<ulong> round = default(Optional<ulong>), Optional<bool> includeAll = default(Optional<bool>))
Parameters
Type | Name | Description |
---|---|---|
String | next | The next page of results. Use the next token provided by the previous results. |
Optional<UInt64> | applicationId | Application ID |
Optional<UInt64> | limit | Maximum number of results to return. There could be additional pages even if the limit is not reached. |
Optional<UInt64> | 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. |
Address | authAddr | Include accounts configured to use this spending key. |
Optional<UInt64> | assetId | Asset ID |
ExcludeAccountFields | 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. |
Optional<UInt64> | 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<UInt64> | round | Include results for the specified round. For performance reasons, this parameter may be disabled on some configurations. Using application-id or asset-id filters will return both creator and opt-in accounts. Filtering by include-all will return creator and opt-in accounts for deleted assets and accounts. Non-opt-in managers are not included in the results when asset-id is used. |
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<AccountsResponse> |
Remarks
Search for accounts.
SearchForApplicationBoxes(UInt64, Optional<UInt64>, String)
Get box names for a given application.
Declaration
AlgoApiRequest.Sent<BoxesResponse> SearchForApplicationBoxes(ulong applicationId, Optional<ulong> limit = default(Optional<ulong>), string next = null)
Parameters
Type | Name | Description |
---|---|---|
UInt64 | applicationId | |
Optional<UInt64> | 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 |
---|---|
AlgoApiRequest.Sent<BoxesResponse> |
Remarks
Given an application ID, returns the box names of that application sorted lexicographically.
SearchForApplications(Optional<UInt64>, String, Optional<Boolean>, Optional<UInt64>, String)
Declaration
AlgoApiRequest.Sent<ApplicationsResponse> SearchForApplications(Optional<ulong> applicationId = default(Optional<ulong>), string creator = null, Optional<bool> includeAll = default(Optional<bool>), Optional<ulong> limit = default(Optional<ulong>), string next = null)
Parameters
Type | Name | Description |
---|---|---|
Optional<UInt64> | applicationId | Application ID |
String | creator | Filter just applications with the given creator address. |
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
Optional<UInt64> | 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 |
---|---|
AlgoApiRequest.Sent<ApplicationsResponse> |
Remarks
Search for applications
SearchForAssets(Optional<Boolean>, Optional<UInt64>, String, String, String, String, Optional<UInt64>)
Declaration
AlgoApiRequest.Sent<AssetsResponse> SearchForAssets(Optional<bool> includeAll = default(Optional<bool>), Optional<ulong> limit = default(Optional<ulong>), string next = null, string creator = null, string name = null, string unit = null, Optional<ulong> assetId = default(Optional<ulong>))
Parameters
Type | Name | Description |
---|---|---|
Optional<Boolean> | includeAll | Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. |
Optional<UInt64> | 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. |
String | creator | Filter just assets with the given creator address. |
String | name | Filter just assets with the given name. |
String | unit | Filter just assets with the given unit. |
Optional<UInt64> | assetId | Asset ID |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<AssetsResponse> |
Remarks
Search for assets.
SearchForTransactions(Byte[], Optional<Boolean>, String, Optional<UInt64>, DateTime, Optional<UInt64>, String, Optional<Boolean>, Optional<UInt64>, DateTime, Optional<UInt64>, Optional<UInt64>, Address, Optional<UInt64>, Optional<UInt64>, SignatureType, String, AddressRole, Optional<UInt64>)
Declaration
AlgoApiRequest.Sent<TransactionsResponse> SearchForTransactions(byte[] notePrefix = null, Optional<bool> rekeyTo = default(Optional<bool>), string next = null, Optional<ulong> maxRound = default(Optional<ulong>), DateTime afterTime = default(DateTime), Optional<ulong> applicationId = default(Optional<ulong>), string txType = null, Optional<bool> excludeCloseTo = default(Optional<bool>), Optional<ulong> limit = default(Optional<ulong>), DateTime beforeTime = default(DateTime), Optional<ulong> minRound = default(Optional<ulong>), Optional<ulong> currencyGreaterThan = default(Optional<ulong>), Address address = default(Address), Optional<ulong> assetId = default(Optional<ulong>), Optional<ulong> currencyLessThan = default(Optional<ulong>), SignatureType sigType = SignatureType.None, string txid = null, AddressRole addressRole = AddressRole.None, Optional<ulong> round = default(Optional<ulong>))
Parameters
Type | Name | Description |
---|---|---|
Byte[] | notePrefix | Specifies a prefix which must be contained in the note field. |
Optional<Boolean> | rekeyTo | Include results which include the rekey-to field. |
String | next | The next page of results. Use the next token provided by the previous results. |
Optional<UInt64> | maxRound | Include results at or before the specified max-round. |
DateTime | afterTime | Include results after the given time. Must be an RFC 3339 formatted string. |
Optional<UInt64> | applicationId | Application ID |
String | txType | |
Optional<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<UInt64> | limit | Maximum number of results to return. There could be additional pages even if the limit is not reached. |
DateTime | beforeTime | Include results before the given time. Must be an RFC 3339 formatted string. |
Optional<UInt64> | minRound | Include results at or after the specified min-round. |
Optional<UInt64> | 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. |
Address | address | Only include transactions with this address in one of the transaction fields. |
Optional<UInt64> | assetId | Asset ID |
Optional<UInt64> | 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. |
SignatureType | sigType | SigType filters just results using the specified type of signature:
|
String | txid | Lookup the specific transaction by ID. |
AddressRole | addressRole | Combine with the address parameter to define what type of address to search for. |
Optional<UInt64> | round | Include results for the specified round. |
Returns
Type | Description |
---|---|
AlgoApiRequest.Sent<TransactionsResponse> |
Remarks
Search for transactions. Transactions are returned oldest to newest unless the address parameter is used, in which case results are returned newest to oldest.