Interface ILookupApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Algorand.V2.Indexer
Assembly: Algorand.dll
Syntax
public interface ILookupApi : IApiAccessorMethods
| Improve this Doc View SourceLookupAccountByID(String, Nullable<Int64>)
Declaration
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 |
Remarks
Lookup account information.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAccountByIDAsync(String, Nullable<Int64>)
Declaration
Task<AccountResponse> LookupAccountByIDAsync(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 |
|---|---|
| System.Threading.Tasks.Task<AccountResponse> | Task of AccountResponse |
Remarks
Lookup account information.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAccountByIDAsyncWithHttpInfo(String, Nullable<Int64>)
Declaration
Task<ApiResponse<AccountResponse>> LookupAccountByIDAsyncWithHttpInfo(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 |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<AccountResponse>> | Task of ApiResponse (AccountResponse) |
Remarks
Lookup account information.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAccountByIDWithHttpInfo(String, Nullable<Int64>)
Declaration
ApiResponse<AccountResponse> LookupAccountByIDWithHttpInfo(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 |
|---|---|
| ApiResponse<AccountResponse> | ApiResponse of AccountResponse |
Remarks
Lookup account information.
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>)
Declaration
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 |
Remarks
Lookup account transactions.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAccountTransactionsAsync(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>)
Declaration
Task<TransactionsResponse> LookupAccountTransactionsAsync(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 |
|---|---|
| System.Threading.Tasks.Task<TransactionsResponse> | Task of TransactionsResponse |
Remarks
Lookup account transactions.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAccountTransactionsAsyncWithHttpInfo(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>)
Declaration
Task<ApiResponse<TransactionsResponse>> LookupAccountTransactionsAsyncWithHttpInfo(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 |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<TransactionsResponse>> | Task of ApiResponse (TransactionsResponse) |
Remarks
Lookup account transactions.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAccountTransactionsWithHttpInfo(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>)
Declaration
ApiResponse<TransactionsResponse> LookupAccountTransactionsWithHttpInfo(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 |
|---|---|
| ApiResponse<TransactionsResponse> | ApiResponse of TransactionsResponse |
Remarks
Lookup account transactions.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupApplicationByID(Nullable<Int64>)
Declaration
ApplicationResponse LookupApplicationByID(long? applicationId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | applicationId |
Returns
| Type | Description |
|---|---|
| ApplicationResponse | ApplicationResponse |
Remarks
Lookup application.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupApplicationByIDAsync(Nullable<Int64>)
Declaration
Task<ApplicationResponse> LookupApplicationByIDAsync(long? applicationId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | applicationId |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApplicationResponse> | Task of ApplicationResponse |
Remarks
Lookup application.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupApplicationByIDAsyncWithHttpInfo(Nullable<Int64>)
Declaration
Task<ApiResponse<ApplicationResponse>> LookupApplicationByIDAsyncWithHttpInfo(long? applicationId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | applicationId |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<ApplicationResponse>> | Task of ApiResponse (ApplicationResponse) |
Remarks
Lookup application.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupApplicationByIDWithHttpInfo(Nullable<Int64>)
Declaration
ApiResponse<ApplicationResponse> LookupApplicationByIDWithHttpInfo(long? applicationId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | applicationId |
Returns
| Type | Description |
|---|---|
| ApiResponse<ApplicationResponse> | ApiResponse of ApplicationResponse |
Remarks
Lookup application.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetBalances(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>)
Declaration
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 |
Remarks
Lookup the list of accounts who hold this asset
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetBalancesAsync(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>)
Declaration
Task<AssetBalancesResponse> LookupAssetBalancesAsync(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 |
|---|---|
| System.Threading.Tasks.Task<AssetBalancesResponse> | Task of AssetBalancesResponse |
Remarks
Lookup the list of accounts who hold this asset
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetBalancesAsyncWithHttpInfo(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>)
Declaration
Task<ApiResponse<AssetBalancesResponse>> LookupAssetBalancesAsyncWithHttpInfo(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 |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<AssetBalancesResponse>> | Task of ApiResponse (AssetBalancesResponse) |
Remarks
Lookup the list of accounts who hold this asset
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetBalancesWithHttpInfo(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>)
Declaration
ApiResponse<AssetBalancesResponse> LookupAssetBalancesWithHttpInfo(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 |
|---|---|
| ApiResponse<AssetBalancesResponse> | ApiResponse of AssetBalancesResponse |
Remarks
Lookup the list of accounts who hold this asset
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetByID(Nullable<Int64>)
Declaration
AssetResponse LookupAssetByID(long? assetId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | assetId |
Returns
| Type | Description |
|---|---|
| AssetResponse | AssetResponse |
Remarks
Lookup asset information.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetByIDAsync(Nullable<Int64>)
Declaration
Task<AssetResponse> LookupAssetByIDAsync(long? assetId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | assetId |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AssetResponse> | Task of AssetResponse |
Remarks
Lookup asset information.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetByIDAsyncWithHttpInfo(Nullable<Int64>)
Declaration
Task<ApiResponse<AssetResponse>> LookupAssetByIDAsyncWithHttpInfo(long? assetId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | assetId |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<AssetResponse>> | Task of ApiResponse (AssetResponse) |
Remarks
Lookup asset information.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetByIDWithHttpInfo(Nullable<Int64>)
Declaration
ApiResponse<AssetResponse> LookupAssetByIDWithHttpInfo(long? assetId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | assetId |
Returns
| Type | Description |
|---|---|
| ApiResponse<AssetResponse> | ApiResponse of AssetResponse |
Remarks
Lookup asset information.
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>)
Declaration
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 |
Remarks
Lookup transactions for an asset.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetTransactionsAsync(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>)
Declaration
Task<TransactionsResponse> LookupAssetTransactionsAsync(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 |
|---|---|
| System.Threading.Tasks.Task<TransactionsResponse> | Task of TransactionsResponse |
Remarks
Lookup transactions for an asset.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetTransactionsAsyncWithHttpInfo(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>)
Declaration
Task<ApiResponse<TransactionsResponse>> LookupAssetTransactionsAsyncWithHttpInfo(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 |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<TransactionsResponse>> | Task of ApiResponse (TransactionsResponse) |
Remarks
Lookup transactions for an asset.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupAssetTransactionsWithHttpInfo(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>)
Declaration
ApiResponse<TransactionsResponse> LookupAssetTransactionsWithHttpInfo(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 |
|---|---|
| ApiResponse<TransactionsResponse> | ApiResponse of TransactionsResponse |
Remarks
Lookup transactions for an asset.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupBlock(Nullable<Int64>)
Declaration
Block LookupBlock(long? roundNumber)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | roundNumber | Round number |
Returns
| Type | Description |
|---|---|
| Block | Block |
Remarks
Lookup block.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupBlockAsync(Nullable<Int64>)
Declaration
Task<Block> LookupBlockAsync(long? roundNumber)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | roundNumber | Round number |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Block> | Task of Block |
Remarks
Lookup block.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupBlockAsyncWithHttpInfo(Nullable<Int64>)
Declaration
Task<ApiResponse<Block>> LookupBlockAsyncWithHttpInfo(long? roundNumber)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | roundNumber | Round number |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<Block>> | Task of ApiResponse (Block) |
Remarks
Lookup block.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupBlockWithHttpInfo(Nullable<Int64>)
Declaration
ApiResponse<Block> LookupBlockWithHttpInfo(long? roundNumber)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | roundNumber | Round number |
Returns
| Type | Description |
|---|---|
| ApiResponse<Block> | ApiResponse of Block |
Remarks
Lookup block.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupTransactions(String)
Declaration
TransactionResponse LookupTransactions(string txid)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | txid |
Returns
| Type | Description |
|---|---|
| TransactionResponse | TransactionResponse |
Remarks
Lookup a single transaction.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupTransactionsAsync(String)
Declaration
Task<TransactionResponse> LookupTransactionsAsync(string txid)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | txid |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TransactionResponse> | Task of TransactionResponse |
Remarks
Lookup a single transaction.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupTransactionsAsyncWithHttpInfo(String)
Declaration
Task<ApiResponse<TransactionResponse>> LookupTransactionsAsyncWithHttpInfo(string txid)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | txid |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<TransactionResponse>> | Task of ApiResponse (TransactionResponse) |
Remarks
Lookup a single transaction.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupTransactionsWithHttpInfo(String)
Declaration
ApiResponse<TransactionResponse> LookupTransactionsWithHttpInfo(string txid)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | txid |
Returns
| Type | Description |
|---|---|
| ApiResponse<TransactionResponse> | ApiResponse of TransactionResponse |
Remarks
Lookup a single transaction.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |