v2 🆕
Paths¶
GET /health¶
Returns OK if healthy.
GET /health
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK. | No Content |
| default | Unknown Error | No Content |
Produces
application/json
Tags
- common
GET /metrics¶
Return metrics about algod functioning.
GET /metrics
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | text with #-comments and key:value lines | No Content |
| 404 | metrics were compiled out | No Content |
Produces
text/plain
Tags
- common
GET /swagger.json¶
Gets the current swagger spec.
GET /swagger.json
Description Returns the entire swagger spec in json.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | The current swagger spec | string |
| default | Unknown Error | No Content |
Produces
application/json
Tags
- common
GET /v2/accounts/{address}¶
Get account information.
GET /v2/accounts/{address}
Description Given a specific account public key, this call returns the accounts status, balance and spendable amounts
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | address required |
An account public key | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | (empty) | Account |
| 400 | Malformed address | ErrorResponse |
| 401 | Invalid API Token | ErrorResponse |
| 500 | Internal Error | ErrorResponse |
| default | Unknown Error | No Content |
Produces
application/json
GET /v2/accounts/{address}/transactions/pending¶
Get a list of unconfirmed transactions currently in the transaction pool by address.
GET /v2/accounts/{address}/transactions/pending
Description 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | address required |
An account public key | string |
| Query | format optional |
Configures whether the response object is JSON or MessagePack encoded. | enum (json, msgpack) |
| Query | max optional |
Truncated number of transactions to display. If max=0, returns all pending txns. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | A potentially truncated list of transactions currently in the node's transaction pool. You can compute whether or not the list is truncated if the number of elements in the top-transactions array is fewer than total-transactions. | Response 200 |
| 400 | Max must be a non-negative integer | ErrorResponse |
| 401 | Invalid API Token | ErrorResponse |
| 500 | Internal Error | ErrorResponse |
| 503 | Service Temporarily Unavailable | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| top-transactions required |
An array of signed transaction objects. | < object > array |
| total-transactions required |
Total number of transactions in the pool. | integer |
Produces
application/json
GET /v2/blocks/{round}¶
Get the block for the given round.
GET /v2/blocks/{round}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | round required |
The round from which to fetch block information. | integer |
| Query | format optional |
Configures whether the response object is JSON or MessagePack encoded. | enum (json, msgpack) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Encoded block object. | Response 200 |
| 400 | Bad Request - Non integer number | ErrorResponse |
| 401 | Invalid API Token | ErrorResponse |
| 404 | None existing block | ErrorResponse |
| 500 | Internal Error | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| block required |
Block header data. | object |
| cert optional |
Optional certificate object. This is only included when the format is set to message pack. | object |
Produces
application/jsonapplication/msgpack
POST /v2/catchup/{catchpoint}¶
Starts a catchpoint catchup.
POST /v2/catchup/{catchpoint}
Description Given a catchpoint, it starts catching up to this catchpoint
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | catchpoint required |
A catch point | string (catchpoint) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | (empty) | Response 200 |
| 400 | Bad Request | ErrorResponse |
| 401 | Invalid API Token | ErrorResponse |
| 500 | Internal Error | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| catchup-message required |
Catchup start response string | string |
Produces
application/json
Tags
- private
DELETE /v2/catchup/{catchpoint}¶
Aborts a catchpoint catchup.
DELETE /v2/catchup/{catchpoint}
Description Given a catchpoint, it aborts catching up to this catchpoint
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | catchpoint required |
A catch point | string (catchpoint) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | (empty) | Response 200 |
| 400 | Bad Request | ErrorResponse |
| 401 | Invalid API Token | ErrorResponse |
| 500 | Internal Error | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| catchup-message required |
Catchup abort response string | string |
Produces
application/json
Tags
- private
GET /v2/ledger/supply¶
Get the current supply reported by the ledger.
GET /v2/ledger/supply
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Supply represents the current supply of MicroAlgos in the system. | Response 200 |
| 401 | Invalid API Token | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| current_round required |
Round | integer |
| online-money required |
OnlineMoney | integer |
| total-money required |
TotalMoney | integer |
Produces
application/json
POST /v2/register-participation-keys/{address}¶
Description Generate (or renew) and register participation keys on the node for a given account address.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | address required |
The account-id to update, or all to update all accounts. |
string | |
| Query | fee optional |
The fee to use when submitting key registration transactions. Defaults to the suggested fee. | integer | 1000 |
| Query | key-dilution optional |
value to use for two-level participation key. | integer | |
| Query | no-wait optional |
Don't wait for transaction to commit before returning response. | boolean | |
| Query | round-last-valid optional |
The last round for which the generated participation keys will be valid. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Transaction ID of the submission. | Response 200 |
| Name | Description | Schema |
|---|---|---|
| txId required |
encoding of the transaction hash. | string |
Tags
- private
POST /v2/shutdown¶
Description Special management endpoint to shutdown the node. Optionally provide a timeout parameter to indicate that the node should begin shutting down after a number of seconds.
Parameters
| Type | Name | Schema | Default |
|---|---|---|---|
| Query | timeout optional |
integer | 0 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | (empty) | object |
Tags
- private
GET /v2/status¶
Gets the current node status.
GET /v2/status
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | (empty) | Response 200 |
| 401 | Invalid API Token | ErrorResponse |
| 500 | Internal Error | string |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| catchpoint optional |
The current catchpoint that is being caught up to | string |
| catchpoint-acquired-blocks optional |
The number of blocks that have already been obtained by the node as part of the catchup | integer |
| catchpoint-processed-accounts optional |
The number of account from the current catchpoint that have been processed so far as part of the catchup | integer |
| catchpoint-total-accounts optional |
The total number of accounts included in the current catchpoint | integer |
| catchpoint-total-blocks optional |
The total number of blocks that are required to complete the current catchpoint catchup | integer |
| catchup-time required |
CatchupTime in nanoseconds | integer |
| last-catchpoint optional |
The last catchpoint seen by the node | string |
| last-round required |
LastRound indicates the last round seen | integer |
| last-version required |
LastVersion indicates the last consensus version supported | string |
| next-version required |
NextVersion of consensus protocol to use | string |
| next-version-round required |
NextVersionRound is the round at which the next consensus version will apply | integer |
| next-version-supported required |
NextVersionSupported indicates whether the next consensus version is supported by this node | boolean |
| stopped-at-unsupported-round required |
StoppedAtUnsupportedRound indicates that the node does not support the new rounds and has stopped making progress | boolean |
| time-since-last-round required |
TimeSinceLastRound in nanoseconds | integer |
Produces
application/json
GET /v2/status/wait-for-block-after/{round}¶
Gets the node status after waiting for the given round.
GET /v2/status/wait-for-block-after/{round}
Description Waits for a block to appear after round {round} and returns the node's status at the time.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | round required |
The round to wait until returning status | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | (empty) | Response 200 |
| 400 | Bad Request -- number must be non-negative integer | ErrorResponse |
| 401 | Invalid API Token | ErrorResponse |
| 500 | Internal Error | ErrorResponse |
| 503 | Service Temporarily Unavailable | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| catchpoint optional |
The current catchpoint that is being caught up to | string |
| catchpoint-acquired-blocks optional |
The number of blocks that have already been obtained by the node as part of the catchup | integer |
| catchpoint-processed-accounts optional |
The number of account from the current catchpoint that have been processed so far as part of the catchup | integer |
| catchpoint-total-accounts optional |
The total number of accounts included in the current catchpoint | integer |
| catchpoint-total-blocks optional |
The total number of blocks that are required to complete the current catchpoint catchup | integer |
| catchup-time required |
CatchupTime in nanoseconds | integer |
| last-catchpoint optional |
The last catchpoint seen by the node | string |
| last-round required |
LastRound indicates the last round seen | integer |
| last-version required |
LastVersion indicates the last consensus version supported | string |
| next-version required |
NextVersion of consensus protocol to use | string |
| next-version-round required |
NextVersionRound is the round at which the next consensus version will apply | integer |
| next-version-supported required |
NextVersionSupported indicates whether the next consensus version is supported by this node | boolean |
| stopped-at-unsupported-round required |
StoppedAtUnsupportedRound indicates that the node does not support the new rounds and has stopped making progress | boolean |
| time-since-last-round required |
TimeSinceLastRound in nanoseconds | integer |
Produces
application/json
POST /v2/teal/compile¶
Compile TEAL source code to binary, produce its hash
POST /v2/teal/compile
Description Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style).
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | source required |
TEAL source code to be compiled | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Teal compile Result | Response 200 |
| 400 | Bad Request - Teal Compile Error | ErrorResponse |
| 401 | Invalid API Token | ErrorResponse |
| 500 | Internal Error | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| hash required |
base32 SHA512_256 of program bytes (Address style) | string |
| result required |
base64 encoded program bytes | string |
Consumes
text/plain
Produces
application/json
POST /v2/transactions¶
Broadcasts a raw transaction to the network.
POST /v2/transactions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | rawtxn required |
The byte encoded signed transaction to broadcast to network | string (binary) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Transaction ID of the submission. | Response 200 |
| 400 | Bad Request - Malformed Algorand transaction | ErrorResponse |
| 401 | Invalid API Token | ErrorResponse |
| 500 | Internal Error | ErrorResponse |
| 503 | Service Temporarily Unavailable | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| txId required |
encoding of the transaction hash. | string |
Consumes
application/x-binary
Produces
application/json
GET /v2/transactions/params¶
Get parameters for constructing a new transaction
GET /v2/transactions/params
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | TransactionParams contains the parameters that help a client construct a new transaction. | Response 200 |
| 401 | Invalid API Token | ErrorResponse |
| 500 | Internal Error | ErrorResponse |
| 503 | Service Temporarily Unavailable | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| consensus-version required |
ConsensusVersion indicates the consensus protocol version as of LastRound. |
string |
| fee required |
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. |
integer |
| genesis-hash required |
GenesisHash is the hash of the genesis block. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
| genesis-id required |
GenesisID is an ID listed in the genesis block. | string |
| last-round required |
LastRound indicates the last round seen | integer |
| min-fee required |
The minimum transaction fee (not per byte) required for the txn to validate for the current network protocol. |
integer |
Produces
application/json
GET /v2/transactions/pending¶
Get a list of unconfirmed transactions currently in the transaction pool.
GET /v2/transactions/pending
Description 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | format optional |
Configures whether the response object is JSON or MessagePack encoded. | enum (json, msgpack) |
| Query | max optional |
Truncated number of transactions to display. If max=0, returns all pending txns. | integer |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | A potentially truncated list of transactions currently in the node's transaction pool. You can compute whether or not the list is truncated if the number of elements in the top-transactions array is fewer than total-transactions. | Response 200 |
| 401 | Invalid API Token | ErrorResponse |
| 500 | Internal Error | ErrorResponse |
| 503 | Service Temporarily Unavailable | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| top-transactions required |
An array of signed transaction objects. | < object > array |
| total-transactions required |
Total number of transactions in the pool. | integer |
Produces
application/jsonapplication/msgpack
GET /v2/transactions/pending/{txid}¶
Get a specific pending transaction.
GET /v2/transactions/pending/{txid}
Description 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 = "") - transaction removed from pool due to error (committed round = 0, pool error != "") Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | txid required |
A transaction id | string |
| Query | format optional |
Configures whether the response object is JSON or MessagePack encoded. | enum (json, msgpack) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | 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 = "") - transaction removed from pool due to error (committed round = 0, pool error != "") Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error. |
Response 200 |
| 400 | Bad Request | ErrorResponse |
| 401 | Invalid API Token | ErrorResponse |
| 404 | Transaction Not Found | ErrorResponse |
| default | Unknown Error | No Content |
| Name | Description | Schema |
|---|---|---|
| asset-index optional |
The asset index if the transaction was found and it created an asset. | integer |
| close-rewards optional |
Rewards in microalgos applied to the close remainder to account. | integer |
| closing-amount optional |
Closing amount for the transaction. | integer |
| confirmed-round optional |
The round where this transaction was confirmed, if present. | integer |
| pool-error required |
Indicates that the transaction was kicked out of this node's transaction pool (and specifies why that happened). An empty string indicates the transaction wasn't kicked out of this node's txpool due to an error. | string |
| receiver-rewards optional |
Rewards in microalgos applied to the receiver account. | integer |
| sender-rewards optional |
Rewards in microalgos applied to the sender account. | integer |
| txn required |
The raw signed transaction. | object |
Produces
application/json
Definitions¶
Account¶
Account information at a given round.
Definition: data/basics/userBalance.go : AccountData
| Name | Description | Schema |
|---|---|---|
| address required |
the account public key | string |
| amount required |
[algo] total number of MicroAlgos in the account | integer |
| amount-without-pending-rewards required |
specifies the amount of MicroAlgos in the account, without the pending rewards. | integer |
| assets optional |
[asset] assets held by this account. Note the raw object uses map[int] -> AssetHolding for this type. |
< AssetHolding > array |
| created-assets optional |
[apar] parameters of assets created by this account. Note: the raw account uses map[int] -> Asset for this type. |
< Asset > array |
| participation optional |
AccountParticipation | |
| pending-rewards required |
amount of MicroAlgos of pending rewards in this account. | integer |
| reward-base optional |
[ebase] used as part of the rewards computation. Only applicable to accounts which are participating. | integer |
| rewards required |
[ern] total rewards of MicroAlgos the account has received, including pending rewards. | integer |
| round required |
The round for which this information is relevant. | integer |
| sig-type optional |
Indicates what type of signature is used by this account, must be one of: * sig * msig * lsig |
enum (sig, msig, lsig) |
| status required |
[onl] 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. |
string |
AccountParticipation¶
AccountParticipation describes the parameters used by this account in consensus protocol.
| Name | Description | Schema |
|---|---|---|
| selection-participation-key required |
[sel] Selection public key (if any) currently registered for this round. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
| vote-first-valid required |
[voteFst] First round for which this participation is valid. | integer |
| vote-key-dilution required |
[voteKD] Number of subkeys in each batch of participation keys. | integer |
| vote-last-valid required |
[voteLst] Last round for which this participation is valid. | integer |
| vote-participation-key required |
[vote] root participation public key (if any) currently registered for this round. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
Asset¶
Specifies both the unique identifier and the parameters for an asset
| Name | Description | Schema |
|---|---|---|
| index required |
unique asset identifier | integer |
| params required |
AssetParams |
AssetHolding¶
Describes an asset held by an account.
Definition: data/basics/userBalance.go : AssetHolding
| Name | Description | Schema |
|---|---|---|
| amount required |
[a] number of units held. | integer |
| asset-id required |
Asset ID of the holding. | integer |
| creator required |
Address that created this asset. This is the address where the parameters for this asset can be found, and also the address where unwanted asset units can be sent in the worst case. | string |
| is-frozen required |
[f] whether or not the holding is frozen. | boolean |
AssetParams¶
AssetParams specifies the parameters for an asset.
[apar] when part of an AssetConfig transaction.
Definition: data/transactions/asset.go : AssetParams
| Name | Description | Schema |
|---|---|---|
| clawback optional |
[c] Address of account used to clawback holdings of this asset. If empty, clawback is not permitted. | string |
| creator required |
The address that created this asset. This is the address where the parameters for this asset can be found, and also the address where unwanted asset units can be sent in the worst case. | string |
| decimals required |
[dc] The number of digits to use after the decimal point when displaying this asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in tenths. If 2, the base unit of the asset is in hundredths, and so on. This value must be between 0 and 19 (inclusive). Minimum value : 0 Maximum value : 19 |
integer |
| default-frozen optional |
[df] Whether holdings of this asset are frozen by default. | boolean |
| freeze optional |
[f] Address of account used to freeze holdings of this asset. If empty, freezing is not permitted. | string |
| manager optional |
[m] Address of account used to manage the keys of this asset and to destroy it. | string |
| metadata-hash optional |
[am] A commitment to some unspecified asset metadata. The format of this metadata is up to the application. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
| name optional |
[an] Name of this asset, as supplied by the creator. | string |
| reserve optional |
[r] Address of account holding reserve (non-minted) units of this asset. | string |
| total required |
[t] The total number of units of this asset. | integer |
| unit-name optional |
[un] Name of a unit of this asset, as supplied by the creator. | string |
| url optional |
[au] URL where more information about the asset can be retrieved. | string |
ErrorResponse¶
An error response with optional data field.
| Name | Schema |
|---|---|
| data optional |
string |
| message required |
string |
Version¶
Note that we annotate this as a model so that legacy clients can directly import a swagger generated Version model.
| Name | Description | Schema |
|---|---|---|
| build required |
VersionBuild | |
| genesis-hash required |
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
| genesis-id required |
string | |
| versions required |
< string > array |
VersionBuild¶
the current algod build version information.
| Name | Description | Schema |
|---|---|---|
| branch required |
string | |
| build-number required |
integer | |
| channel required |
string | |
| commit-hash required |
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
| major required |
integer | |
| minor required |
integer |