Skip to content
Algorand Developer Portal
Search
Ctrl
K
Cancel
GitHub
Getting Started
Blockchain 101
Owner
Why Algorand?
Intro To AlgoKit
Concepts
Accounts
Overview
Creating Accounts
Funding Accounts
Keys & Signing
Rekeying Accounts
WIP
Multisignature Accounts
WIP
Transactions
Overview
Transaction Types
Atomic Transaction Groups
Signing Transactions
Blocks
Leases
URI Scheme
Assets
Overview
Creating Assets
Opting In & Out
Updating Assets
Transferring Assets
Deleting Assets
Clawing Back Assets
Freezing Assets
Known Assets
Smart Contracts
Overview
Languages
Python
Typescript
TEAL
Applications
ABI
Control Flow
Resource Usage
Costs & Constraints
Data Storage
Overview
Local Storage
Global Storage
Box Storage
Scratch Space
Encoding/Decoding
Development Lifecycle
Running A Node
Overview
NodeKit Overview
NodeKit Quick Start
Node Types
Direct Installation
Manual Installation
Catchup & Status
Indexer Installation
Conduit Installation
Node Troubleshooting
Node Management
Best Practices
Software Updates
Switching Networks
Node Reference
Node Artifacts
Configuration Settings
Relay Node Configuration
Telemetry Configuration
NodeKit Reference
Consensus Protocol
Overview
Participation Key Management
Account Registration
Staking Rewards
State Proofs
Networks
Reference
AlgoKit CLI
Project Tools
Configuration
App Compilation
Client Generation
Testnet Funding
Explorer
Node Operations
Tasks
CLI Reference
Algorand Python
Algorand Typescript
Algorand TEAL
AlgoKit Utils (Python)
Fundamentals
Client
Transactions
Accounts
Assets
Amount Handling
Smart Contracts
App Clients
Interactions & State
Deployment
Network
Environments
Network Clients
Testnet Dispenser
Indexer Operations
Development Tools
Testing
Debugging
Logging
AlgoKit Utils (Typescript)
Fundamentals
Client
Transactions
Accounts
Assets
Amount Handling
Smart Contracts
App Clients
Interactions & State
Deployment
Network
Environments
Network Clients
Testnet Dispenser
Indexer Operations
Development Tools
Testing
Debugging
Logging
REST API
Overview
API Endpoints
algod
Overview
private
Gets the merged config file.
GetDebugSettingsProf
PutDebugSettingsProf
Starts a catchpoint catchup.
Aborts a catchpoint catchup.
Return a list of participation keys
Add a participation key to the node
Generate and install participation keys to the node.
Get participation key info given a participation ID
Append state proof keys to a participation key
Delete a given participation key by ID
ShutdownNode
public
Gets the genesis information.
Returns OK if healthy.
Return metrics about algod functioning.
Returns OK if healthy and fully caught up.
Gets the current swagger spec.
Get account information.
Get account information about a given app.
Get a list of assets held by an account, inclusive of asset params.
Get account information about a given asset.
Get a list of unconfirmed transactions currently in the transaction pool by address.
Get application information.
Get box information for a given application.
Get all box names for a given application.
Get asset information.
Get the block for the given round.
Get the block hash for the block on the given round.
Gets a proof for a given light block header inside a state proof commitment
Get all of the logs from outer and inner app calls in the given round
Get a proof for a transaction in a block.
Get the top level transaction IDs for the block on the given round.
Get a LedgerStateDelta object for a given transaction group
Get a LedgerStateDelta object for a given round
Get LedgerStateDelta objects for all transaction groups in a given round
Returns the timestamp offset. Timestamp offsets can only be set in dev mode.
Given a timestamp offset in seconds, adds the offset to every subsequent block header's timestamp.
Returns OK if experimental API is enabled.
Get the current supply reported by the ledger.
Returns the minimum sync round the ledger is keeping in cache.
Removes minimum sync round restriction from the ledger.
Given a round, tells the ledger to keep that round in its cache.
Get a state proof that covers a given round
Gets the current node status.
Gets the node status after waiting for a round after the given round.
Compile TEAL source code to binary, produce its hash
Disassemble program bytes into the TEAL source code.
Provide debugging information for a transaction (or group).
Broadcasts a raw transaction or transaction group to the network.
Fast 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.
Get parameters for constructing a new transaction
Get a list of unconfirmed transactions currently in the transaction pool.
Get a specific pending transaction.
Simulates 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.
GetVersion
common
Gets the genesis information.
Returns OK if healthy.
Return metrics about algod functioning.
Returns OK if healthy and fully caught up.
Gets the current swagger spec.
GetVersion
nonparticipating
Get account information.
Get account information about a given app.
Get account information about a given asset.
Get application information.
Get box information for a given application.
Get all box names for a given application.
Get asset information.
Get the block for the given round.
Get the block hash for the block on the given round.
Gets a proof for a given light block header inside a state proof commitment
Get all of the logs from outer and inner app calls in the given round
Get a proof for a transaction in a block.
Get the top level transaction IDs for the block on the given round.
Starts a catchpoint catchup.
Aborts a catchpoint catchup.
Get a LedgerStateDelta object for a given transaction group
Get a LedgerStateDelta object for a given round
Get LedgerStateDelta objects for all transaction groups in a given round
Returns the timestamp offset. Timestamp offsets can only be set in dev mode.
Given a timestamp offset in seconds, adds the offset to every subsequent block header's timestamp.
Get the current supply reported by the ledger.
ShutdownNode
Get a state proof that covers a given round
Gets the current node status.
Gets the node status after waiting for a round after the given round.
Compile TEAL source code to binary, produce its hash
Disassemble program bytes into the TEAL source code.
Provide debugging information for a transaction (or group).
Get parameters for constructing a new transaction
Simulates 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.
experimental
Get a list of assets held by an account, inclusive of asset params.
Returns OK if experimental API is enabled.
Fast 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.
participating
Get a list of unconfirmed transactions currently in the transaction pool by address.
Return a list of participation keys
Add a participation key to the node
Generate and install participation keys to the node.
Get participation key info given a participation ID
Append state proof keys to a participation key
Delete a given participation key by ID
Broadcasts a raw transaction or transaction group to the network.
Get a list of unconfirmed transactions currently in the transaction pool.
Get a specific pending transaction.
data
Returns the minimum sync round the ledger is keeping in cache.
Removes minimum sync round restriction from the ledger.
Given a round, tells the ledger to keep that round in its cache.
indexer
Overview
common
Returns 200 if healthy.
lookup
lookupAccountByID
lookupAccountAppLocalStates
lookupAccountAssets
lookupAccountCreatedApplications
lookupAccountCreatedAssets
lookupAccountTransactions
lookupApplicationByID
Get box information for a given application.
lookupApplicationLogsByID
lookupAssetByID
lookupAssetBalances
lookupAssetTransactions
lookupBlock
lookupTransaction
search
searchForAccounts
searchForApplications
Get box names for a given application.
searchForAssets
searchForBlockHeaders
searchForTransactions
kmd
Overview
Operations
Gets the current swagger spec.
Generate a key
Delete a key
Export a key
Import a key
List keys in wallet
Export the master derivation key from a wallet
Delete a multisig
Export multisig address metadata
Import a multisig account
List multisig accounts
Sign a multisig transaction
Sign a program for a multisig account
Sign program
Sign a transaction
Create a wallet
Get wallet info
Initialize a wallet handle token
Release a wallet handle token
Rename a wallet
Renew a wallet handle token
List wallets
Retrieves the current version
GitHub
This new developer portal is under construction. For complete documentation, please refer to the
old developer portal
.
Returns OK if healthy and fully caught up.
GET
/ready
Authorizations
api_key
Responses
200
OK.
500
Internal Error
503
Node not ready yet
default
Unknown Error
