Algod REST API.
v1.0.0https://algo.nownodes.iohttps://algo-index.nownodes.ioAPI endpoint for algod operations.
Authentication
api-keyAuthapiKeyAPI Key: api-key in header
API Reference
Genesis
Gets the genesis information.
Returns the entire genesis file in json.
Response
The genesis file in json.
Unknown Error
Authorization
api-keyAuthapiKey in headerHealth
Returns OK if healthy.
Response
OK.
Unknown Error
Authorization
api-keyAuthapiKey in headerMetrics
Return metrics about algod functioning.
Response
text with #-comments and key:value lines
metrics were compiled out
Authorization
api-keyAuthapiKey in headerReady
Returns OK if healthy and fully caught up.
Response
OK.
Internal Error
Node not ready yet
Unknown Error
Authorization
api-keyAuthapiKey in headerSwagger
Gets the current swagger spec.
Returns the entire swagger spec in json.
Response
The current swagger spec
Unknown Error
Authorization
api-keyAuthapiKey in headerGets the current swagger spec.
Returns the entire swagger spec in json.
Response
The current swagger spec
Unknown Error
Authorization
api-keyAuthapiKey in headerAccounts
Get account information.
Given a specific account public key, this call returns the accounts status, balance and spendable amounts
Parameters
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
addressstringrequiredpathAn account public key
excludestringallnonequeryWhen set to all will exclude asset holdings, application local state, created asset parameters, any created application parameters. Defaults to none.
Response
AccountResponse wraps the Account type in a response.
Bad request
Invalid API Token
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerGet account information about a given app.
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
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
addressstringrequiredpathAn account public key
application-idintegerrequiredpathAn application identifier
Response
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.
Malformed address or application ID
Invalid API Token
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerGet account information about a given asset.
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
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
addressstringrequiredpathAn account public key
asset-idintegerrequiredpathAn asset identifier
Response
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.
Malformed address or asset ID
Invalid API Token
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerGet 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.
Parameters
addressstringrequiredpathAn account public key
maxintegerqueryTruncated number of transactions to display. If max=0, returns all pending txns.
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
Response
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.
Max must be a non-negative integer
Invalid API Token
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerApplications
Get application information.
Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
Parameters
application-idintegerrequiredpathAn application identifier
Response
Application information
Bad Request
Invalid API Token
Application Not Found
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerGet box information for a given application.
Given an application ID and box name, it returns the round, box name, and value (each base64 encoded). Box names must be in the goal app call arg encoding form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.
Parameters
application-idintegerrequiredpathAn application identifier
namestringrequiredqueryA box name, in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.
Response
Box information
Bad Request
Invalid API Token
Box Not Found
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerGet all box names for a given application.
Given an application ID, return all Box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all Box names.
Parameters
application-iintegerrequiredpathAn application identifierd
maxintegerqueryMax number of box names to return. If max is not set, or max == 0, returns all box-names.
Response
Box names of an application
Bad Request
Invalid API Token
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerAssets
Get asset information.
Given a asset ID, it returns asset information including creator, name, total supply and special addresses.
Parameters
asset-idintegerrequiredpathAn asset identifier
Response
Asset information
Bad Request
Invalid API Token
Application Not Found
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerBlocks
Get the block for the given round.
Parameters
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
roundinteger>= 0requiredpathThe round from which to fetch block information.
Response
Encoded block object.
Bad Request - Non integer number
Invalid API Token
None existing block
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerGet the block hash for the block on the given round.
Parameters
roundinteger>= 0requiredpathThe round from which to fetch block hash information.
Response
Hash of a block header.
Bad Request - Non integer number
Invalid API Token
None existing block
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerGets a proof for a given light block header inside a state proof commitment
Parameters
roundinteger>= 0requiredpathThe round to which the light block header belongs.
Response
Proof of a light block header.
Invalid API Token
Could not create proof since some data is missing
timed out on request
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerGet a proof for a transaction in a block.
Parameters
roundintegerrequiredpathThe round in which the transaction appears.
txidstringrequiredpathThe transaction ID for which to generate a proof.
hashtypestringsha512_256sha256queryThe type of hash function used to create the proof, must be one of:
- sha512_256
- sha256
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
Response
Proof of transaction in a block.
Malformed round number or transaction ID
Invalid API token
Non-existent block or transaction
Internal error, including protocol not supporting proofs.
Unknown error
Authorization
api-keyAuthapiKey in headerGet the top level transaction IDs for the block on the given round.
Parameters
roundinteger>= 0requiredpathThe round from which to fetch block transaction IDs.
Response
Top level transaction IDs in a block.
Bad Request - Non integer number
Invalid API Token
Non existing block
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerStarts a catchpoint catchup.
Given a catchpoint, it starts catching up to this catchpoint
Parameters
catchpointstring<catchpoint>requiredpathA catch point
minintegerquerySpecify the minimum number of blocks which the ledger must be advanced by in order to start the catchup. This is useful for simplifying tools which support fast catchup, they can run the catchup unconditionally and the node will skip the catchup if it is not needed.
Response
An catchpoint start response.
An catchpoint start response.
Bad Request
Invalid API Token
Request Timeout
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerDeltas
Get a LedgerStateDelta object for a given transaction group
Get a ledger delta for a given transaction group.
Parameters
idstringrequiredpathA transaction ID, or transaction group ID
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
Response
Response containing a ledger state delta for a single transaction group.
Invalid API Token
Could not find a delta for transaction ID or group ID
timed out on request
Internal Error
Not Implemented
Unknown Error
Authorization
api-keyAuthapiKey in headerGet a LedgerStateDelta object for a given round
Get ledger deltas for a round.
Parameters
roundinteger>= 0requiredpathThe round for which the deltas are desired.
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
Response
Contains ledger deltas
Invalid API Token
Could not find a delta for round
timed out on request
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerGet LedgerStateDelta objects for all transaction groups in a given round
Get ledger deltas for transaction groups in a given round.
Parameters
roundinteger>= 0requiredpathThe round for which the deltas are desired.
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
Response
Response containing all ledger state deltas for transaction groups, with their associated Ids, in a single round.
Invalid API Token
Could not find deltas for round
timed out on request
Internal Error
Not Implemented
Unknown Error
Authorization
api-keyAuthapiKey in headerDevmode
Returns the timestamp offset. Timestamp offsets can only be set in dev mode.
Gets the current timestamp offset.
Response
Response containing the timestamp offset in seconds
TimeStamp offset not set.
Unknown Error
Authorization
api-keyAuthapiKey in headerGiven a timestamp offset in seconds, adds the offset to every subsequent block header's timestamp.
Sets the timestamp offset (seconds) for blocks in dev mode. Providing an offset of 0 will unset this value and try to use the real clock for the timestamp.
Parameters
offsetinteger>= 0requiredpathThe timestamp offset for blocks in dev mode.
Response
OK
Cannot set timestamp offset to a negative integer.
Invalid API Token
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerExperimental
Returns OK if experimental API is enabled.
Response
Experimental API enabled
Experimental API not enabled
Unknown Error
Authorization
api-keyAuthapiKey in headerLedger
Get the current supply reported by the ledger.
Response
Supply represents the current supply of MicroAlgos in the system.
Invalid API Token
Unknown Error
Authorization
api-keyAuthapiKey in headerReturns the minimum sync round the ledger is keeping in cache.
Gets the minimum sync round for the ledger.
Response
Response containing the ledger's minimum sync round
Sync round not set.
Invalid API Token
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerGiven a round, tells the ledger to keep that round in its cache.
Sets the minimum sync round on the ledger.
Parameters
roundinteger>= 0requiredpathThe round for which the deltas are desired.
Response
Valid response
Can not set sync round to an earlier round than the current round.
Invalid API Token
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerParticipation
Return a list of participation keys
Return a list of participation keys
Response
A list of participation keys
Bad Request
Invalid API Token
Participation Key Not Found
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerAdd a participation key to the node
Body
The participation key to add to the node
Response
Participation ID of the submission
Bad Request
Invalid API Token
Participation Key Not Found
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerGenerate and install participation keys to the node.
Parameters
addressstringrequiredpathAn account public key
dilutionintegerqueryKey dilution for two-level participation keys (defaults to sqrt of validity window).
firstintegerrequiredqueryFirst round for participation key.
lastintegerrequiredqueryLast round for participation key.
Response
An empty JSON object is returned if the generation process was started. Currently no status is available.
Bad Request
Invalid API Token
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerGet participation key info given a participation ID
Given a participation ID, return information about that participation key
Parameters
participation-idstringrequiredpathResponse
A detailed description of a participation ID
Bad Request
Invalid API Token
Participation Key Not Found
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerAppend state proof keys to a participation key
Given a participation ID, append state proof keys to a particular set of participation keys
Body
The state proof keys to add to an existing participation ID
Parameters
participation-idstringrequiredpathResponse
A detailed description of a participation ID
Bad Request
Invalid API Token
Participation Key Not Found
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerShutdown
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
timeoutinteger0queryResponse
Valid response
Authorization
api-keyAuthapiKey in headerStateproofs
Get a state proof that covers a given round
Parameters
roundinteger>= 0requiredpathThe round for which a state proof is desired.
Response
StateProofResponse wraps the StateProof type in a response.
Invalid API Token
Could not find a state proof that covers a given round
timed out on request
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerStatus
Gets the current node status.
Response
Valid response
Invalid API Token
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerGets the node status after waiting for a round after the given round.
Waits for a block to appear after round {round} and returns the node's status at the time. There is a 1 minute timeout, when reached the current status is returned regardless of whether or not it is the round after the given round.
Parameters
roundinteger>= 0requiredpathThe round to wait until returning status
Response
Valid response
Bad Request -- number must be non-negative integer
Invalid API Token
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerTeal
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). This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.
Body
TEAL source code to be compiled
Parameters
sourcemapbooleanqueryWhen set to true, returns the source map of the program as a JSON. Defaults to false.
Response
Teal compile Result
Bad Request - Teal Compile Error
Invalid API Token
Developer API not enabled
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerDisassemble program bytes into the TEAL source code.
Given the program bytes, return the TEAL source code in plain text. This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.
Body
TEAL program binary to be disassembled
Response
Teal disassembly Result
Bad Request - Teal Compile Error
Invalid API Token
Developer API not enabled
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerProvide debugging information for a transaction (or group).
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.
Body
Transaction (or group) and any accompanying state-simulation data.
application/jsonDryrunRequestRequest data type for dryrun endpoint. Given the Transactions and simulated ledger state upload, run TEAL scripts and return debugging information.
accountsArray<Account>requiredappsArray<Application>requiredlatest-timestampinteger<int64>requiredLatestTimestamp is available to some TEAL scripts. Defaults to the latest confirmed timestamp this algod is attached to.
protocol-versionstringrequiredProtocolVersion specifies a specific version string to operate under, otherwise whatever the current protocol of the network this algod is running in.
roundintegerrequiredRound is available to some TEAL scripts. Defaults to the current round on the network this algod is attached to.
sourcesArray<DryrunSource>requiredtxnsArray<string>requiredapplication/msgpackDryrunRequestRequest data type for dryrun endpoint. Given the Transactions and simulated ledger state upload, run TEAL scripts and return debugging information.
accountsArray<Account>requiredappsArray<Application>requiredlatest-timestampinteger<int64>requiredLatestTimestamp is available to some TEAL scripts. Defaults to the latest confirmed timestamp this algod is attached to.
protocol-versionstringrequiredProtocolVersion specifies a specific version string to operate under, otherwise whatever the current protocol of the network this algod is running in.
roundintegerrequiredRound is available to some TEAL scripts. Defaults to the current round on the network this algod is attached to.
sourcesArray<DryrunSource>requiredtxnsArray<string>requiredResponse
DryrunResponse contains per-txn debug information from a dryrun.
Bad Request
Invalid API Token
Developer API not enabled
Internal Error
Unknown Error
Authorization
api-keyAuthapiKey in headerTransactions
Broadcasts a raw transaction or transaction group to the network.
Body
The byte encoded signed transaction to broadcast to network
Response
Transaction ID of the submission.
Bad Request - Malformed Algorand transaction
Invalid API Token
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerFast track for broadcasting a raw transaction or transaction group to the network through the tx handler without performing most of the checks and reporting detailed errors. Should be only used for development and performance testing.
Body
The byte encoded signed transaction to broadcast to network
Response
Valid response
Bad Request - Malformed Algorand transaction
Invalid API Token
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerGet parameters for constructing a new transaction
Response
TransactionParams contains the parameters that help a client construct a new transaction.
Invalid API Token
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerGet 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.
Parameters
maxintegerqueryTruncated number of transactions to display. If max=0, returns all pending txns.
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
Response
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.
Invalid API Token
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerGet 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 = "")
- 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
txidstringrequiredpathA transaction ID
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
Response
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.
Bad Request
Invalid API Token
Transaction Not Found
Unknown Error
Authorization
api-keyAuthapiKey in headerSimulates a raw transaction or transaction group as it would be evaluated on the network. The simulation will use blockchain state from the latest committed round.
Body
The transactions to simulate, along with any other inputs.
application/jsonSimulateRequestRequest type for simulation endpoint.
allow-empty-signaturesbooleanAllows transactions without signatures to be simulated as if they had correct signatures.
allow-more-loggingbooleanLifts limits on log opcode usage during simulation.
allow-unnamed-resourcesbooleanAllows access to unnamed resources during simulation.
exec-trace-configSimulateTraceConfigAn object that configures simulation execution trace.
extra-opcode-budgetintegerApplies extra opcode budget during simulation for each transaction group.
roundintegerIf provided, specifies the round preceding the simulation. State changes through this round will be used to run this simulation. Usually only the 4 most recent rounds will be available (controlled by the node config value MaxAcctLookback). If not specified, defaults to the latest available round.
txn-groupsArray<SimulateRequestTransactionGroup>requiredThe transaction groups to simulate.
application/msgpackSimulateRequestRequest type for simulation endpoint.
allow-empty-signaturesbooleanAllows transactions without signatures to be simulated as if they had correct signatures.
allow-more-loggingbooleanLifts limits on log opcode usage during simulation.
allow-unnamed-resourcesbooleanAllows access to unnamed resources during simulation.
exec-trace-configSimulateTraceConfigAn object that configures simulation execution trace.
extra-opcode-budgetintegerApplies extra opcode budget during simulation for each transaction group.
roundintegerIf provided, specifies the round preceding the simulation. State changes through this round will be used to run this simulation. Usually only the 4 most recent rounds will be available (controlled by the node config value MaxAcctLookback). If not specified, defaults to the latest available round.
txn-groupsArray<SimulateRequestTransactionGroup>requiredThe transaction groups to simulate.
Parameters
formatstringjsonmsgpackqueryConfigures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.
Response
Result of a transaction group simulation.
Bad Request
Invalid API Token
Internal Error
Service Temporarily Unavailable
Unknown Error
Authorization
api-keyAuthapiKey in headerVersions
Retrieves the supported API versions, binary build versions, and genesis information.
Response
VersionsResponse is the response to 'GET /versions'
Authorization
api-keyAuthapiKey in headerRetrieves the current version
Body
VersionsRequest is the request for GET /versions
Response
Response to GET /versions
Authorization
api-keyAuthapiKey in headerKey
Generate a key
Generates the next key in the deterministic key sequence (as determined by the master derivation key) and adds it to the wallet, returning the public key.
Body
APIV1POSTKeyRequest is the request for POST /v1/key
display_mnemonicbooleanwallet_handle_tokenstringResponse
Response to POST /v1/key
Authorization
api-keyAuthapiKey in headerExport a key
Export the secret key associated with the passed public key.
Body
APIV1POSTKeyExportRequest is the request for POST /v1/key/export
addressstringwallet_handle_tokenstringwallet_passwordstringResponse
Response to POST /v1/key/export
Authorization
api-keyAuthapiKey in headerImport a key
Import an externally generated key into the wallet. Note that if you wish to back up the imported key, you must do so by backing up the entire wallet database, because imported keys were not derived from the wallet's master derivation key.
Body
APIV1POSTKeyImportRequest is the request for POST /v1/key/import
private_keyArray<integer>wallet_handle_tokenstringResponse
Response to POST /v1/key/import
Authorization
api-keyAuthapiKey in headerList keys in wallet
Lists all of the public keys in this wallet. All of them have a stored private key.
Body
APIV1POSTKeyListRequest is the request for POST /v1/key/list
wallet_handle_tokenstringResponse
Response to POST /v1/key/list
Authorization
api-keyAuthapiKey in headerMaster-key
Export the master derivation key from a wallet
Export the master derivation key from the wallet. This key is a master "backup" key for the underlying wallet. With it, you can regenerate all of the wallets that have been generated with this wallet's POST /v1/key endpoint. This key will not allow you to recover keys imported from other wallets, however.
Body
APIV1POSTMasterKeyExportRequest is the request for POST /v1/master-key/export
wallet_handle_tokenstringwallet_passwordstringResponse
Response to POST /v1/master-key/export
Authorization
api-keyAuthapiKey in headerMultisig
Export multisig address metadata
Given a multisig address whose preimage this wallet stores, returns the information used to generate the address, including public keys, threshold, and multisig version.
Body
APIV1POSTMultisigExportRequest is the request for POST /v1/multisig/export
addressstringwallet_handle_tokenstringResponse
Response to POST /v1/multisig/export
Authorization
api-keyAuthapiKey in headerImport a multisig account
Generates a multisig account from the passed public keys array and multisig metadata, and stores all of this in the wallet.
Body
APIV1POSTMultisigImportRequest is the request for POST /v1/multisig/import
multisig_versioninteger<uint8>pksArray<PublicKey>thresholdinteger<uint8>wallet_handle_tokenstringResponse
Response to POST /v1/multisig/import
Authorization
api-keyAuthapiKey in headerList multisig accounts
Lists all of the multisig accounts whose preimages this wallet stores
Body
APIV1POSTMultisigListRequest is the request for POST /v1/multisig/list
wallet_handle_tokenstringResponse
Response to POST /v1/multisig/list
Authorization
api-keyAuthapiKey in headerSign a multisig transaction
Start a multisig signature, or add a signature to a partially completed multisig signature object.
Body
APIV1POSTMultisigTransactionSignRequest is the request for POST /v1/multisig/sign
partial_multisigMultisigSigMultisigSig is the structure that holds multiple Subsigs
public_keyArray<integer>signerArray<integer>transactionstring<byte>wallet_handle_tokenstringwallet_passwordstringResponse
Response to POST /v1/multisig/sign
Authorization
api-keyAuthapiKey in headerSign a program for a multisig account
Start a multisig signature, or add a signature to a partially completed multisig signature object.
Body
APIV1POSTMultisigProgramSignRequest is the request for POST /v1/multisig/signprogram
addressstringdatastring<byte>partial_multisigMultisigSigMultisigSig is the structure that holds multiple Subsigs
public_keyArray<integer>wallet_handle_tokenstringwallet_passwordstringResponse
Response to POST /v1/multisig/signdata
Authorization
api-keyAuthapiKey in headerProgram
Sign program
Signs the passed program with a key from the wallet, determined by the account named in the request.
Body
APIV1POSTProgramSignRequest is the request for POST /v1/program/sign
addressstringdatastring<byte>wallet_handle_tokenstringwallet_passwordstringResponse
Response to POST /v1/data/sign
Authorization
api-keyAuthapiKey in headerTransaction
Sign a transaction
Signs the passed transaction with a key from the wallet, determined by the sender encoded in the transaction.
Body
APIV1POSTTransactionSignRequest is the request for POST /v1/transaction/sign
public_keyArray<integer>transactionstring<byte>Base64 encoding of msgpack encoding of a Transaction object
Note: SDK and goal usually generate SignedTxn objects
in that case, the field txn / Transaction of the
generated SignedTxn object needs to be used
wallet_handle_tokenstringwallet_passwordstringResponse
Response to POST /v1/transaction/sign
Authorization
api-keyAuthapiKey in headerWallet
Create a wallet
Create a new wallet (collection of keys) with the given parameters.
Body
APIV1POSTWalletRequest is the request for POST /v1/wallet
master_derivation_keyArray<integer>MasterDerivationKey is used to derive ed25519 keys for use in wallets
wallet_driver_namestringwallet_namestringwallet_passwordstringResponse
Response to POST /v1/wallet
Authorization
api-keyAuthapiKey in headerGet wallet info
Returns information about the wallet associated with the passed wallet handle token. Additionally returns expiration information about the token itself.
Body
APIV1POSTWalletInfoRequest is the request for POST /v1/wallet/info
wallet_handle_tokenstringResponse
Response to POST /v1/wallet/info
Authorization
api-keyAuthapiKey in headerInitialize a wallet handle token
Unlock the wallet and return a wallet handle token that can be used for subsequent operations. These tokens expire periodically and must be renewed. You can POST the token to /v1/wallet/info to see how much time remains until expiration, and renew it with /v1/wallet/renew. When you're done, you can invalidate the token with /v1/wallet/release.
Body
APIV1POSTWalletInitRequest is the request for POST /v1/wallet/init
wallet_idstringwallet_passwordstringResponse
Response to POST /v1/wallet/init
Authorization
api-keyAuthapiKey in headerRelease a wallet handle token
Invalidate the passed wallet handle token, making it invalid for use in subsequent requests.
Body
APIV1POSTWalletReleaseRequest is the request for POST /v1/wallet/release
wallet_handle_tokenstringResponse
Response to POST /v1/wallet/release
Authorization
api-keyAuthapiKey in headerRename a wallet
Rename the underlying wallet to something else
Body
APIV1POSTWalletRenameRequest is the request for POST /v1/wallet/rename
wallet_idstringwallet_namestringwallet_passwordstringResponse
Response to POST /v1/wallet/rename
Authorization
api-keyAuthapiKey in headerRenew a wallet handle token
Renew a wallet handle token, increasing its expiration duration to its initial value
Body
APIV1POSTWalletRenewRequest is the request for POST /v1/wallet/renew
wallet_handle_tokenstringResponse
Response POST /v1/wallet/renew
Authorization
api-keyAuthapiKey in headerWallets
List wallets
Lists all of the wallets that kmd is aware of.
Body
APIV1GETWalletsRequest is the request for GET /v1/wallets
Response
Response to GET /v1/wallets
Authorization
api-keyAuthapiKey in headerIndexer
Health
Returns 200 if healthy.
Response
(empty)
Unknown Error
Authorization
api-keyAuthapiKey in headerAccounts
Search for accounts.
Parameters
asset-idintegerqueryAsset ID
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
currency-greater-thanintegerqueryResults should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
include-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
excludeArray<string>allassetscreated-assetsapps-local-statecreated-appsnonequeryExclude additional items such as asset holdings, application local data stored for this account, asset parameters created by this account, and application parameters created by this account.
currency-less-thanintegerqueryResults should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
auth-addrstringqueryInclude accounts configured to use this spending key.
roundintegerqueryInclude results for the specified round. For performance reasons, this parameter may be disabled on some configurations. Using application-id or asset-id filters will return both creator and opt-in accounts. Filtering by include-all will return creator and opt-in accounts for deleted assets and accounts. Non-opt-in managers are not included in the results when asset-id is used.
application-idintegerqueryApplication ID
Response
(empty)
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup account information.
Parameters
account-idstringrequiredpathaccount string
roundintegerqueryInclude results for the specified round.
include-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
excludeArray<string>allassetscreated-assetsapps-local-statecreated-appsnonequeryExclude additional items such as asset holdings, application local data stored for this account, asset parameters created by this account, and application parameters created by this account.
Response
(empty)
Response for errors
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup an account's asset holdings, optionally for a specific ID.
Parameters
account-idstringrequiredpathaccount string
application-idintegerqueryApplication ID
include-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
Response
(empty)
Response for errors
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup an account's asset holdings, optionally for a specific ID.
Parameters
account-idstringrequiredpathaccount string
asset-idintegerqueryAsset ID
include-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
Response
(empty)
Response for errors
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup an account's created application parameters, optionally for a specific ID.
Parameters
account-idstringrequiredpathaccount string
application-idintegerqueryApplication ID
include-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
Response
(empty)
Response for errors
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup an account's created asset parameters, optionally for a specific ID.
Parameters
account-idstringrequiredpathaccount string
asset-idintegerqueryAsset ID
include-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
Response
(empty)
Response for errors
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup account transactions. Transactions are returned newest to oldest.
Parameters
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
note-prefixstringquerySpecifies a prefix which must be contained in the note field.
tx-typestringpaykeyregacfgaxferafrzapplstpfquerysig-typestringsigmsiglsigquerySigType filters just results using the specified type of signature:
- sig - Standard
- msig - MultiSig
- lsig - LogicSig
txidstringqueryLookup the specific transaction by ID.
roundintegerqueryInclude results for the specified round.
min-roundintegerqueryInclude results at or after the specified min-round.
max-roundintegerqueryInclude results at or before the specified max-round.
asset-idintegerqueryAsset ID
before-timestring<date-time>queryInclude results before the given time. Must be an RFC 3339 formatted string.
after-timestring<date-time>queryInclude results after the given time. Must be an RFC 3339 formatted string.
currency-greater-thanintegerqueryResults should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
currency-less-thanintegerqueryResults should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
account-idstringrequiredpathaccount string
rekey-tobooleanqueryInclude results which include the rekey-to field.
Response
(empty)
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerApplications
Search for applications
Parameters
application-idintegerqueryApplication ID
creatorstringqueryFilter just applications with the given creator address.
include-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
Response
(empty)
Response for errors
Authorization
api-keyAuthapiKey in headerLookup application.
Parameters
application-idintegerrequiredpathinclude-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
Response
(empty)
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerGet box information for a given application.
Given an application ID and box name, returns base64 encoded box name and value. Box names must be in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, encode base 64 and use 'b64' prefix as in 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.
Parameters
application-idintegerrequiredpathnamestringrequiredqueryA box name in goal-arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.
Response
Box information
Response for errors
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerGet box names for a given application.
Given an application ID, returns the box names of that application sorted lexicographically.
Parameters
application-idintegerrequiredpathlimitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
Response
Box names of an application
Response for errors
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup application logs.
Parameters
application-idintegerrequiredpathlimitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
txidstringqueryLookup the specific transaction by ID.
min-roundintegerqueryInclude results at or after the specified min-round.
max-roundintegerqueryInclude results at or before the specified max-round.
sender-addressstringqueryOnly include transactions with this sender address.
Response
(empty)
Authorization
api-keyAuthapiKey in headerAssets
Search for assets.
Parameters
include-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
creatorstringqueryFilter just assets with the given creator address.
namestringqueryFilter just assets with the given name.
unitstringqueryFilter just assets with the given unit.
asset-idintegerqueryAsset ID
Response
(empty)
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup asset information.
Parameters
asset-idintegerrequiredpathinclude-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
Response
(empty)
Response for errors
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup the list of accounts who hold this asset
Parameters
include-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
currency-greater-thanintegerqueryResults should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
currency-less-thanintegerqueryResults should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
asset-idintegerrequiredpathResponse
(empty)
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup transactions for an asset. Transactions are returned oldest to newest.
Parameters
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
note-prefixstringquerySpecifies a prefix which must be contained in the note field.
tx-typestringpaykeyregacfgaxferafrzapplstpfquerysig-typestringsigmsiglsigquerySigType filters just results using the specified type of signature:
- sig - Standard
- msig - MultiSig
- lsig - LogicSig
txidstringqueryLookup the specific transaction by ID.
roundintegerqueryInclude results for the specified round.
min-roundintegerqueryInclude results at or after the specified min-round.
max-roundintegerqueryInclude results at or before the specified max-round.
before-timestring<date-time>queryInclude results before the given time. Must be an RFC 3339 formatted string.
after-timestring<date-time>queryInclude results after the given time. Must be an RFC 3339 formatted string.
currency-greater-thanintegerqueryResults should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
currency-less-thanintegerqueryResults should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
addressstringqueryOnly include transactions with this address in one of the transaction fields.
address-rolestringsenderreceiverfreeze-targetqueryCombine with the address parameter to define what type of address to search for.
exclude-close-tobooleanqueryCombine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true.
asset-idintegerrequiredpathrekey-tobooleanqueryInclude results which include the rekey-to field.
Response
(empty)
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerBlocks
Lookup block.
Parameters
round-numberintegerrequiredpathRound number
header-onlybooleanqueryHeader only flag. When this is set to true, returned block does not contain the transactions
Response
(empty)
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerTransactions
Search for transactions. Transactions are returned oldest to newest unless the address parameter is used, in which case results are returned newest to oldest.
Parameters
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
note-prefixstringquerySpecifies a prefix which must be contained in the note field.
tx-typestringpaykeyregacfgaxferafrzapplstpfquerysig-typestringsigmsiglsigquerySigType filters just results using the specified type of signature:
- sig - Standard
- msig - MultiSig
- lsig - LogicSig
txidstringqueryLookup the specific transaction by ID.
roundintegerqueryInclude results for the specified round.
min-roundintegerqueryInclude results at or after the specified min-round.
max-roundintegerqueryInclude results at or before the specified max-round.
asset-idintegerqueryAsset ID
before-timestring<date-time>queryInclude results before the given time. Must be an RFC 3339 formatted string.
after-timestring<date-time>queryInclude results after the given time. Must be an RFC 3339 formatted string.
currency-greater-thanintegerqueryResults should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
currency-less-thanintegerqueryResults should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
addressstringqueryOnly include transactions with this address in one of the transaction fields.
address-rolestringsenderreceiverfreeze-targetqueryCombine with the address parameter to define what type of address to search for.
exclude-close-tobooleanqueryCombine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true.
rekey-tobooleanqueryInclude results which include the rekey-to field.
application-idintegerqueryApplication ID
Response
(empty)
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in headerLookup a single transaction.
Parameters
txidstringrequiredpathResponse
(empty)
Response for errors
Response for errors
Response for errors
Authorization
api-keyAuthapiKey in header