Skip to content

Algorand Developer Portal

GitHub Discord X YouTube

Getting Started
Concepts
- Accounts
- Transactions
- Assets
  - Overview
  - Asset Operations
- Smart Contracts
- Consensus Protocol
Build With AlgoKit
- Intro to AlgoKit
- CLI Tools
  - Overview
  - Compile
  - Completions
  - Config
  - TestNet Dispenser
  - Doctor
  - Explore
  - Generate
  - Goal
  - Init
  - Localnet
  - Project
    
    Overview
    Bootstrap
    Deploy
    Link
    List
    Run
  - Tasks
    
    Overview
    Analyze
    IPFS
    Mint
    NFD Lookup
    Asset opt-(in|out)
    Send
    Sign
    Transfer
    Vanity Address
    Wallet
- LORA the Explorer
  - Overview
- Project Templates
- AlgoKit Utils
- Smart Contract Languages
  - Algorand TypeScript
    
    Overview
    Language Guide
    Program Structure
    Basic Types
    Storage
    Ops
    Guiding Principles
    Migration Guides
  - Algorand Python
    
    Overview
    Migration Guide v4.x to 5.0
    Language Guide
    Guiding Principles
    Program Structure
    Types
    Control Flow Structures
    Module Level Constructs
    Python Built-Ins
    Error Handling and Assertions
    Data Structures
    Storing Data On-Chain
    Logging
    Transactions
    AVM Operations
    Opcode Budgets
    ARC-4: Application Binary Interface
    ARC-28: Structured Event Logging
    Calling Other Applicaitons
    Compiling to AVM bytecode
    Unsupported Python Features
- Unit Testing
  - TypeScript Unit Testing
    
    Overview
    Concepts
    AVM Types
    ARC4 Types
    Transactions
    Smart Contract Testing
    Smart Signature Testing
    State Management
    AVM Opcodes
  - Python Unit Testing
    
    Overview
    Concepts
    AVM Types
    ARC4 Types
    Transactions
    Smart Contract Testing
    Smart Signature Testing
    State Management
    Subroutines
    AVM Opcodes
- AVM Debugger
  - Overview
- Language Servers
  - Algorand Python
  - Algorand TypeScript
- Subscriber
  - Subscriber TypeScript
    
    Overview
    Subscriber
    Subscriptions
    v3 Migration Guide
  - Subscriber Python
    
    Overview
    Subsciber
    Subscriptions
- Client Generators
  - Typescript
  - Python
Running A Node
- Overview
- NodeKit Overview
- NodeKit Quick Start
- Node Types
- Direct Installation
- Node Management
- Node Reference
- NodeKit Reference
Reference
- Algorand Python
  - API Reference
  - algopy
  - algopy.arc4
  - algopy.gtxn
  - algopy.itxn
  - algopy.op
  - Front-end Guide
    
    Building a front end for Puya
    Introduction
    Calling puya
    Designing a language
    Parsing
    AWST build
- Algorand Typescript
  - Overview
  - arc4
    
    -internal-
    
    classes
    
    Arc4ArrayBase
    StructBase
    
    Overview
    
    type-aliases
    
    AnyFunction
    BigUintBitSize
    CompatForArc4Int
    InstanceMethod
    StructConstructor
    UintBitSize
    
    classes
    
    Address
    ARC4Encoded
    Bool
    Byte
    Contract
    DynamicArray
    DynamicBytes
    StaticArray
    StaticBytes
    Str
    Tuple
    UFixed
    Uint
    Uint128
    Uint16
    Uint256
    Uint32
    Uint64
    Uint8
    
    functions
    
    abiCall
    abimethod
    baremethod
    compileArc4
    convertBytes
    decodeArc4
    encodeArc4
    methodSelector
    readonly
    sizeOf
    
    interfaces
    
    AbiCallOptions
    ConventionalRouting
    
    type-aliases
    
    AbiCallResponse
    AbiMethodConfig
    BareCreateApplicationCallFields
    BareMethodConfig
    BitSize
    ContractProxy
    ContractProxyMethod
    CreateOptions
    DefaultArgument
    GtxnToItxnFields
    ResourceEncodingOptions
    TypedApplicationArg
    TypedApplicationArgs
    TypedApplicationCallFields
    TypedApplicationCallResponse
    ValidateEncodingOptions
    
    variables
    
    Struct
  - gtxn
    
    namespaces
    
    gtxn
    
    functions
    
    ApplicationCallTxn
    AssetConfigTxn
    AssetFreezeTxn
    AssetTransferTxn
    KeyRegistrationTxn
    PaymentTxn
    Transaction
    
    interfaces
    
    ApplicationCallTxn
    AssetConfigTxn
    AssetFreezeTxn
    AssetTransferTxn
    KeyRegistrationTxn
    PaymentTxn
    
    Overview
    
    type-aliases
    
    Transaction
  - index
    
    -internal-
    
    interfaces
    
    CreateBoxMapOptions
    CreateBoxOptions
    
    Overview
    
    type-aliases
    
    ComparisonFor
    ConstructorFor
    ContractOptions
    DeliberateAny
    LogicSigOptions
    MatchTest
    NonNumericComparison
    NumberRange
    NumberRange
    NumericComparison
    StateTotals
    ToFixedBytesOptions
    _TupleOf
    
    classes
    
    BaseContract
    FixedArray
    LogicSig
    ReferenceArray
    
    enumerations
    
    OnCompleteAction
    OpUpFeeSource
    TransactionType
    
    functions
    
    Account
    Application
    assert
    assertMatch
    Asset
    BigUint
    Box
    BoxMap
    Bytes
    clone
    compile
    contract
    emit
    ensureBudget
    err
    GlobalState
    LocalState
    log
    logicsig
    match
    TemplateVar
    Uint64
    urange
    validateEncoding
    
    interfaces
    
    AnyTransactionComposeFields
    ApplicationCallComposeFields
    AssetConfigComposeFields
    AssetFreezeComposeFields
    AssetTransferComposeFields
    BytesBacked
    KeyRegistrationComposeFields
    PaymentComposeFields
    
    namespaces
    
    Bytes
    
    functions
    
    fromBase32
    fromBase64
    fromHex
    
    Overview
    
    type-aliases
    
    Account
    Application
    Asset
    biguint
    BigUintCompat
    Box
    BoxMap
    bytes
    BytesCompat
    CompileContractOptions
    CompiledContract
    CompiledLogicSig
    CompileLogicSigOptions
    ComposeItxnParams
    GlobalState
    GlobalStateOptions
    ItxnCompose
    LocalState
    LocalStateForAccount
    LocalStateOptions
    NTuple
    OnCompleteActionStr
    StringCompat
    uint64
    Uint64Compat
    
    variables
    
    itxnCompose
  - itxn
    
    namespaces
    
    itxn
    
    classes
    
    ApplicationCallItxnParams
    AssetConfigItxnParams
    AssetFreezeItxnParams
    AssetTransferItxnParams
    KeyRegistrationItxnParams
    PaymentItxnParams
    
    functions
    
    applicationCall
    assetConfig
    assetFreeze
    assetTransfer
    keyRegistration
    payment
    submitGroup
    
    interfaces
    
    ApplicationCallFields
    ApplicationCallInnerTxn
    AssetConfigFields
    AssetConfigInnerTxn
    AssetFreezeFields
    AssetFreezeInnerTxn
    AssetTransferFields
    AssetTransferInnerTxn
    KeyRegistrationFields
    KeyRegistrationInnerTxn
    PaymentFields
    PaymentInnerTxn
    
    Overview
    
    type-aliases
    
    ItxnParams
    TxnFor
  - op
    
    enumerations
    
    Base64
    Ec
    Ecdsa
    MimcConfigurations
    VrfVerify
    
    functions
    
    addw
    appOptedIn
    arg
    balance
    base64Decode
    bitLength
    bsqrt
    btoi
    bzero
    concat
    divmodw
    divw
    ecdsaPkDecompress
    ecdsaPkRecover
    ecdsaVerify
    ed25519verify
    ed25519verifyBare
    exp
    expw
    extract
    extractUint16
    extractUint32
    extractUint64
    falconVerify
    gaid
    getBit
    getByte
    gloadBytes
    gloadUint64
    itob
    keccak256
    len
    mimc
    minBalance
    mulw
    onlineStake
    replace
    select
    setBit
    setByte
    sha256
    sha3_256
    sha512_256
    shl
    shr
    sqrt
    substring
    sumhash512
    vrfVerify
    
    variables
    
    AcctParams
    AppGlobal
    AppLocal
    AppParams
    AssetHolding
    AssetParams
    Block
    Box
    EllipticCurve
    GITxn
    Global
    GTxn
    ITxn
    ITxnCreate
    JsonRef
    Scratch
    Txn
    VoterParams
- AlgoKit CLI
  - Command Reference
- AlgoKit Utils (Python)
  - Index
  - accounts
    
    Index
    
    account_manager
    
    Index
    
    kmd_account_manager
    
    Index
  - algorand
    
    Index
  - applications
    
    Index
    
    abi
    
    Index
    
    app_client
    
    Index
    
    app_deployer
    
    Index
    
    app_factory
    
    Index
    
    app_manager
    
    Index
    
    app_spec
    
    Index
    
    arc32
    
    Index
    
    arc56
    
    Index
    
    enums
    
    Index
  - assets
    
    Index
    
    asset_manager
    
    Index
  - clients
    
    Index
    
    client_manager
    
    Index
    
    dispenser_api_client
    
    Index
  - config
    
    Index
  - errors
    
    Index
    
    logic_error
    
    Index
  - models
    
    Index
    
    account
    
    Index
    
    amount
    
    Index
    
    application
    
    Index
    
    network
    
    Index
    
    simulate
    
    Index
    
    state
    
    Index
    
    transaction
    
    Index
  - protocols
    
    Index
    
    account
    
    Index
    
    typed_clients
    
    Index
  - transactions
    
    Index
    
    transaction_composer
    
    Index
    
    transaction_creator
    
    Index
    
    transaction_sender
    
    Index
- AlgoKit Utils (Typescript)
- Algorand TEAL
  - AVM Opcodes
- SDK
  - Algorand SDK List
- REST API
- ARC Standards
Bulletins
- Disclosure of Vulnerabilities in Puya Smart Contract Compiler
Additional Resources

GitHub Discord X YouTube

On this page

Overview
Authorizations
Responses
- 200
- default

On this page

Overview
Authorizations
Responses
- 200
- default

Returns OK if healthy.

GET

/health

Authorizations

Section titled “Authorizations ”

api_key

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK.

default

Section titled “default ”

Unknown Error