Class DefaultApi

Represents a collection of functions to interact with the API endpoints

Inheritance
System.Object
DefaultApi
AlgodApi
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.Algod.Api
Assembly: Algorand.dll
Syntax
public class DefaultApi : IDefaultApi, IApiAccessor

Constructors

| Improve this Doc View Source

DefaultApi()

Initializes a new instance of the DefaultApi class

Declaration
public DefaultApi()
| Improve this Doc View Source

DefaultApi(Configuration)

Initializes a new instance of the DefaultApi class using Configuration object

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

An instance of Configuration
| Improve this Doc View Source

DefaultApi(String)

Initializes a new instance of the DefaultApi class.

Declaration
public DefaultApi(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

AccountInformation(String)

Get account information. Given a specific account public key, this call returns the accounts status, balance and spendable amounts

Declaration
public Account AccountInformation(string address)
Parameters
Type Name Description
System.String address

An account public key
Returns
Type Description
Account

Account
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

AccountInformationAsync(String)

Get account information. Given a specific account public key, this call returns the accounts status, balance and spendable amounts

Declaration
public Task<Account> AccountInformationAsync(string address)
Parameters
Type Name Description
System.String address

An account public key
Returns
Type Description
System.Threading.Tasks.Task<Account>

Task of Account
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

AccountInformationAsyncWithHttpInfo(String)

Get account information. Given a specific account public key, this call returns the accounts status, balance and spendable amounts

Declaration
public Task<ApiResponse<Account>> AccountInformationAsyncWithHttpInfo(string address)
Parameters
Type Name Description
System.String address

An account public key
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<Account>>

Task of ApiResponse (Account)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

AccountInformationWithHttpInfo(String)

Get account information. Given a specific account public key, this call returns the accounts status, balance and spendable amounts

Declaration
public ApiResponse<Account> AccountInformationWithHttpInfo(string address)
Parameters
Type Name Description
System.String address

An account public key
Returns
Type Description
ApiResponse<Account>

ApiResponse of Account
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| 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

AssetInformation(Nullable<Int64>)

Get asset information. Given the asset's unique index, this call returns the asset's creator, manager, reserve, freeze, and clawback addresses

Declaration
public AssetParams AssetInformation(long? index)
Parameters
Type Name Description
System.Nullable<System.Int64> index

Asset index
Returns
Type Description
AssetParams

AssetParams
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

AssetInformationAsync(Nullable<Int64>)

Get asset information. Given the asset's unique index, this call returns the asset's creator, manager, reserve, freeze, and clawback addresses

Declaration
public Task<AssetParams> AssetInformationAsync(long? index)
Parameters
Type Name Description
System.Nullable<System.Int64> index

Asset index
Returns
Type Description
System.Threading.Tasks.Task<AssetParams>

Task of AssetParams
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

AssetInformationAsyncWithHttpInfo(Nullable<Int64>)

Get asset information. Given the asset's unique index, this call returns the asset's creator, manager, reserve, freeze, and clawback addresses

Declaration
public Task<ApiResponse<AssetParams>> AssetInformationAsyncWithHttpInfo(long? index)
Parameters
Type Name Description
System.Nullable<System.Int64> index

Asset index
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<AssetParams>>

Task of ApiResponse (AssetParams)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

AssetInformationWithHttpInfo(Nullable<Int64>)

Get asset information. Given the asset's unique index, this call returns the asset's creator, manager, reserve, freeze, and clawback addresses

Declaration
public ApiResponse<AssetParams> AssetInformationWithHttpInfo(long? index)
Parameters
Type Name Description
System.Nullable<System.Int64> index

Asset index
Returns
Type Description
ApiResponse<AssetParams>

ApiResponse of AssetParams
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

Assets(Nullable<Int64>, Nullable<Int64>)

List assets Returns list of up to max assets, where the maximum assetIdx is <= assetIdx

Declaration
public AssetList Assets(long? assetIdx = default(long? ), long? max = default(long? ))
Parameters
Type Name Description
System.Nullable<System.Int64> assetIdx

Fetch assets with asset index <= assetIdx. If zero, fetch most recent assets. (optional)
System.Nullable<System.Int64> max

Fetch no more than this many assets (optional)
Returns
Type Description
AssetList

AssetList
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

AssetsAsync(Nullable<Int64>, Nullable<Int64>)

List assets Returns list of up to max assets, where the maximum assetIdx is <= assetIdx

Declaration
public Task<AssetList> AssetsAsync(long? assetIdx = default(long? ), long? max = default(long? ))
Parameters
Type Name Description
System.Nullable<System.Int64> assetIdx

Fetch assets with asset index <= assetIdx. If zero, fetch most recent assets. (optional)
System.Nullable<System.Int64> max

Fetch no more than this many assets (optional)
Returns
Type Description
System.Threading.Tasks.Task<AssetList>

Task of AssetList
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

AssetsAsyncWithHttpInfo(Nullable<Int64>, Nullable<Int64>)

List assets Returns list of up to max assets, where the maximum assetIdx is <= assetIdx

Declaration
public Task<ApiResponse<AssetList>> AssetsAsyncWithHttpInfo(long? assetIdx = default(long? ), long? max = default(long? ))
Parameters
Type Name Description
System.Nullable<System.Int64> assetIdx

Fetch assets with asset index <= assetIdx. If zero, fetch most recent assets. (optional)
System.Nullable<System.Int64> max

Fetch no more than this many assets (optional)
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<AssetList>>

Task of ApiResponse (AssetList)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

AssetsWithHttpInfo(Nullable<Int64>, Nullable<Int64>)

List assets Returns list of up to max assets, where the maximum assetIdx is <= assetIdx

Declaration
public ApiResponse<AssetList> AssetsWithHttpInfo(long? assetIdx = default(long? ), long? max = default(long? ))
Parameters
Type Name Description
System.Nullable<System.Int64> assetIdx

Fetch assets with asset index <= assetIdx. If zero, fetch most recent assets. (optional)
System.Nullable<System.Int64> max

Fetch no more than this many assets (optional)
Returns
Type Description
ApiResponse<AssetList>

ApiResponse of AssetList
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| 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

GetBlock(Nullable<Int64>)

Get the block for the given round.

Declaration
public Block GetBlock(long? round)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round from which to fetch block information.
Returns
Type Description
Block

Block
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetBlockAsync(Nullable<Int64>)

Get the block for the given round.

Declaration
public Task<Block> GetBlockAsync(long? round)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round from which to fetch block information.
Returns
Type Description
System.Threading.Tasks.Task<Block>

Task of Block
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetBlockAsyncWithHttpInfo(Nullable<Int64>)

Get the block for the given round.

Declaration
public Task<ApiResponse<Block>> GetBlockAsyncWithHttpInfo(long? round)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round from which to fetch block information.
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<Block>>

Task of ApiResponse (Block)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetBlockWithHttpInfo(Nullable<Int64>)

Get the block for the given round.

Declaration
public ApiResponse<Block> GetBlockWithHttpInfo(long? round)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round from which to fetch block information.
Returns
Type Description
ApiResponse<Block>

ApiResponse of Block
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetPendingTransactions(Nullable<Int64>)

Get a list of unconfirmed transactions currently in the transaction pool. Get the list of pending transactions, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Declaration
public PendingTransactions GetPendingTransactions(long? max = default(long? ))
Parameters
Type Name Description
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
Returns
Type Description
PendingTransactions

PendingTransactions
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetPendingTransactionsAsync(Nullable<Int64>)

Get a list of unconfirmed transactions currently in the transaction pool. Get the list of pending transactions, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Declaration
public Task<PendingTransactions> GetPendingTransactionsAsync(long? max = default(long? ))
Parameters
Type Name Description
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
Returns
Type Description
System.Threading.Tasks.Task<PendingTransactions>

Task of PendingTransactions
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetPendingTransactionsAsyncWithHttpInfo(Nullable<Int64>)

Get a list of unconfirmed transactions currently in the transaction pool. Get the list of pending transactions, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Declaration
public Task<ApiResponse<PendingTransactions>> GetPendingTransactionsAsyncWithHttpInfo(long? max = default(long? ))
Parameters
Type Name Description
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<PendingTransactions>>

Task of ApiResponse (PendingTransactions)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetPendingTransactionsByAddress(String, Nullable<Int64>)

Get a list of unconfirmed transactions currently in the transaction pool by address. Get the list of pending transactions by address, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Declaration
public PendingTransactions GetPendingTransactionsByAddress(string addr, long? max = default(long? ))
Parameters
Type Name Description
System.String addr

An account public key
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
Returns
Type Description
PendingTransactions

PendingTransactions
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetPendingTransactionsByAddressAsync(String, Nullable<Int64>)

Get a list of unconfirmed transactions currently in the transaction pool by address. Get the list of pending transactions by address, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Declaration
public Task<PendingTransactions> GetPendingTransactionsByAddressAsync(string addr, long? max = default(long? ))
Parameters
Type Name Description
System.String addr

An account public key
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
Returns
Type Description
System.Threading.Tasks.Task<PendingTransactions>

Task of PendingTransactions
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetPendingTransactionsByAddressAsyncWithHttpInfo(String, Nullable<Int64>)

Get a list of unconfirmed transactions currently in the transaction pool by address. Get the list of pending transactions by address, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Declaration
public Task<ApiResponse<PendingTransactions>> GetPendingTransactionsByAddressAsyncWithHttpInfo(string addr, long? max = default(long? ))
Parameters
Type Name Description
System.String addr

An account public key
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<PendingTransactions>>

Task of ApiResponse (PendingTransactions)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetPendingTransactionsByAddressWithHttpInfo(String, Nullable<Int64>)

Get a list of unconfirmed transactions currently in the transaction pool by address. Get the list of pending transactions by address, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Declaration
public ApiResponse<PendingTransactions> GetPendingTransactionsByAddressWithHttpInfo(string addr, long? max = default(long? ))
Parameters
Type Name Description
System.String addr

An account public key
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
Returns
Type Description
ApiResponse<PendingTransactions>

ApiResponse of PendingTransactions
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetPendingTransactionsWithHttpInfo(Nullable<Int64>)

Get a list of unconfirmed transactions currently in the transaction pool. Get the list of pending transactions, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Declaration
public ApiResponse<PendingTransactions> GetPendingTransactionsWithHttpInfo(long? max = default(long? ))
Parameters
Type Name Description
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
Returns
Type Description
ApiResponse<PendingTransactions>

ApiResponse of PendingTransactions
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetStatus()

Gets the current node status.

Declaration
public NodeStatus GetStatus()
Returns
Type Description
NodeStatus

NodeStatus
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetStatusAsync()

Gets the current node status.

Declaration
public Task<NodeStatus> GetStatusAsync()
Returns
Type Description
System.Threading.Tasks.Task<NodeStatus>

Task of NodeStatus
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetStatusAsyncWithHttpInfo()

Gets the current node status.

Declaration
public Task<ApiResponse<NodeStatus>> GetStatusAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<NodeStatus>>

Task of ApiResponse (NodeStatus)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetStatusWithHttpInfo()

Gets the current node status.

Declaration
public ApiResponse<NodeStatus> GetStatusWithHttpInfo()
Returns
Type Description
ApiResponse<NodeStatus>

ApiResponse of NodeStatus
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetSupply()

Get the current supply reported by the ledger.

Declaration
public Supply GetSupply()
Returns
Type Description
Supply

Supply
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetSupplyAsync()

Get the current supply reported by the ledger.

Declaration
public Task<Supply> GetSupplyAsync()
Returns
Type Description
System.Threading.Tasks.Task<Supply>

Task of Supply
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetSupplyAsyncWithHttpInfo()

Get the current supply reported by the ledger.

Declaration
public Task<ApiResponse<Supply>> GetSupplyAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<Supply>>

Task of ApiResponse (Supply)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetSupplyWithHttpInfo()

Get the current supply reported by the ledger.

Declaration
public ApiResponse<Supply> GetSupplyWithHttpInfo()
Returns
Type Description
ApiResponse<Supply>

ApiResponse of Supply
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetVersion()

Retrieves the current version

Declaration
public Version GetVersion()
Returns
Type Description
Version

Version
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetVersionAsync()

Retrieves the current version

Declaration
public Task<Version> GetVersionAsync()
Returns
Type Description
System.Threading.Tasks.Task<Version>

Task of Version
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetVersionAsyncWithHttpInfo()

Retrieves the current version

Declaration
public Task<ApiResponse<Version>> GetVersionAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<Version>>

Task of ApiResponse (Version)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetVersionWithHttpInfo()

Retrieves the current version

Declaration
public ApiResponse<Version> GetVersionWithHttpInfo()
Returns
Type Description
ApiResponse<Version>

ApiResponse of Version
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

HealthCheck()

Returns OK if healthy.

Declaration
public void HealthCheck()
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

HealthCheckAsync()

Returns OK if healthy.

Declaration
public Task HealthCheckAsync()
Returns
Type Description
System.Threading.Tasks.Task

Task of void
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

HealthCheckAsyncWithHttpInfo()

Returns OK if healthy.

Declaration
public Task<ApiResponse<object>> HealthCheckAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<System.Object>>

Task of ApiResponse
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

HealthCheckWithHttpInfo()

Returns OK if healthy.

Declaration
public ApiResponse<object> HealthCheckWithHttpInfo()
Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

Metrics()

Return metrics about algod functioning.

Declaration
public void Metrics()
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

MetricsAsync()

Return metrics about algod functioning.

Declaration
public Task MetricsAsync()
Returns
Type Description
System.Threading.Tasks.Task

Task of void
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

MetricsAsyncWithHttpInfo()

Return metrics about algod functioning.

Declaration
public Task<ApiResponse<object>> MetricsAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<System.Object>>

Task of ApiResponse
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

MetricsWithHttpInfo()

Return metrics about algod functioning.

Declaration
public ApiResponse<object> MetricsWithHttpInfo()
Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

PendingTransactionInformation(String)

Get a specific pending transaction. Given a transaction id of a recently submitted transaction, it returns information about it. There are several cases when this might succeed: - transaction committed (committed round > 0) - transaction still in the pool (committed round = 0, pool error = &quot;&quot;) - transaction removed from pool due to error (committed round = 0, pool error != &quot;&quot;) Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.

Declaration
public Transaction PendingTransactionInformation(string txid)
Parameters
Type Name Description
System.String txid

A transaction id
Returns
Type Description
Transaction

Transaction
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

PendingTransactionInformationAsync(String)

Get a specific pending transaction. Given a transaction id of a recently submitted transaction, it returns information about it. There are several cases when this might succeed: - transaction committed (committed round > 0) - transaction still in the pool (committed round = 0, pool error = &quot;&quot;) - transaction removed from pool due to error (committed round = 0, pool error != &quot;&quot;) Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.

Declaration
public Task<Transaction> PendingTransactionInformationAsync(string txid)
Parameters
Type Name Description
System.String txid

A transaction id
Returns
Type Description
System.Threading.Tasks.Task<Transaction>

Task of Transaction
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

PendingTransactionInformationAsyncWithHttpInfo(String)

Get a specific pending transaction. Given a transaction id of a recently submitted transaction, it returns information about it. There are several cases when this might succeed: - transaction committed (committed round > 0) - transaction still in the pool (committed round = 0, pool error = &quot;&quot;) - transaction removed from pool due to error (committed round = 0, pool error != &quot;&quot;) Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.

Declaration
public Task<ApiResponse<Transaction>> PendingTransactionInformationAsyncWithHttpInfo(string txid)
Parameters
Type Name Description
System.String txid

A transaction id
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<Transaction>>

Task of ApiResponse (Transaction)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

PendingTransactionInformationWithHttpInfo(String)

Get a specific pending transaction. Given a transaction id of a recently submitted transaction, it returns information about it. There are several cases when this might succeed: - transaction committed (committed round > 0) - transaction still in the pool (committed round = 0, pool error = &quot;&quot;) - transaction removed from pool due to error (committed round = 0, pool error != &quot;&quot;) Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.

Declaration
public ApiResponse<Transaction> PendingTransactionInformationWithHttpInfo(string txid)
Parameters
Type Name Description
System.String txid

A transaction id
Returns
Type Description
ApiResponse<Transaction>

ApiResponse of Transaction
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

RawTransaction(Byte[])

Broadcasts a raw transaction to the network.

Declaration
public TransactionID RawTransaction(byte[] body)
Parameters
Type Name Description
System.Byte[] body

The byte encoded signed transaction to broadcast to network
Returns
Type Description
TransactionID

TransactionID
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

RawTransactionAsync(String)

Broadcasts a raw transaction to the network.

Declaration
public Task<TransactionID> RawTransactionAsync(string body)
Parameters
Type Name Description
System.String body

The byte encoded signed transaction to broadcast to network
Returns
Type Description
System.Threading.Tasks.Task<TransactionID>

Task of TransactionID
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

RawTransactionAsyncWithHttpInfo(String)

Broadcasts a raw transaction to the network.

Declaration
public Task<ApiResponse<TransactionID>> RawTransactionAsyncWithHttpInfo(string body)
Parameters
Type Name Description
System.String body

The byte encoded signed transaction to broadcast to network
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<TransactionID>>

Task of ApiResponse (TransactionID)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

RawTransactionWithHttpInfo(Byte[])

Broadcasts a raw transaction to the network.

Declaration
public ApiResponse<TransactionID> RawTransactionWithHttpInfo(byte[] body)
Parameters
Type Name Description
System.Byte[] body

The byte encoded signed transaction to broadcast to network
Returns
Type Description
ApiResponse<TransactionID>

ApiResponse of TransactionID
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
| Improve this Doc View Source

SuggestedFee()

Get the suggested fee Suggested Fee is returned in units of micro-Algos per byte. Suggested Fee may fall to zero but submitted transactions must still have a fee of at least MinTxnFee for the current network protocol.

Declaration
public TransactionFee SuggestedFee()
Returns
Type Description
TransactionFee

TransactionFee
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SuggestedFeeAsync()

Get the suggested fee Suggested Fee is returned in units of micro-Algos per byte. Suggested Fee may fall to zero but submitted transactions must still have a fee of at least MinTxnFee for the current network protocol.

Declaration
public Task<TransactionFee> SuggestedFeeAsync()
Returns
Type Description
System.Threading.Tasks.Task<TransactionFee>

Task of TransactionFee
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SuggestedFeeAsyncWithHttpInfo()

Get the suggested fee Suggested Fee is returned in units of micro-Algos per byte. Suggested Fee may fall to zero but submitted transactions must still have a fee of at least MinTxnFee for the current network protocol.

Declaration
public Task<ApiResponse<TransactionFee>> SuggestedFeeAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<TransactionFee>>

Task of ApiResponse (TransactionFee)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SuggestedFeeWithHttpInfo()

Get the suggested fee Suggested Fee is returned in units of micro-Algos per byte. Suggested Fee may fall to zero but submitted transactions must still have a fee of at least MinTxnFee for the current network protocol.

Declaration
public ApiResponse<TransactionFee> SuggestedFeeWithHttpInfo()
Returns
Type Description
ApiResponse<TransactionFee>

ApiResponse of TransactionFee
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SwaggerJSON()

Gets the current swagger spec. Returns the entire swagger spec in json.

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

string
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SwaggerJSONAsync()

Gets the current swagger spec. Returns the entire swagger spec in json.

Declaration
public Task<string> SwaggerJSONAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

Task of string
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SwaggerJSONAsyncWithHttpInfo()

Gets the current swagger spec. Returns the entire swagger spec in json.

Declaration
public Task<ApiResponse<string>> SwaggerJSONAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<System.String>>

Task of ApiResponse (string)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SwaggerJSONWithHttpInfo()

Gets the current swagger spec. Returns the entire swagger spec in json.

Declaration
public ApiResponse<string> SwaggerJSONWithHttpInfo()
Returns
Type Description
ApiResponse<System.String>

ApiResponse of string
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

Transaction(String)

Get an information of a single transaction. Returns the transaction information of the given txid. Works only if the indexer is enabled.

Declaration
public Transaction Transaction(string txid)
Parameters
Type Name Description
System.String txid

A transaction id
Returns
Type Description
Transaction

Transaction
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionAsync(String)

Get an information of a single transaction. Returns the transaction information of the given txid. Works only if the indexer is enabled.

Declaration
public Task<Transaction> TransactionAsync(string txid)
Parameters
Type Name Description
System.String txid

A transaction id
Returns
Type Description
System.Threading.Tasks.Task<Transaction>

Task of Transaction
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionAsyncWithHttpInfo(String)

Get an information of a single transaction. Returns the transaction information of the given txid. Works only if the indexer is enabled.

Declaration
public Task<ApiResponse<Transaction>> TransactionAsyncWithHttpInfo(string txid)
Parameters
Type Name Description
System.String txid

A transaction id
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<Transaction>>

Task of ApiResponse (Transaction)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionInformation(String, String)

Get a specific confirmed transaction. Given a wallet address and a transaction id, it returns the confirmed transaction information. This call scans up to <CurrentProtocol>.MaxTxnLife blocks in the past.

Declaration
public Transaction TransactionInformation(string address, string txid)
Parameters
Type Name Description
System.String address

An account public key
System.String txid

A transaction id
Returns
Type Description
Transaction

Transaction
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionInformationAsync(String, String)

Get a specific confirmed transaction. Given a wallet address and a transaction id, it returns the confirmed transaction information. This call scans up to <CurrentProtocol>.MaxTxnLife blocks in the past.

Declaration
public Task<Transaction> TransactionInformationAsync(string address, string txid)
Parameters
Type Name Description
System.String address

An account public key
System.String txid

A transaction id
Returns
Type Description
System.Threading.Tasks.Task<Transaction>

Task of Transaction
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionInformationAsyncWithHttpInfo(String, String)

Get a specific confirmed transaction. Given a wallet address and a transaction id, it returns the confirmed transaction information. This call scans up to <CurrentProtocol>.MaxTxnLife blocks in the past.

Declaration
public Task<ApiResponse<Transaction>> TransactionInformationAsyncWithHttpInfo(string address, string txid)
Parameters
Type Name Description
System.String address

An account public key
System.String txid

A transaction id
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<Transaction>>

Task of ApiResponse (Transaction)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionInformationWithHttpInfo(String, String)

Get a specific confirmed transaction. Given a wallet address and a transaction id, it returns the confirmed transaction information. This call scans up to <CurrentProtocol>.MaxTxnLife blocks in the past.

Declaration
public ApiResponse<Transaction> TransactionInformationWithHttpInfo(string address, string txid)
Parameters
Type Name Description
System.String address

An account public key
System.String txid

A transaction id
Returns
Type Description
ApiResponse<Transaction>

ApiResponse of Transaction
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionParams()

Get parameters for constructing a new transaction

Declaration
public TransactionParams TransactionParams()
Returns
Type Description
TransactionParams

TransactionParams
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionParamsAsync()

Get parameters for constructing a new transaction

Declaration
public Task<TransactionParams> TransactionParamsAsync()
Returns
Type Description
System.Threading.Tasks.Task<TransactionParams>

Task of TransactionParams
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionParamsAsyncWithHttpInfo()

Get parameters for constructing a new transaction

Declaration
public Task<ApiResponse<TransactionParams>> TransactionParamsAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<TransactionParams>>

Task of ApiResponse (TransactionParams)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionParamsWithHttpInfo()

Get parameters for constructing a new transaction

Declaration
public ApiResponse<TransactionParams> TransactionParamsWithHttpInfo()
Returns
Type Description
ApiResponse<TransactionParams>

ApiResponse of TransactionParams
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

Transactions(String, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>)

Get a list of confirmed transactions. Returns the list of confirmed transactions between within a date range. This call is available only when the indexer is running.

Declaration
public TransactionList Transactions(string address, long? firstRound = default(long? ), long? lastRound = default(long? ), DateTime? fromDate = default(DateTime? ), DateTime? toDate = default(DateTime? ), long? max = default(long? ))
Parameters
Type Name Description
System.String address

An account public key
System.Nullable<System.Int64> firstRound

Do not fetch any transactions before this round. (optional)
System.Nullable<System.Int64> lastRound

Do not fetch any transactions after this round. (optional)
System.Nullable<System.DateTime> fromDate

Do not fetch any transactions before this date. (enabled only with indexer) (optional)
System.Nullable<System.DateTime> toDate

Do not fetch any transactions after this date. (enabled only with indexer) (optional)
System.Nullable<System.Int64> max

maximum transactions to show (default to 100) (optional)
Returns
Type Description
TransactionList

TransactionList
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionsAsync(String, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>)

Get a list of confirmed transactions. Returns the list of confirmed transactions between within a date range. This call is available only when the indexer is running.

Declaration
public Task<TransactionList> TransactionsAsync(string address, long? firstRound = default(long? ), long? lastRound = default(long? ), DateTime? fromDate = default(DateTime? ), DateTime? toDate = default(DateTime? ), long? max = default(long? ))
Parameters
Type Name Description
System.String address

An account public key
System.Nullable<System.Int64> firstRound

Do not fetch any transactions before this round. (optional)
System.Nullable<System.Int64> lastRound

Do not fetch any transactions after this round. (optional)
System.Nullable<System.DateTime> fromDate

Do not fetch any transactions before this date. (enabled only with indexer) (optional)
System.Nullable<System.DateTime> toDate

Do not fetch any transactions after this date. (enabled only with indexer) (optional)
System.Nullable<System.Int64> max

maximum transactions to show (default to 100) (optional)
Returns
Type Description
System.Threading.Tasks.Task<TransactionList>

Task of TransactionList
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionsAsyncWithHttpInfo(String, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>)

Get a list of confirmed transactions. Returns the list of confirmed transactions between within a date range. This call is available only when the indexer is running.

Declaration
public Task<ApiResponse<TransactionList>> TransactionsAsyncWithHttpInfo(string address, long? firstRound = default(long? ), long? lastRound = default(long? ), DateTime? fromDate = default(DateTime? ), DateTime? toDate = default(DateTime? ), long? max = default(long? ))
Parameters
Type Name Description
System.String address

An account public key
System.Nullable<System.Int64> firstRound

Do not fetch any transactions before this round. (optional)
System.Nullable<System.Int64> lastRound

Do not fetch any transactions after this round. (optional)
System.Nullable<System.DateTime> fromDate

Do not fetch any transactions before this date. (enabled only with indexer) (optional)
System.Nullable<System.DateTime> toDate

Do not fetch any transactions after this date. (enabled only with indexer) (optional)
System.Nullable<System.Int64> max

maximum transactions to show (default to 100) (optional)
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<TransactionList>>

Task of ApiResponse (TransactionList)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionsWithHttpInfo(String, Nullable<Int64>, Nullable<Int64>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int64>)

Get a list of confirmed transactions. Returns the list of confirmed transactions between within a date range. This call is available only when the indexer is running.

Declaration
public ApiResponse<TransactionList> TransactionsWithHttpInfo(string address, long? firstRound = default(long? ), long? lastRound = default(long? ), DateTime? fromDate = default(DateTime? ), DateTime? toDate = default(DateTime? ), long? max = default(long? ))
Parameters
Type Name Description
System.String address

An account public key
System.Nullable<System.Int64> firstRound

Do not fetch any transactions before this round. (optional)
System.Nullable<System.Int64> lastRound

Do not fetch any transactions after this round. (optional)
System.Nullable<System.DateTime> fromDate

Do not fetch any transactions before this date. (enabled only with indexer) (optional)
System.Nullable<System.DateTime> toDate

Do not fetch any transactions after this date. (enabled only with indexer) (optional)
System.Nullable<System.Int64> max

maximum transactions to show (default to 100) (optional)
Returns
Type Description
ApiResponse<TransactionList>

ApiResponse of TransactionList
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

TransactionWithHttpInfo(String)

Get an information of a single transaction. Returns the transaction information of the given txid. Works only if the indexer is enabled.

Declaration
public ApiResponse<Transaction> TransactionWithHttpInfo(string txid)
Parameters
Type Name Description
System.String txid

A transaction id
Returns
Type Description
ApiResponse<Transaction>

ApiResponse of Transaction
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

WaitForBlock(Nullable<Int64>)

Gets the node status after waiting for the given round. Waits for a block to appear after round {round} and returns the node's status at the time.

Declaration
public NodeStatus WaitForBlock(long? round)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round to wait until returning status
Returns
Type Description
NodeStatus

NodeStatus
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

WaitForBlockAsync(Nullable<Int64>)

Gets the node status after waiting for the given round. Waits for a block to appear after round {round} and returns the node's status at the time.

Declaration
public Task<NodeStatus> WaitForBlockAsync(long? round)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round to wait until returning status
Returns
Type Description
System.Threading.Tasks.Task<NodeStatus>

Task of NodeStatus
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

WaitForBlockAsyncWithHttpInfo(Nullable<Int64>)

Gets the node status after waiting for the given round. Waits for a block to appear after round {round} and returns the node's status at the time.

Declaration
public Task<ApiResponse<NodeStatus>> WaitForBlockAsyncWithHttpInfo(long? round)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round to wait until returning status
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<NodeStatus>>

Task of ApiResponse (NodeStatus)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

WaitForBlockWithHttpInfo(Nullable<Int64>)

Gets the node status after waiting for the given round. Waits for a block to appear after round {round} and returns the node's status at the time.

Declaration
public ApiResponse<NodeStatus> WaitForBlockWithHttpInfo(long? round)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round to wait until returning status
Returns
Type Description
ApiResponse<NodeStatus>

ApiResponse of NodeStatus
Exceptions
Type Condition
ApiException

Thrown when fails to make API call

Implements