v2
Paths¶
GET /genesis¶
Gets the genesis information.
GET /genesis
Description Returns the entire genesis file in json.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | The genesis file in json. | string |
default | Unknown Error | No Content |
Produces
application/json
Tags
- common
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 |
Query | exclude optional |
When set to all will exclude asset holdings, application local state, created asset parameters, any created application parameters. Defaults to none . |
enum (all, none) |
Query | format optional |
Configures whether the response object is JSON or MessagePack encoded. | enum (json, msgpack) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | AccountResponse wraps the Account type in a response. | Account |
400 | Bad request | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
500 | Internal Error | ErrorResponse |
default | Unknown Error | No Content |
Produces
application/json
application/msgpack
GET /v2/accounts/{address}/applications/{application-id}¶
Get account information about a given app.
GET /v2/accounts/{address}/applications/{application-id}
Description Given a specific account public key and application ID, this call returns the account's application local state and global state (AppLocalState and AppParams, if either exists). Global state will only be returned if the provided address is the application's creator.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | address required |
An account public key | string |
Path | application-id required |
An application identifier | integer |
Query | format optional |
Configures whether the response object is JSON or MessagePack encoded. | enum (json, msgpack) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | AccountApplicationResponse describes the account's application local state and global state (AppLocalState and AppParams, if either exists) for a specific application ID. Global state will only be returned if the provided address is the application's creator. | Response 200 |
400 | Malformed address or application ID | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
500 | Internal Error | ErrorResponse |
default | Unknown Error | No Content |
Name | Description | Schema |
---|---|---|
app-local-state optional |
[appl] the application local data stored in this account. The raw account uses AppLocalState for this type. |
ApplicationLocalState |
created-app optional |
[appp] parameters of the application created by this account including app global data. The raw account uses AppParams for this type. |
ApplicationParams |
round required |
The round for which this information is relevant. | integer |
Produces
application/json
application/msgpack
GET /v2/accounts/{address}/assets/{asset-id}¶
Get account information about a given asset.
GET /v2/accounts/{address}/assets/{asset-id}
Description Given a specific account public key and asset ID, this call returns the account's asset holding and asset parameters (if either exist). Asset parameters will only be returned if the provided address is the asset's creator.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | address required |
An account public key | string |
Path | asset-id required |
An asset identifier | integer |
Query | format optional |
Configures whether the response object is JSON or MessagePack encoded. | enum (json, msgpack) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | AccountAssetResponse describes the account's asset holding and asset parameters (if either exist) for a specific asset ID. Asset parameters will only be returned if the provided address is the asset's creator. | Response 200 |
400 | Malformed address or asset ID | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
500 | Internal Error | ErrorResponse |
default | Unknown Error | No Content |
Name | Description | Schema |
---|---|---|
asset-holding optional |
[asset] Details about the asset held by this account. The raw account uses AssetHolding for this type. |
AssetHolding |
created-asset optional |
[apar] parameters of the asset created by this account. The raw account uses AssetParams for this type. |
AssetParams |
round required |
The round for which this information is relevant. | integer |
Produces
application/json
application/msgpack
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
application/msgpack
GET /v2/applications/{application-id}¶
Get application information.
GET /v2/applications/{application-id}
Description Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | application-id required |
An application identifier | integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Application information | Application |
400 | Bad Request | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
404 | Application Not Found | ErrorResponse |
500 | Internal Error | ErrorResponse |
default | Unknown Error | No Content |
Produces
application/json
GET /v2/assets/{asset-id}¶
Get asset information.
GET /v2/assets/{asset-id}
Description Given a asset ID, it returns asset information including creator, name, total supply and special addresses.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | asset-id required |
An asset identifier | integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Asset information | Asset |
400 | Bad Request | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
404 | Application Not Found | ErrorResponse |
500 | Internal Error | ErrorResponse |
default | Unknown Error | No Content |
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/json
application/msgpack
GET /v2/blocks/{round}/transactions/{txid}/proof¶
Get a Merkle proof for a transaction in a block.
GET /v2/blocks/{round}/transactions/{txid}/proof
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | round required |
The round in which the transaction appears. | integer |
Path | txid required |
The transaction ID for which to generate a proof. | string |
Query | format optional |
Configures whether the response object is JSON or MessagePack encoded. | enum (json, msgpack) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Proof of transaction in a block. | Response 200 |
400 | Malformed round number or transaction ID | ErrorResponse |
401 | Invalid API token | ErrorResponse |
404 | Non-existent block or transaction | ErrorResponse |
500 | Internal error, including protocol not supporting Merkle proofs. | ErrorResponse |
default | Unknown error | No Content |
Name | Description | Schema |
---|---|---|
hashtype required |
The type of hash function used to create the proof, must be one of: * sumhash * sha512_256 |
enum (sumhash, sha512_256) |
idx required |
Index of the transaction in the block's payset. | integer |
proof required |
Merkle proof of transaction membership. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
stibhash required |
Hash of SignedTxnInBlock for verifying proof. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
treedepth required |
Represents the depth of the tree that is being proven, i.e. the number of edges from a leaf to the root. | integer |
Produces
application/json
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 | Response 200 | |
201 | Response 201 | |
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 |
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 | 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/participation¶
Add a participation key to the node
POST /v2/participation
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | participationkey required |
The participation key to add to the node | string (binary) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Participation ID of the submission | Response 200 |
400 | Bad Request | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
404 | Participation Key Not Found | ErrorResponse |
500 | Internal Error | ErrorResponse |
503 | Service Temporarily Unavailable | ErrorResponse |
default | Unknown Error | No Content |
Name | Description | Schema |
---|---|---|
partId required |
encoding of the participation ID. | string |
Consumes
application/msgpack
Produces
application/json
Tags
- private
GET /v2/participation¶
Return a list of participation keys
GET /v2/participation
Description Return a list of participation keys
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | A list of participation keys | < ParticipationKey > array |
400 | Bad Request | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
404 | Participation Key Not Found | ErrorResponse |
500 | Internal Error | ErrorResponse |
default | Unknown Error | No Content |
Produces
application/json
Tags
- private
POST /v2/participation/{participation-id}¶
Append state proof keys to a participation key
POST /v2/participation/{participation-id}
Description Given a participation ID, append state proof keys to a particular set of participation keys
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | participation-id required |
string | |
Body | keymap required |
The state proof keys to add to an existing participation ID | string (binary) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | A detailed description of a participation ID | ParticipationKey |
400 | Bad Request | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
404 | Participation Key Not Found | ErrorResponse |
500 | Internal Error | ErrorResponse |
default | Unknown Error | No Content |
Consumes
application/msgpack
Produces
application/json
Tags
- private
GET /v2/participation/{participation-id}¶
Get participation key info given a participation ID
GET /v2/participation/{participation-id}
Description Given a participation ID, return information about that participation key
Parameters
Type | Name | Schema |
---|---|---|
Path | participation-id required |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | A detailed description of a participation ID | ParticipationKey |
400 | Bad Request | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
404 | Participation Key Not Found | ErrorResponse |
500 | Internal Error | ErrorResponse |
default | Unknown Error | No Content |
Produces
application/json
Tags
- private
DELETE /v2/participation/{participation-id}¶
Delete a given participation key by ID
DELETE /v2/participation/{participation-id}
Description Delete a given participation key by ID
Parameters
Type | Name | Schema |
---|---|---|
Path | participation-id required |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Participation key got deleted by ID | No Content |
400 | Bad Request | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
404 | Participation Key Not Found | ErrorResponse |
500 | Internal Error | ErrorResponse |
default | Unknown Error | No Content |
Produces
application/json
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 | Schema |
---|---|
200 | object |
Tags
- private
GET /v2/status¶
Gets the current node status.
GET /v2/status
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | 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 accounts 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 |
catchpoint-verified-accounts optional |
The number of accounts from the current catchpoint that have been verified so far as part of the 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 | 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 accounts 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 |
catchpoint-verified-accounts optional |
The number of accounts from the current catchpoint that have been verified so far as part of the 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). This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | source required |
TEAL source code to be compiled | string (binary) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Teal compile Result | Response 200 |
400 | Bad Request - Teal Compile Error | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
404 | Developer API not enabled | No Content |
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/teal/dryrun¶
Provide debugging information for a transaction (or group).
POST /v2/teal/dryrun
Description Executes TEAL program(s) in context and returns debugging information about the execution. This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | request optional |
Transaction (or group) and any accompanying state-simulation data. | DryrunRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | DryrunResponse contains per-txn debug information from a dryrun. | Response 200 |
400 | Bad Request | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
404 | Developer API not enabled | No Content |
500 | Internal Error | ErrorResponse |
default | Unknown Error | No Content |
Name | Description | Schema |
---|---|---|
error required |
string | |
protocol-version required |
Protocol version is the protocol version Dryrun was operated under. | string |
txns required |
< DryrunTxnResult > array |
Consumes
application/json
application/msgpack
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/json
application/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. |
PendingTransactionResponse |
400 | Bad Request | ErrorResponse |
401 | Invalid API Token | ErrorResponse |
404 | Transaction Not Found | ErrorResponse |
default | Unknown Error | No Content |
Produces
application/json
application/msgpack
GET /versions¶
Description Retrieves the supported API versions, binary build versions, and genesis information.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | VersionsResponse is the response to 'GET /versions' | Version |
Produces
application/json
Tags
- common
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 |
apps-local-state optional |
[appl] applications local data stored in this account. Note the raw object uses map[int] -> AppLocalState for this type. |
< ApplicationLocalState > array |
apps-total-extra-pages optional |
[teap] the sum of all extra application program pages for this account. | integer |
apps-total-schema optional |
[tsch] stores the sum of all of the local schemas and global schemas in this account. Note: the raw account uses StateSchema for this type. |
ApplicationStateSchema |
assets optional |
[asset] assets held by this account. Note the raw object uses map[int] -> AssetHolding for this type. |
< AssetHolding > array |
auth-addr optional |
[spend] the address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field. | string |
created-apps optional |
[appp] parameters of applications created by this account including app global data. Note: the raw account uses map[int] -> AppParams for this type. |
< Application > 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 |
min-balance required |
MicroAlgo balance required by the account. The requirement grows based on asset and application usage. |
integer |
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 |
total-apps-opted-in required |
The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account. | integer |
total-assets-opted-in required |
The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account. | integer |
total-created-apps required |
The count of all apps (AppParams objects) created by this account. | integer |
total-created-assets required |
The count of all assets (AssetParams objects) created by this account. | integer |
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) |
state-proof-key optional |
[stprf] Root of the state proof key (if any) 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) |
AccountStateDelta¶
Application state delta.
Name | Schema |
---|---|
address required |
string |
delta required |
StateDelta |
Application¶
Application index and its parameters
Name | Description | Schema |
---|---|---|
id required |
[appidx] application index. | integer |
params required |
[appparams] application parameters. | ApplicationParams |
ApplicationLocalState¶
Stores local state associated with an application.
Name | Description | Schema |
---|---|---|
id required |
The application which this local state is for. | integer |
key-value optional |
[tkv] storage. | TealKeyValueStore |
schema required |
[hsch] schema. | ApplicationStateSchema |
ApplicationParams¶
Stores the global information associated with an application.
Name | Description | Schema |
---|---|---|
approval-program required |
[approv] approval program. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
clear-state-program required |
[clearp] approval program. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
creator required |
The address that created this application. This is the address where the parameters and global state for this application can be found. | string |
extra-program-pages optional |
[epp] the amount of extra program pages available to this app. | integer |
global-state optional |
[\gs] global schema | TealKeyValueStore |
global-state-schema optional |
[\gsch] global schema | ApplicationStateSchema |
local-state-schema optional |
[\lsch] local schema | ApplicationStateSchema |
ApplicationStateSchema¶
Specifies maximums on the number of each type that may be stored.
Name | Description | Schema |
---|---|---|
num-byte-slice required |
[nbs] num of byte slices. | integer |
num-uint required |
[nui] num of uints. | integer |
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 |
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. Included only when the asset name is composed of printable utf-8 characters. | string |
name-b64 optional |
Base64 encoded name of this asset, as supplied by the creator. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
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. Included only when the name of a unit of this asset is composed of printable utf-8 characters. | string |
unit-name-b64 optional |
Base64 encoded name of a unit of this asset, as supplied by the creator. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
url optional |
[au] URL where more information about the asset can be retrieved. Included only when the URL is composed of printable utf-8 characters. | string |
url-b64 optional |
Base64 encoded URL where more information about the asset can be retrieved. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
BuildVersion¶
Name | Schema |
---|---|
branch required |
string |
build_number required |
integer (int64) |
channel required |
string |
commit_hash required |
string |
major required |
integer (int64) |
minor required |
integer (int64) |
DryrunRequest¶
Request data type for dryrun endpoint. Given the Transactions and simulated ledger state upload, run TEAL scripts and return debugging information.
Name | Description | Schema |
---|---|---|
accounts required |
< Account > array | |
apps required |
< Application > array | |
latest-timestamp required |
LatestTimestamp is available to some TEAL scripts. Defaults to the latest confirmed timestamp this algod is attached to. | integer (int64) |
protocol-version required |
ProtocolVersion specifies a specific version string to operate under, otherwise whatever the current protocol of the network this algod is running in. | string |
round required |
Round is available to some TEAL scripts. Defaults to the current round on the network this algod is attached to. | integer |
sources required |
< DryrunSource > array | |
txns required |
< string (json) > array |
DryrunSource¶
DryrunSource is TEAL source text that gets uploaded, compiled, and inserted into transactions or application state.
Name | Description | Schema |
---|---|---|
app-index required |
integer | |
field-name required |
FieldName is what kind of sources this is. If lsig then it goes into the transactions[this.TxnIndex].LogicSig. If approv or clearp it goes into the Approval Program or Clear State Program of application[this.AppIndex]. | string |
source required |
string | |
txn-index required |
integer |
DryrunState¶
Stores the TEAL eval step data
Name | Description | Schema |
---|---|---|
error optional |
Evaluation error if any | string |
line required |
Line number | integer |
pc required |
Program counter | integer |
scratch optional |
< TealValue > array | |
stack required |
< TealValue > array |
DryrunTxnResult¶
DryrunTxnResult contains any LogicSig or ApplicationCall program debug information and state updates from a dryrun.
Name | Description | Schema |
---|---|---|
app-call-messages optional |
< string > array | |
app-call-trace optional |
< DryrunState > array | |
cost optional |
Execution cost of app call transaction | integer |
disassembly required |
Disassembled program line by line. | < string > array |
global-delta optional |
StateDelta | |
local-deltas optional |
< AccountStateDelta > array | |
logic-sig-disassembly optional |
Disassembled lsig program line by line. | < string > array |
logic-sig-messages optional |
< string > array | |
logic-sig-trace optional |
< DryrunState > array | |
logs optional |
< string (byte) > array |
ErrorResponse¶
An error response with optional data field.
Name | Schema |
---|---|
data optional |
object |
message required |
string |
EvalDelta¶
Represents a TEAL value delta.
Name | Description | Schema |
---|---|---|
action required |
[at] delta action. | integer |
bytes optional |
[bs] bytes value. | string |
uint optional |
[ui] uint value. | integer |
EvalDeltaKeyValue¶
Key-value pairs for StateDelta.
Name | Schema |
---|---|
key required |
string |
value required |
EvalDelta |
ParticipationKey¶
Represents a participation key used by the node.
Name | Description | Schema |
---|---|---|
address required |
Address the key was generated for. | string |
effective-first-valid optional |
When registered, this is the first round it may be used. | integer |
effective-last-valid optional |
When registered, this is the last round it may be used. | integer |
id required |
The key's ParticipationID. | string |
key required |
Key information stored on the account. | AccountParticipation |
last-block-proposal optional |
Round when this key was last used to propose a block. | integer |
last-state-proof optional |
Round when this key was last used to generate a state proof. | integer |
last-vote optional |
Round when this key was last used to vote. | integer |
PendingTransactionResponse¶
Details about a pending transaction. If the transaction was recently confirmed, includes confirmation details like the round and reward details.
Name | Description | Schema |
---|---|---|
application-index optional |
The application index if the transaction was found and it created an application. | integer |
asset-closing-amount optional |
The number of the asset's unit that were transferred to the close-to address. | integer |
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 |
global-state-delta optional |
[gd] Global state key/value changes for the application being executed by this transaction. | StateDelta |
inner-txns optional |
Inner transactions produced by application execution. | < PendingTransactionResponse > array |
local-state-delta optional |
[ld] Local state key/value changes for the application being executed by this transaction. | < AccountStateDelta > array |
logs optional |
[lg] Logs for the application being executed by this transaction. | < string (byte) > array |
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 |
StateDelta¶
Application state delta.
Type : < EvalDeltaKeyValue > array
TealKeyValue¶
Represents a key-value pair in an application store.
Name | Schema |
---|---|
key required |
string |
value required |
TealValue |
TealKeyValueStore¶
Represents a key-value store for use in an application.
Type : < TealKeyValue > array
TealValue¶
Represents a TEAL value.
Name | Description | Schema |
---|---|---|
bytes required |
[tb] bytes value. | string |
type required |
[tt] value type. Value 1 refers to bytes, value 2 refers to uint |
integer |
uint required |
[ui] uint value. | integer |
Version¶
algod version information.
Name | Description | Schema |
---|---|---|
build required |
BuildVersion | |
genesis_hash_b64 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 |