algod REST Models

Account

Account Description
address
String Address indicates the account public key
amount
Integer Amount indicates the total number of MicroAlgos in the account format: uint64
amountwithoutpendingrewards
Integer AmountWithoutPendingRewards specifies the amount of MicroAlgos in the account, without the pending rewards. format: uint64
pendingrewards
Integer PendingRewards specifies the amount of MicroAlgos of pending rewards in this account. format: uint64
rewards
Integer Rewards indicates the total rewards of MicroAlgos the account has recieved format: uint64
round
Integer Round indicates the round for which this information is relevant format: uint64
status
String Status indicates the delegation status of the account's MicroAlgos Offline - indicates that the associated account is delegated. Online - indicates that the associated account used as part of the delegation pool. NotParticipating - indicates that the associated account is neither a delegator nor a delegate.

Block

Block contains a block information
currentProtocol
String CurrentProtocol is a string that represents the current protocol
frac (optional)
Integer The number of leftover MicroAlgos after the distribution of RewardsRate/rewardUnits MicroAlgos for every reward unit in the next round. format: uint64
hash
String Hash is the current block hash
nextProtocol
String NextProtocol is a string that represents the next proposed protocol
nextProtocolApprovals
Integer NextProtocolApprovals is the number of blocks which approved the protocol upgrade format: uint64
nextProtocolSwitchOn
Integer NextProtocolSwitchOn is the round on which the protocol upgrade will take effect format: uint64
nextProtocolVoteBefore
Integer NextProtocolVoteBefore is the deadline round for this protocol upgrade (No votes will be consider after this round) format: uint64
period
Integer Period is the period on which the block was confirmed format: uint64
previousBlockHash
String PreviousBlockHash is the previous block hash
proposer
String Proposer is the address of this block proposer
rate (optional)
Integer The number of new MicroAlgos added to the participation stake from rewards at the next round. format: uint64
reward (optional)
Integer RewardsLevel specifies how many rewards, in MicroAlgos, have been distributed to each config.Protocol.RewardUnit of MicroAlgos since genesis. format: uint64
round
Integer Round is the current round on which this block was appended to the chain format: uint64
seed
String Seed is the sortition seed
timestamp
Long TimeStamp in seconds since epoch format: int64
txnRoot
String TransactionsRoot authenticates the set of transactions appearing in the block. More specifically, it's the root of a merkle tree whose leaves are the block's Txids, in lexicographic order. For the empty block, it's 0. Note that the TxnRoot does not authenticate the signatures on the transactions, only the transactions themselves. Two blocks with the same transactions but in a different order and with different signatures will have the same TxnRoot.
txns (optional)
upgradeApprove
Boolean UpgradeApprove indicates a yes vote for the current proposal
upgradePropose
String UpgradePropose indicates a proposed upgrade

NodeStatus

NodeStatus contains the information about a node status
catchupTime
Long CatchupTime in nanoseconds format: int64
lastConsensusVersion
String LastVersion indicates the last consensus version supported
lastRound
Integer LastRound indicates the last round seen format: uint64
nextConsensusVersion
String NextVersion of consensus protocol to use
nextConsensusVersionRound
Integer NextVersionRound is the round at which the next consensus version will apply format: uint64
nextConsensusVersionSupported
Boolean NextVersionSupported indicates whether the next consensus version is supported by this node
timeSinceLastRound
Long TimeSinceLastRound in nanoseconds format: int64

PaymentTransactionType

PaymentTransactionType contains the additional fields for a payment Transaction
amount
Integer Amount is the amount of MicroAlgos intended to be transferred format: uint64
close (optional)
String CloseRemainderTo is the address the sender closed to
closeamount (optional)
Integer CloseAmount is the amount sent to CloseRemainderTo, for committed transaction format: uint64
closerewards (optional)
Integer CloseRewards is the amount of pending rewards applied to the CloseRemainderTo account as part of this transaction. format: uint64
to
String To is the receiver's address
torewards (optional)
Integer ToRewards is the amount of pending rewards applied to the To account as part of this transaction. format: uint64

PendingTransactions

PendingTransactions represents a potentially truncated list of transactions currently in the node's transaction pool.
totalTxns
Integer TotalTxns format: uint64
truncatedTxns

Supply

Supply represents the current supply of MicroAlgos in the system
onlineMoney
Integer OnlineMoney format: uint64
round
Integer Round format: uint64
totalMoney
Integer TotalMoney format: uint64

Transaction

Transaction contains all fields common to all transactions and serves as an envelope to all transactions type
fee
Integer Fee is the transaction fee format: uint64
first-round
Integer FirstRound indicates the first valid round for this transaction format: uint64
from
String From is the sender's address
fromrewards (optional)
Integer FromRewards is the amount of pending rewards applied to the From account as part of this transaction. format: uint64
genesisID
String Genesis ID
genesishashb64
byte[] Genesis hash format: binary
last-round
Integer LastRound indicates the last valid round for this transaction format: uint64
noteb64 (optional)
byte[] Note is a free form data format: binary
payment (optional)
poolerror (optional)
String PoolError indicates the transaction was evicted from this node's transaction pool (if non-empty). A non-empty PoolError does not guarantee that the transaction will never be committed; other nodes may not have evicted the transaction and may attempt to commit it in the future.
round (optional)
Integer ConfirmedRound indicates the block number this transaction appeared in format: uint64
tx
String TxID is the transaction ID
type

TransactionFee

TransactionFee contains the suggested fee
fee
Integer Fee is transaction fee Fee is in units of micro-Algos per byte. Fee may fall to zero but transactions must still have a fee of at least MinTxnFee for the current network protocol. format: uint64

TransactionList

TransactionList contains a list of transactions
transactions
array[Transaction] TransactionList is a list of transactions

TransactionParams

TransactionParams contains the parameters that help a client construct a new transaction.
consensusVersion
String ConsensusVersion indicates the consensus protocol version as of LastRound.
fee
Integer Fee is the suggested transaction fee Fee is in units of micro-Algos per byte. Fee may fall to zero but transactions must still have a fee of at least MinTxnFee for the current network protocol. format: uint64
genesisID
String Genesis ID
genesishashb64
byte[] Genesis hash format: binary
lastRound
Integer LastRound indicates the last round seen format: uint64

TxType

TxType is the type of the transaction written to the ledger

Version

Note that we annotate this as a model so that legacy clients can directly import a swagger generated Version model.
genesis_hash_b64
byte[] format: binary
genesis_id
String
versions
array[String]

transactionID

TransactionID Description
txId
String TxId is the string encoding of the transaction hash