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.V2.Algod
Assembly: Algorand.dll
Syntax
public class DefaultApi : IDefaultApi, IApiAccessor

Constructors

| 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, 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, string format = null)
Parameters
Type Name Description
System.String address

An account public key
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
Account

Account
Exceptions
Type Condition
ApiException

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

AccountInformationAsync(String, 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, string format = null)
Parameters
Type Name Description
System.String address

An account public key
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
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, 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, string format = null)
Parameters
Type Name Description
System.String address

An account public key
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
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, 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, string format = null)
Parameters
Type Name Description
System.String address

An account public key
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
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

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

GetApplicationByID(Nullable<Int64>)

Get application information. Given a application id, it returns application information including creator, approval and clear programs, global and local schemas, and global state.

Declaration
public Application GetApplicationByID(long? applicationId)
Parameters
Type Name Description
System.Nullable<System.Int64> applicationId

An application identifier
Returns
Type Description
Application

Application
Exceptions
Type Condition
ApiException

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

GetApplicationByIDAsync(Nullable<Int64>)

Get application information. Given a application id, it returns application information including creator, approval and clear programs, global and local schemas, and global state.

Declaration
public Task<Application> GetApplicationByIDAsync(long? applicationId)
Parameters
Type Name Description
System.Nullable<System.Int64> applicationId

An application identifier
Returns
Type Description
System.Threading.Tasks.Task<Application>

Task of Application
Exceptions
Type Condition
ApiException

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

GetApplicationByIDAsyncWithHttpInfo(Nullable<Int64>)

Get application information. Given a application id, it returns application information including creator, approval and clear programs, global and local schemas, and global state.

Declaration
public Task<ApiResponse<Application>> GetApplicationByIDAsyncWithHttpInfo(long? applicationId)
Parameters
Type Name Description
System.Nullable<System.Int64> applicationId

An application identifier
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<Application>>

Task of ApiResponse (Application)
Exceptions
Type Condition
ApiException

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

GetApplicationByIDWithHttpInfo(Nullable<Int64>)

Get application information. Given a application id, it returns application information including creator, approval and clear programs, global and local schemas, and global state.

Declaration
public ApiResponse<Application> GetApplicationByIDWithHttpInfo(long? applicationId)
Parameters
Type Name Description
System.Nullable<System.Int64> applicationId

An application identifier
Returns
Type Description
ApiResponse<Application>

ApiResponse of Application
Exceptions
Type Condition
ApiException

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

GetAssetByID(Nullable<Int64>)

Get asset information. Given a asset id, it returns asset information including creator, name, total supply and special addresses.

Declaration
public Asset GetAssetByID(long? assetId)
Parameters
Type Name Description
System.Nullable<System.Int64> assetId

An asset identifier
Returns
Type Description
Asset

Asset
Exceptions
Type Condition
ApiException

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

GetAssetByIDAsync(Nullable<Int64>)

Get asset information. Given a asset id, it returns asset information including creator, name, total supply and special addresses.

Declaration
public Task<Asset> GetAssetByIDAsync(long? assetId)
Parameters
Type Name Description
System.Nullable<System.Int64> assetId

An asset identifier
Returns
Type Description
System.Threading.Tasks.Task<Asset>

Task of Asset
Exceptions
Type Condition
ApiException

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

GetAssetByIDAsyncWithHttpInfo(Nullable<Int64>)

Get asset information. Given a asset id, it returns asset information including creator, name, total supply and special addresses.

Declaration
public Task<ApiResponse<Asset>> GetAssetByIDAsyncWithHttpInfo(long? assetId)
Parameters
Type Name Description
System.Nullable<System.Int64> assetId

An asset identifier
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<Asset>>

Task of ApiResponse (Asset)
Exceptions
Type Condition
ApiException

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

GetAssetByIDWithHttpInfo(Nullable<Int64>)

Get asset information. Given a asset id, it returns asset information including creator, name, total supply and special addresses.

Declaration
public ApiResponse<Asset> GetAssetByIDWithHttpInfo(long? assetId)
Parameters
Type Name Description
System.Nullable<System.Int64> assetId

An asset identifier
Returns
Type Description
ApiResponse<Asset>

ApiResponse of Asset
Exceptions
Type Condition
ApiException

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

Get the block for the given round.

Declaration
public BlockResponse GetBlock(long? round, string format = null)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round from which to fetch block information.
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
BlockResponse

BlockResponse
Exceptions
Type Condition
ApiException

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

GetBlockAsync(Nullable<Int64>, String)

Get the block for the given round.

Declaration
public Task<BlockResponse> GetBlockAsync(long? round, string format = null)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round from which to fetch block information.
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
System.Threading.Tasks.Task<BlockResponse>

Task of BlockResponse
Exceptions
Type Condition
ApiException

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

GetBlockAsyncWithHttpInfo(Nullable<Int64>, String)

Get the block for the given round.

Declaration
public Task<ApiResponse<BlockResponse>> GetBlockAsyncWithHttpInfo(long? round, string format = null)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round from which to fetch block information.
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<BlockResponse>>

Task of ApiResponse (BlockResponse)
Exceptions
Type Condition
ApiException

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

GetBlockWithHttpInfo(Nullable<Int64>, String)

Get the block for the given round.

Declaration
public ApiResponse<BlockResponse> GetBlockWithHttpInfo(long? round, string format = null)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round from which to fetch block information.
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
ApiResponse<BlockResponse>

ApiResponse of BlockResponse
Exceptions
Type Condition
ApiException

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

GetPendingTransactions(Nullable<Int64>, String)

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 PendingTransactionsResponse GetPendingTransactions(long? max = default(long? ), string format = null)
Parameters
Type Name Description
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
PendingTransactionsResponse

PendingTransactionsResponse
Exceptions
Type Condition
ApiException

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

GetPendingTransactionsAsync(Nullable<Int64>, String)

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<PendingTransactionsResponse> GetPendingTransactionsAsync(long? max = default(long? ), string format = null)
Parameters
Type Name Description
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
System.Threading.Tasks.Task<PendingTransactionsResponse>

Task of PendingTransactionsResponse
Exceptions
Type Condition
ApiException

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

GetPendingTransactionsAsyncWithHttpInfo(Nullable<Int64>, String)

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<PendingTransactionsResponse>> GetPendingTransactionsAsyncWithHttpInfo(long? max = default(long? ), string format = null)
Parameters
Type Name Description
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<PendingTransactionsResponse>>

Task of ApiResponse (PendingTransactionsResponse)
Exceptions
Type Condition
ApiException

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

GetPendingTransactionsByAddress(String, Nullable<Int64>, String)

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 PendingTransactionsResponse GetPendingTransactionsByAddress(string address, long? max = default(long? ), string format = null)
Parameters
Type Name Description
System.String address

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

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
PendingTransactionsResponse

PendingTransactionsResponse
Exceptions
Type Condition
ApiException

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

GetPendingTransactionsByAddressAsync(String, Nullable<Int64>, String)

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<PendingTransactionsResponse> GetPendingTransactionsByAddressAsync(string address, long? max = default(long? ), string format = null)
Parameters
Type Name Description
System.String address

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

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
System.Threading.Tasks.Task<PendingTransactionsResponse>

Task of PendingTransactionsResponse
Exceptions
Type Condition
ApiException

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

GetPendingTransactionsByAddressAsyncWithHttpInfo(String, Nullable<Int64>, String)

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<PendingTransactionsResponse>> GetPendingTransactionsByAddressAsyncWithHttpInfo(string address, long? max = default(long? ), string format = null)
Parameters
Type Name Description
System.String address

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

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<PendingTransactionsResponse>>

Task of ApiResponse (PendingTransactionsResponse)
Exceptions
Type Condition
ApiException

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

GetPendingTransactionsByAddressWithHttpInfo(String, Nullable<Int64>, String)

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<PendingTransactionsResponse> GetPendingTransactionsByAddressWithHttpInfo(string address, long? max = default(long? ), string format = null)
Parameters
Type Name Description
System.String address

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

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
ApiResponse<PendingTransactionsResponse>

ApiResponse of PendingTransactionsResponse
Exceptions
Type Condition
ApiException

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

GetPendingTransactionsWithHttpInfo(Nullable<Int64>, String)

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<PendingTransactionsResponse> GetPendingTransactionsWithHttpInfo(long? max = default(long? ), string format = null)
Parameters
Type Name Description
System.Nullable<System.Int64> max

Truncated number of transactions to display. If max=0, returns all pending txns. (optional)
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
ApiResponse<PendingTransactionsResponse>

ApiResponse of PendingTransactionsResponse
Exceptions
Type Condition
ApiException

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

GetStatus()

Gets the current node status.

Declaration
public NodeStatusResponse GetStatus()
Returns
Type Description
NodeStatusResponse

NodeStatusResponse
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<NodeStatusResponse> GetStatusAsync()
Returns
Type Description
System.Threading.Tasks.Task<NodeStatusResponse>

Task of NodeStatusResponse
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<NodeStatusResponse>> GetStatusAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<NodeStatusResponse>>

Task of ApiResponse (NodeStatusResponse)
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<NodeStatusResponse> GetStatusWithHttpInfo()
Returns
Type Description
ApiResponse<NodeStatusResponse>

ApiResponse of NodeStatusResponse
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 SupplyResponse GetSupply()
Returns
Type Description
SupplyResponse

PendingTransactionsResponse2
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<SupplyResponse> GetSupplyAsync()
Returns
Type Description
System.Threading.Tasks.Task<SupplyResponse>

Task of PendingTransactionsResponse2
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<SupplyResponse>> GetSupplyAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<SupplyResponse>>

Task of ApiResponse (PendingTransactionsResponse2)
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<SupplyResponse> GetSupplyWithHttpInfo()
Returns
Type Description
ApiResponse<SupplyResponse>

ApiResponse of PendingTransactionsResponse2
Exceptions
Type Condition
ApiException

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

PendingTransactionInformation(String, 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 PendingTransactionResponse PendingTransactionInformation(string txid, string format = null)
Parameters
Type Name Description
System.String txid

A transaction id
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
PendingTransactionResponse

PendingTransactionsResponse6
Exceptions
Type Condition
ApiException

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

PendingTransactionInformationAsync(String, 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<PendingTransactionResponse> PendingTransactionInformationAsync(string txid, string format = null)
Parameters
Type Name Description
System.String txid

A transaction id
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
System.Threading.Tasks.Task<PendingTransactionResponse>

Task of PendingTransactionsResponse6
Exceptions
Type Condition
ApiException

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

PendingTransactionInformationAsyncWithHttpInfo(String, 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<PendingTransactionResponse>> PendingTransactionInformationAsyncWithHttpInfo(string txid, string format = null)
Parameters
Type Name Description
System.String txid

A transaction id
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<PendingTransactionResponse>>

Task of ApiResponse (PendingTransactionsResponse6)
Exceptions
Type Condition
ApiException

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

PendingTransactionInformationWithHttpInfo(String, 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<PendingTransactionResponse> PendingTransactionInformationWithHttpInfo(string txid, string format = null)
Parameters
Type Name Description
System.String txid

A transaction id
System.String format

Configures whether the response object is JSON or MessagePack encoded. (optional)
Returns
Type Description
ApiResponse<PendingTransactionResponse>

ApiResponse of PendingTransactionsResponse6
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 PostTransactionsResponse RawTransaction(byte[] rawtxn)
Parameters
Type Name Description
System.Byte[] rawtxn

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

PendingTransactionsResponse3
Exceptions
Type Condition
ApiException

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

RawTransactionAsync(Byte[])

Broadcasts a raw transaction to the network.

Declaration
public Task<PostTransactionsResponse> RawTransactionAsync(byte[] rawtxn)
Parameters
Type Name Description
System.Byte[] rawtxn

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

Task of PendingTransactionsResponse3
Exceptions
Type Condition
ApiException

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

RawTransactionAsyncWithHttpInfo(Byte[])

Broadcasts a raw transaction to the network.

Declaration
public Task<ApiResponse<PostTransactionsResponse>> RawTransactionAsyncWithHttpInfo(byte[] rawtxn)
Parameters
Type Name Description
System.Byte[] rawtxn

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

Task of ApiResponse (PendingTransactionsResponse3)
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<PostTransactionsResponse> RawTransactionWithHttpInfo(byte[] rawtxn)
Parameters
Type Name Description
System.Byte[] rawtxn

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

ApiResponse of PendingTransactionsResponse3
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

TealCompile(Byte[])

Compile TEAL source code to binary, produce its hash Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).

Declaration
public CompileResponse TealCompile(byte[] source)
Parameters
Type Name Description
System.Byte[] source

TEAL source code to be compiled
Returns
Type Description
CompileResponse

PendingTransactionsResponse7
Exceptions
Type Condition
ApiException

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

TealCompileAsync(Byte[])

Compile TEAL source code to binary, produce its hash Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).

Declaration
public Task<CompileResponse> TealCompileAsync(byte[] source)
Parameters
Type Name Description
System.Byte[] source

TEAL source code to be compiled
Returns
Type Description
System.Threading.Tasks.Task<CompileResponse>

Task of PendingTransactionsResponse7
Exceptions
Type Condition
ApiException

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

TealCompileAsyncWithHttpInfo(Byte[])

Compile TEAL source code to binary, produce its hash Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).

Declaration
public Task<ApiResponse<CompileResponse>> TealCompileAsyncWithHttpInfo(byte[] source)
Parameters
Type Name Description
System.Byte[] source

TEAL source code to be compiled
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<CompileResponse>>

Task of ApiResponse (PendingTransactionsResponse7)
Exceptions
Type Condition
ApiException

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

TealCompileWithHttpInfo(Byte[])

Compile TEAL source code to binary, produce its hash Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).

Declaration
public ApiResponse<CompileResponse> TealCompileWithHttpInfo(byte[] source)
Parameters
Type Name Description
System.Byte[] source

TEAL source code to be compiled
Returns
Type Description
ApiResponse<CompileResponse>

ApiResponse of PendingTransactionsResponse7
Exceptions
Type Condition
ApiException

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

TealDryrun(DryrunRequest)

Provide debugging information for a transaction (or group). Executes TEAL program(s) in context and returns debugging information about the execution.

Declaration
public DryrunResponse TealDryrun(DryrunRequest request = null)
Parameters
Type Name Description
DryrunRequest request

Transaction (or group) and any accompanying state-simulation data. (optional)
Returns
Type Description
DryrunResponse

DryrunResponse
Exceptions
Type Condition
ApiException

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

TealDryrunAsync(DryrunRequest)

Provide debugging information for a transaction (or group). Executes TEAL program(s) in context and returns debugging information about the execution.

Declaration
public Task<DryrunResponse> TealDryrunAsync(DryrunRequest request = null)
Parameters
Type Name Description
DryrunRequest request

Transaction (or group) and any accompanying state-simulation data. (optional)
Returns
Type Description
System.Threading.Tasks.Task<DryrunResponse>

Task of DryrunResponse
Exceptions
Type Condition
ApiException

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

TealDryrunAsyncWithHttpInfo(DryrunRequest)

Provide debugging information for a transaction (or group). Executes TEAL program(s) in context and returns debugging information about the execution.

Declaration
public Task<ApiResponse<DryrunResponse>> TealDryrunAsyncWithHttpInfo(DryrunRequest request = null)
Parameters
Type Name Description
DryrunRequest request

Transaction (or group) and any accompanying state-simulation data. (optional)
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<DryrunResponse>>

Task of ApiResponse (DryrunResponse)
Exceptions
Type Condition
ApiException

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

TealDryrunWithHttpInfo(DryrunRequest)

Provide debugging information for a transaction (or group). Executes TEAL program(s) in context and returns debugging information about the execution.

Declaration
public ApiResponse<DryrunResponse> TealDryrunWithHttpInfo(DryrunRequest request = null)
Parameters
Type Name Description
DryrunRequest request

Transaction (or group) and any accompanying state-simulation data. (optional)
Returns
Type Description
ApiResponse<DryrunResponse>

ApiResponse of DryrunResponse
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 TransactionParametersResponse TransactionParams()
Returns
Type Description
TransactionParametersResponse

TransactionParametersResponse
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<TransactionParametersResponse> TransactionParamsAsync()
Returns
Type Description
System.Threading.Tasks.Task<TransactionParametersResponse>

Task of TransactionParametersResponse
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<TransactionParametersResponse>> TransactionParamsAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<TransactionParametersResponse>>

Task of ApiResponse (TransactionParametersResponse)
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<TransactionParametersResponse> TransactionParamsWithHttpInfo()
Returns
Type Description
ApiResponse<TransactionParametersResponse>

ApiResponse of TransactionParametersResponse
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 NodeStatusResponse WaitForBlock(long? round)
Parameters
Type Name Description
System.Nullable<System.Int64> round

The round to wait until returning status
Returns
Type Description
NodeStatusResponse

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

Task of NodeStatusResponse
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<NodeStatusResponse>> 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<NodeStatusResponse>>

Task of ApiResponse (NodeStatusResponse)
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<NodeStatusResponse> WaitForBlockWithHttpInfo(long? round)
Parameters
Type Name Description
System.Nullable<System.Int64> round

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

ApiResponse of NodeStatusResponse
Exceptions
Type Condition
ApiException

Thrown when fails to make API call

Implements