Interface IDefaultApi

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: Algorand.Algod.Api
Assembly: Algorand.dll
Syntax
public interface IDefaultApi : IApiAccessor

Methods

| Improve this Doc View Source

AccountInformation(String)

Get account information.

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

An account public key
Returns
Type Description
Account

Account
Remarks

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

Exceptions
Type Condition
ApiException

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

AccountInformationAsync(String)

Get account information.

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

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

AccountInformationAsyncWithHttpInfo(String)

Get account information.

Declaration
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)
Remarks

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

Exceptions
Type Condition
ApiException

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

AccountInformationWithHttpInfo(String)

Get account information.

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

An account public key
Returns
Type Description
ApiResponse<Account>

ApiResponse of Account
Remarks

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

Exceptions
Type Condition
ApiException

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

AssetInformation(Nullable<Int64>)

Get asset information.

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

Asset index
Returns
Type Description
AssetParams

AssetParams
Remarks

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

Exceptions
Type Condition
ApiException

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

AssetInformationAsync(Nullable<Int64>)

Get asset information.

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

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

AssetInformationAsyncWithHttpInfo(Nullable<Int64>)

Get asset information.

Declaration
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)
Remarks

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

Exceptions
Type Condition
ApiException

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

AssetInformationWithHttpInfo(Nullable<Int64>)

Get asset information.

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

Asset index
Returns
Type Description
ApiResponse<AssetParams>

ApiResponse of AssetParams
Remarks

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

Exceptions
Type Condition
ApiException

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

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

List assets

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

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

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

List assets

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

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

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

List assets

Declaration
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)
Remarks

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

Exceptions
Type Condition
ApiException

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

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

List assets

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

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

GetBlock(Nullable<Int64>)

Get the block for the given round.

Declaration
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
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
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
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.

Declaration
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
Remarks

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.

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.

Declaration
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
Remarks

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.

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.

Declaration
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)
Remarks

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.

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.

Declaration
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
Remarks

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.

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.

Declaration
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
Remarks

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.

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.

Declaration
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)
Remarks

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.

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.

Declaration
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
Remarks

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.

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.

Declaration
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
Remarks

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.

Exceptions
Type Condition
ApiException

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

GetStatus()

Gets the current node status.

Declaration
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
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
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
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
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
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
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
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()

Declaration
Version GetVersion()
Returns
Type Description
Version

Version
Remarks

Retrieves the current version

Exceptions
Type Condition
ApiException

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

GetVersionAsync()

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

Task of Version
Remarks

Retrieves the current version

Exceptions
Type Condition
ApiException

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

GetVersionAsyncWithHttpInfo()

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

Task of ApiResponse (Version)
Remarks

Retrieves the current version

Exceptions
Type Condition
ApiException

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

GetVersionWithHttpInfo()

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

ApiResponse of Version
Remarks

Retrieves the current version

Exceptions
Type Condition
ApiException

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

HealthCheck()

Returns OK if healthy.

Declaration
void HealthCheck()
Exceptions
Type Condition
ApiException

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

HealthCheckAsync()

Returns OK if healthy.

Declaration
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
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
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
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
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
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
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.

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

A transaction id
Returns
Type Description
Transaction

Transaction
Remarks

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.

Exceptions
Type Condition
ApiException

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

PendingTransactionInformationAsync(String)

Get a specific pending transaction.

Declaration
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
Remarks

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.

Exceptions
Type Condition
ApiException

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

PendingTransactionInformationAsyncWithHttpInfo(String)

Get a specific pending transaction.

Declaration
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)
Remarks

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.

Exceptions
Type Condition
ApiException

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

PendingTransactionInformationWithHttpInfo(String)

Get a specific pending transaction.

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

A transaction id
Returns
Type Description
ApiResponse<Transaction>

ApiResponse of Transaction
Remarks

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.

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
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
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
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
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

SuggestedFee()

Get the suggested fee

Declaration
TransactionFee SuggestedFee()
Returns
Type Description
TransactionFee

TransactionFee
Remarks

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.

Exceptions
Type Condition
ApiException

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

SuggestedFeeAsync()

Get the suggested fee

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

Task of TransactionFee
Remarks

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.

Exceptions
Type Condition
ApiException

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

SuggestedFeeAsyncWithHttpInfo()

Get the suggested fee

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

Task of ApiResponse (TransactionFee)
Remarks

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.

Exceptions
Type Condition
ApiException

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

SuggestedFeeWithHttpInfo()

Get the suggested fee

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

ApiResponse of TransactionFee
Remarks

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.

Exceptions
Type Condition
ApiException

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

SwaggerJSON()

Gets the current swagger spec.

Declaration
string SwaggerJSON()
Returns
Type Description
System.String

string
Remarks

Returns the entire swagger spec in json.

Exceptions
Type Condition
ApiException

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

SwaggerJSONAsync()

Gets the current swagger spec.

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

Task of string
Remarks

Returns the entire swagger spec in json.

Exceptions
Type Condition
ApiException

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

SwaggerJSONAsyncWithHttpInfo()

Gets the current swagger spec.

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

Task of ApiResponse (string)
Remarks

Returns the entire swagger spec in json.

Exceptions
Type Condition
ApiException

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

SwaggerJSONWithHttpInfo()

Gets the current swagger spec.

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

ApiResponse of string
Remarks

Returns the entire swagger spec in json.

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.

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

A transaction id
Returns
Type Description
Transaction

Transaction
Remarks

Returns the transaction information of the given txid. Works only if the indexer is enabled.

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.

Declaration
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
Remarks

Returns the transaction information of the given txid. Works only if the indexer is enabled.

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.

Declaration
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)
Remarks

Returns the transaction information of the given txid. Works only if the indexer is enabled.

Exceptions
Type Condition
ApiException

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

TransactionInformation(String, String)

Get a specific confirmed transaction.

Declaration
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
Remarks

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.

Exceptions
Type Condition
ApiException

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

TransactionInformationAsync(String, String)

Get a specific confirmed transaction.

Declaration
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
Remarks

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.

Exceptions
Type Condition
ApiException

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

TransactionInformationAsyncWithHttpInfo(String, String)

Get a specific confirmed transaction.

Declaration
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)
Remarks

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.

Exceptions
Type Condition
ApiException

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

TransactionInformationWithHttpInfo(String, String)

Get a specific confirmed transaction.

Declaration
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
Remarks

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.

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

Declaration
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
Remarks

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

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.

Declaration
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
Remarks

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

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.

Declaration
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)
Remarks

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

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.

Declaration
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
Remarks

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

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.

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

A transaction id
Returns
Type Description
ApiResponse<Transaction>

ApiResponse of Transaction
Remarks

Returns the transaction information of the given txid. Works only if the indexer is enabled.

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.

Declaration
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
Remarks

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

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.

Declaration
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
Remarks

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

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.

Declaration
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)
Remarks

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

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.

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call