Show / Hide Table of Contents

    Class SearchApi

    Represents a collection of functions to interact with the API endpoints

    Inheritance
    System.Object
    SearchApi
    Implements
    ISearchApi
    IApiAccessor
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Algorand.V2.Indexer
    Assembly: Algorand.dll
    Syntax
    public class SearchApi : ISearchApi, IApiAccessor

    Constructors

    | Improve this Doc View Source

    SearchApi()

    Initializes a new instance of the SearchApi class

    Declaration
    public SearchApi()
    | Improve this Doc View Source

    SearchApi(Configuration)

    Initializes a new instance of the SearchApi class using Configuration object

    Declaration
    public SearchApi(Configuration configuration = null)
    Parameters
    Type Name Description
    Configuration configuration

    An instance of Configuration

    | Improve this Doc View Source

    SearchApi(String)

    Initializes a new instance of the SearchApi class.

    Declaration
    public SearchApi(string basePath)
    Parameters
    Type Name Description
    System.String basePath

    Properties

    | Improve this Doc View Source

    Configuration

    Gets or sets the configuration object

    Declaration
    public Configuration Configuration { get; set; }
    Property Value
    Type Description
    Configuration

    An instance of the Configuration

    | Improve this Doc View Source

    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 Source

    AddDefaultHeader(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.

    | Improve this Doc View Source

    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

    | Improve this Doc View Source

    GetBasePath()

    Gets the base path of the API client.

    Declaration
    public string GetBasePath()
    Returns
    Type Description
    System.String

    The base path

    | Improve this Doc View Source

    SearchForAccounts(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>)

    Search for accounts.

    Declaration
    public AccountsResponse SearchForAccounts(long? assetId = default(long? ), long? limit = default(long? ), string next = null, long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string authAddr = null, long? round = default(long? ), long? applicationId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.Nullable<System.Int64> currencyGreaterThan

    Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.Nullable<System.Int64> currencyLessThan

    Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.String authAddr

    Include accounts configured to use this spending key. (optional)

    System.Nullable<System.Int64> round

    Include results for the specified round. For performance reasons, this parameter may be disabled on some configurations. (optional)

    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    Returns
    Type Description
    AccountsResponse

    AccountsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForAccountsAsync(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>)

    Search for accounts.

    Declaration
    public Task<AccountsResponse> SearchForAccountsAsync(long? assetId = default(long? ), long? limit = default(long? ), string next = null, long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string authAddr = null, long? round = default(long? ), long? applicationId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.Nullable<System.Int64> currencyGreaterThan

    Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.Nullable<System.Int64> currencyLessThan

    Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.String authAddr

    Include accounts configured to use this spending key. (optional)

    System.Nullable<System.Int64> round

    Include results for the specified round. For performance reasons, this parameter may be disabled on some configurations. (optional)

    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    Returns
    Type Description
    System.Threading.Tasks.Task<AccountsResponse>

    Task of AccountsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForAccountsAsyncWithHttpInfo(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>)

    Search for accounts.

    Declaration
    public Task<ApiResponse<AccountsResponse>> SearchForAccountsAsyncWithHttpInfo(long? assetId = default(long? ), long? limit = default(long? ), string next = null, long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string authAddr = null, long? round = default(long? ), long? applicationId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.Nullable<System.Int64> currencyGreaterThan

    Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.Nullable<System.Int64> currencyLessThan

    Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.String authAddr

    Include accounts configured to use this spending key. (optional)

    System.Nullable<System.Int64> round

    Include results for the specified round. For performance reasons, this parameter may be disabled on some configurations. (optional)

    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    Returns
    Type Description
    System.Threading.Tasks.Task<ApiResponse<AccountsResponse>>

    Task of ApiResponse (AccountsResponse)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForAccountsWithHttpInfo(Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>)

    Search for accounts.

    Declaration
    public ApiResponse<AccountsResponse> SearchForAccountsWithHttpInfo(long? assetId = default(long? ), long? limit = default(long? ), string next = null, long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string authAddr = null, long? round = default(long? ), long? applicationId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.Nullable<System.Int64> currencyGreaterThan

    Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.Nullable<System.Int64> currencyLessThan

    Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.String authAddr

    Include accounts configured to use this spending key. (optional)

    System.Nullable<System.Int64> round

    Include results for the specified round. For performance reasons, this parameter may be disabled on some configurations. (optional)

    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    Returns
    Type Description
    ApiResponse<AccountsResponse>

    ApiResponse of AccountsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForApplications(Nullable<Int64>, Nullable<Int64>, String)

    Search for applications

    Declaration
    public ApplicationsResponse SearchForApplications(long? applicationId = default(long? ), long? limit = default(long? ), string next = null)
    Parameters
    Type Name Description
    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    Returns
    Type Description
    ApplicationsResponse

    ApplicationsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForApplicationsAsync(Nullable<Int64>, Nullable<Int64>, String)

    Search for applications

    Declaration
    public Task<ApplicationsResponse> SearchForApplicationsAsync(long? applicationId = default(long? ), long? limit = default(long? ), string next = null)
    Parameters
    Type Name Description
    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    Returns
    Type Description
    System.Threading.Tasks.Task<ApplicationsResponse>

    Task of ApplicationsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForApplicationsAsyncWithHttpInfo(Nullable<Int64>, Nullable<Int64>, String)

    Search for applications

    Declaration
    public Task<ApiResponse<ApplicationsResponse>> SearchForApplicationsAsyncWithHttpInfo(long? applicationId = default(long? ), long? limit = default(long? ), string next = null)
    Parameters
    Type Name Description
    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    Returns
    Type Description
    System.Threading.Tasks.Task<ApiResponse<ApplicationsResponse>>

    Task of ApiResponse (ApplicationsResponse)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForApplicationsWithHttpInfo(Nullable<Int64>, Nullable<Int64>, String)

    Search for applications

    Declaration
    public ApiResponse<ApplicationsResponse> SearchForApplicationsWithHttpInfo(long? applicationId = default(long? ), long? limit = default(long? ), string next = null)
    Parameters
    Type Name Description
    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    Returns
    Type Description
    ApiResponse<ApplicationsResponse>

    ApiResponse of ApplicationsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForAssets(Nullable<Int64>, String, String, String, String, Nullable<Int64>)

    Search for assets.

    Declaration
    public AssetsResponse SearchForAssets(long? limit = default(long? ), string next = null, string creator = null, string name = null, string unit = null, long? assetId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.String creator

    Filter just assets with the given creator address. (optional)

    System.String name

    Filter just assets with the given name. (optional)

    System.String unit

    Filter just assets with the given unit. (optional)

    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    Returns
    Type Description
    AssetsResponse

    AssetsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForAssetsAsync(Nullable<Int64>, String, String, String, String, Nullable<Int64>)

    Search for assets.

    Declaration
    public Task<AssetsResponse> SearchForAssetsAsync(long? limit = default(long? ), string next = null, string creator = null, string name = null, string unit = null, long? assetId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.String creator

    Filter just assets with the given creator address. (optional)

    System.String name

    Filter just assets with the given name. (optional)

    System.String unit

    Filter just assets with the given unit. (optional)

    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    Returns
    Type Description
    System.Threading.Tasks.Task<AssetsResponse>

    Task of AssetsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForAssetsAsyncWithHttpInfo(Nullable<Int64>, String, String, String, String, Nullable<Int64>)

    Search for assets.

    Declaration
    public Task<ApiResponse<AssetsResponse>> SearchForAssetsAsyncWithHttpInfo(long? limit = default(long? ), string next = null, string creator = null, string name = null, string unit = null, long? assetId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.String creator

    Filter just assets with the given creator address. (optional)

    System.String name

    Filter just assets with the given name. (optional)

    System.String unit

    Filter just assets with the given unit. (optional)

    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    Returns
    Type Description
    System.Threading.Tasks.Task<ApiResponse<AssetsResponse>>

    Task of ApiResponse (AssetsResponse)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForAssetsWithHttpInfo(Nullable<Int64>, String, String, String, String, Nullable<Int64>)

    Search for assets.

    Declaration
    public ApiResponse<AssetsResponse> SearchForAssetsWithHttpInfo(long? limit = default(long? ), string next = null, string creator = null, string name = null, string unit = null, long? assetId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.String creator

    Filter just assets with the given creator address. (optional)

    System.String name

    Filter just assets with the given name. (optional)

    System.String unit

    Filter just assets with the given unit. (optional)

    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    Returns
    Type Description
    ApiResponse<AssetsResponse>

    ApiResponse of AssetsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForTransactions(Nullable<Int64>, String, String, String, String, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>, Nullable<Int64>, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int64>)

    Search for transactions.

    Declaration
    public TransactionsResponse SearchForTransactions(long? limit = default(long? ), string next = null, string notePrefix = null, string txType = null, string sigType = null, string txid = null, long? round = default(long? ), long? minRound = default(long? ), long? maxRound = default(long? ), long? assetId = default(long? ), DateTime? beforeTime = default(DateTime? ), DateTime? afterTime = default(DateTime? ), long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string address = null, string addressRole = null, bool? excludeCloseTo = default(bool? ), bool? rekeyTo = default(bool? ), long? applicationId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.String notePrefix

    Specifies a prefix which must be contained in the note field. (optional)

    System.String txType

    (optional)

    System.String sigType

    SigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig (optional)

    System.String txid

    Lookup the specific transaction by ID. (optional)

    System.Nullable<System.Int64> round

    Include results for the specified round. (optional)

    System.Nullable<System.Int64> minRound

    Include results at or after the specified min-round. (optional)

    System.Nullable<System.Int64> maxRound

    Include results at or before the specified max-round. (optional)

    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    System.Nullable<System.DateTime> beforeTime

    Include results before the given time. Must be an RFC 3339 formatted string. (optional)

    System.Nullable<System.DateTime> afterTime

    Include results after the given time. Must be an RFC 3339 formatted string. (optional)

    System.Nullable<System.Int64> currencyGreaterThan

    Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.Nullable<System.Int64> currencyLessThan

    Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.String address

    Only include transactions with this address in one of the transaction fields. (optional)

    System.String addressRole

    Combine with the address parameter to define what type of address to search for. (optional)

    System.Nullable<System.Boolean> excludeCloseTo

    Combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true. (optional)

    System.Nullable<System.Boolean> rekeyTo

    Include results which include the rekey-to field. (optional)

    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    Returns
    Type Description
    TransactionsResponse

    TransactionsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForTransactionsAsync(Nullable<Int64>, String, String, String, String, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>, Nullable<Int64>, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int64>)

    Search for transactions.

    Declaration
    public Task<TransactionsResponse> SearchForTransactionsAsync(long? limit = default(long? ), string next = null, string notePrefix = null, string txType = null, string sigType = null, string txid = null, long? round = default(long? ), long? minRound = default(long? ), long? maxRound = default(long? ), long? assetId = default(long? ), DateTime? beforeTime = default(DateTime? ), DateTime? afterTime = default(DateTime? ), long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string address = null, string addressRole = null, bool? excludeCloseTo = default(bool? ), bool? rekeyTo = default(bool? ), long? applicationId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.String notePrefix

    Specifies a prefix which must be contained in the note field. (optional)

    System.String txType

    (optional)

    System.String sigType

    SigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig (optional)

    System.String txid

    Lookup the specific transaction by ID. (optional)

    System.Nullable<System.Int64> round

    Include results for the specified round. (optional)

    System.Nullable<System.Int64> minRound

    Include results at or after the specified min-round. (optional)

    System.Nullable<System.Int64> maxRound

    Include results at or before the specified max-round. (optional)

    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    System.Nullable<System.DateTime> beforeTime

    Include results before the given time. Must be an RFC 3339 formatted string. (optional)

    System.Nullable<System.DateTime> afterTime

    Include results after the given time. Must be an RFC 3339 formatted string. (optional)

    System.Nullable<System.Int64> currencyGreaterThan

    Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.Nullable<System.Int64> currencyLessThan

    Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.String address

    Only include transactions with this address in one of the transaction fields. (optional)

    System.String addressRole

    Combine with the address parameter to define what type of address to search for. (optional)

    System.Nullable<System.Boolean> excludeCloseTo

    Combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true. (optional)

    System.Nullable<System.Boolean> rekeyTo

    Include results which include the rekey-to field. (optional)

    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    Returns
    Type Description
    System.Threading.Tasks.Task<TransactionsResponse>

    Task of TransactionsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForTransactionsAsyncWithHttpInfo(Nullable<Int64>, String, String, String, String, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>, Nullable<Int64>, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int64>)

    Search for transactions.

    Declaration
    public Task<ApiResponse<TransactionsResponse>> SearchForTransactionsAsyncWithHttpInfo(long? limit = default(long? ), string next = null, string notePrefix = null, string txType = null, string sigType = null, string txid = null, long? round = default(long? ), long? minRound = default(long? ), long? maxRound = default(long? ), long? assetId = default(long? ), DateTime? beforeTime = default(DateTime? ), DateTime? afterTime = default(DateTime? ), long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string address = null, string addressRole = null, bool? excludeCloseTo = default(bool? ), bool? rekeyTo = default(bool? ), long? applicationId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.String notePrefix

    Specifies a prefix which must be contained in the note field. (optional)

    System.String txType

    (optional)

    System.String sigType

    SigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig (optional)

    System.String txid

    Lookup the specific transaction by ID. (optional)

    System.Nullable<System.Int64> round

    Include results for the specified round. (optional)

    System.Nullable<System.Int64> minRound

    Include results at or after the specified min-round. (optional)

    System.Nullable<System.Int64> maxRound

    Include results at or before the specified max-round. (optional)

    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    System.Nullable<System.DateTime> beforeTime

    Include results before the given time. Must be an RFC 3339 formatted string. (optional)

    System.Nullable<System.DateTime> afterTime

    Include results after the given time. Must be an RFC 3339 formatted string. (optional)

    System.Nullable<System.Int64> currencyGreaterThan

    Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.Nullable<System.Int64> currencyLessThan

    Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.String address

    Only include transactions with this address in one of the transaction fields. (optional)

    System.String addressRole

    Combine with the address parameter to define what type of address to search for. (optional)

    System.Nullable<System.Boolean> excludeCloseTo

    Combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true. (optional)

    System.Nullable<System.Boolean> rekeyTo

    Include results which include the rekey-to field. (optional)

    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    Returns
    Type Description
    System.Threading.Tasks.Task<ApiResponse<TransactionsResponse>>

    Task of ApiResponse (TransactionsResponse)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    SearchForTransactionsWithHttpInfo(Nullable<Int64>, String, String, String, String, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>, Nullable<Int64>, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int64>)

    Search for transactions.

    Declaration
    public ApiResponse<TransactionsResponse> SearchForTransactionsWithHttpInfo(long? limit = default(long? ), string next = null, string notePrefix = null, string txType = null, string sigType = null, string txid = null, long? round = default(long? ), long? minRound = default(long? ), long? maxRound = default(long? ), long? assetId = default(long? ), DateTime? beforeTime = default(DateTime? ), DateTime? afterTime = default(DateTime? ), long? currencyGreaterThan = default(long? ), long? currencyLessThan = default(long? ), string address = null, string addressRole = null, bool? excludeCloseTo = default(bool? ), bool? rekeyTo = default(bool? ), long? applicationId = default(long? ))
    Parameters
    Type Name Description
    System.Nullable<System.Int64> limit

    Maximum number of results to return. (optional)

    System.String next

    The next page of results. Use the next token provided by the previous results. (optional)

    System.String notePrefix

    Specifies a prefix which must be contained in the note field. (optional)

    System.String txType

    (optional)

    System.String sigType

    SigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig (optional)

    System.String txid

    Lookup the specific transaction by ID. (optional)

    System.Nullable<System.Int64> round

    Include results for the specified round. (optional)

    System.Nullable<System.Int64> minRound

    Include results at or after the specified min-round. (optional)

    System.Nullable<System.Int64> maxRound

    Include results at or before the specified max-round. (optional)

    System.Nullable<System.Int64> assetId

    Asset ID (optional)

    System.Nullable<System.DateTime> beforeTime

    Include results before the given time. Must be an RFC 3339 formatted string. (optional)

    System.Nullable<System.DateTime> afterTime

    Include results after the given time. Must be an RFC 3339 formatted string. (optional)

    System.Nullable<System.Int64> currencyGreaterThan

    Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.Nullable<System.Int64> currencyLessThan

    Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used. (optional)

    System.String address

    Only include transactions with this address in one of the transaction fields. (optional)

    System.String addressRole

    Combine with the address parameter to define what type of address to search for. (optional)

    System.Nullable<System.Boolean> excludeCloseTo

    Combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true. (optional)

    System.Nullable<System.Boolean> rekeyTo

    Include results which include the rekey-to field. (optional)

    System.Nullable<System.Int64> applicationId

    Application ID (optional)

    Returns
    Type Description
    ApiResponse<TransactionsResponse>

    ApiResponse of TransactionsResponse

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    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

    Implements

    ISearchApi
    IApiAccessor
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX