Class LookupApi
Represents a collection of functions to interact with the API endpoints
Inheritance
Inherited Members
Namespace: Algorand.V2.Indexer
Assembly: Algorand.dll
Syntax
public class LookupApi : ILookupApi, IApiAccessor
Constructors
| Improve this Doc View SourceLookupApi()
Initializes a new instance of the LookupApi class
Declaration
public LookupApi()
LookupApi(Configuration)
Initializes a new instance of the LookupApi class using Configuration object
Declaration
public LookupApi(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
Configuration | configuration | An instance of Configuration |
LookupApi(String)
Initializes a new instance of the LookupApi class.
Declaration
public LookupApi(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |
Properties
| Improve this Doc View SourceConfiguration
Gets or sets the configuration object
Declaration
public Configuration Configuration { get; set; }
Property Value
Type | Description |
---|---|
Configuration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
ExceptionFactory |
Methods
| Improve this Doc View SourceAddDefaultHeader(String, String)
Add default header.
Declaration
[Obsolete("AddDefaultHeader is deprecated, please use Configuration.AddDefaultHeader instead.")]
public void AddDefaultHeader(string key, string value)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | Header field name. |
System.String | value | Header field value. |
DefaultHeader()
Gets the default header.
Declaration
[Obsolete("DefaultHeader is deprecated, please use Configuration.DefaultHeader instead.")]
public IDictionary<string, string> DefaultHeader()
Returns
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.String, System.String> | Dictionary of HTTP header |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
System.String | The base path |
LookupAccountByID(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 |
LookupAccountByIDAsync(String, Nullable<Int64>)
Lookup account information.
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupAccountByIDAsyncWithHttpInfo(String, Nullable<Int64>)
Lookup account information.
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupAccountByIDWithHttpInfo(String, Nullable<Int64>)
Lookup account information.
Declaration
public 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 |
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 |
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>)
Lookup account transactions.
Declaration
public 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 |
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>)
Lookup account transactions.
Declaration
public 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) |
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>)
Lookup account transactions.
Declaration
public 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 |
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 |
LookupApplicationByIDAsync(Nullable<Int64>)
Lookup application.
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupApplicationByIDAsyncWithHttpInfo(Nullable<Int64>)
Lookup application.
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupApplicationByIDWithHttpInfo(Nullable<Int64>)
Lookup application.
Declaration
public ApiResponse<ApplicationResponse> LookupApplicationByIDWithHttpInfo(long? applicationId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | applicationId |
Returns
Type | Description |
---|---|
ApiResponse<ApplicationResponse> | ApiResponse of 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 |
LookupAssetBalancesAsync(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>)
Lookup the list of accounts who hold this asset
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupAssetBalancesAsyncWithHttpInfo(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>)
Lookup the list of accounts who hold this asset
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupAssetBalancesWithHttpInfo(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>)
Lookup the list of accounts who hold this asset
Declaration
public 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 |
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 |
LookupAssetByIDAsync(Nullable<Int64>)
Lookup asset information.
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupAssetByIDAsyncWithHttpInfo(Nullable<Int64>)
Lookup asset information.
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupAssetByIDWithHttpInfo(Nullable<Int64>)
Lookup asset information.
Declaration
public ApiResponse<AssetResponse> LookupAssetByIDWithHttpInfo(long? assetId)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | assetId |
Returns
Type | Description |
---|---|
ApiResponse<AssetResponse> | ApiResponse of 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 |
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>)
Lookup transactions for an asset.
Declaration
public 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 |
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>)
Lookup transactions for an asset.
Declaration
public 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) |
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>)
Lookup transactions for an asset.
Declaration
public 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 |
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 |
LookupBlockAsync(Nullable<Int64>)
Lookup block.
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupBlockAsyncWithHttpInfo(Nullable<Int64>)
Lookup block.
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupBlockWithHttpInfo(Nullable<Int64>)
Lookup block.
Declaration
public ApiResponse<Block> LookupBlockWithHttpInfo(long? roundNumber)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Int64> | roundNumber | Round number |
Returns
Type | Description |
---|---|
ApiResponse<Block> | ApiResponse of 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 |
LookupTransactionsAsync(String)
Lookup a single transaction.
Declaration
public Task<TransactionResponse> LookupTransactionsAsync(string txid)
Parameters
Type | Name | Description |
---|---|---|
System.String | txid |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TransactionResponse> | Task of TransactionResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupTransactionsAsyncWithHttpInfo(String)
Lookup a single transaction.
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
LookupTransactionsWithHttpInfo(String)
Lookup a single transaction.
Declaration
public ApiResponse<TransactionResponse> LookupTransactionsWithHttpInfo(string txid)
Parameters
Type | Name | Description |
---|---|---|
System.String | txid |
Returns
Type | Description |
---|---|
ApiResponse<TransactionResponse> | ApiResponse of TransactionResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SetBasePath(String)
Sets the base path of the API client.
Declaration
[Obsolete("SetBasePath is deprecated, please do 'Configuration.ApiClient = new ApiClient(\"http://new-path\")' instead.")]
public void SetBasePath(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |