Algorand public API is one of 15 APIs that Algorand publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Public. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
44 operations
across 43 paths,
and defines 56 schemas.
It is described by OpenAPI 3.2.0, at version 0.0.1.
Requests are made against 2 base URLs: http://localhost/, https://localhost/.
The identity and technical contract details declared by the specification.
BuildVersion
object
6 properties
6 required
TealKeyValue
object
Represents a key-value pair in an application store.
2 properties
2 required
GenesisAllocation
object
3 properties
3 required
AccountParticipation
object
AccountParticipation describes the parameters used by this account in consensus protocol.
6 properties
5 required
AccountApplicationResource
object
AccountApplicationResource describes the account's application resource (local state and params if the account is the creator) for a specific application ID.
5 properties
1 required
AppCallLogs
object
The logged messages from an app call along with the app ID and outer transaction ID. Logs appear in the same order that they were emitted.
3 properties
3 required
TealKeyValueStore
array
Represents a key-value store for use in an application.
SimulateTraceConfig
object
An object that configures simulation execution trace.
4 properties
SimulationOpcodeTraceUnit
object
The set of trace information and effect from evaluating a single opcode.
6 properties
1 required
LightBlockHeaderProof
object
Proof of membership and position of a light block header.
3 properties
3 required
SimulateTransactionResult
object
Simulation result for an individual transaction
6 properties
1 required
AvmValue
object
Represents an AVM value.
3 properties
1 required
StateDelta
array
Application state delta.
SimulateRequest
object
Request type for simulation endpoint.
8 properties
1 required
ApplicationLocalReference
object
References an account's local state for an application.
2 properties
2 required
ApplicationParams
object
Stores the global information associated with an application.
9 properties
3 required
ApplicationKVStorage
object
An application's global/local/box state.
2 properties
1 required
StateProof
object
Represents a state proof and its corresponding message
2 properties
2 required
ApplicationLocalState
object
Stores local state associated with an application.
3 properties
2 required
ScratchChange
object
A write operation into a scratch slot.
2 properties
2 required
LedgerStateDelta
object
Ledger StateDelta object
ApplicationStateSchema
object
Specifies maximums on the number of each type that may be stored.
2 properties
2 required
Asset
object
Specifies both the unique identifier and the parameters for an asset
2 properties
1 required
BoxReference
object
References a box of an application.
2 properties
2 required
Genesis
object
9 properties
7 required
ApplicationStateOperation
object
An operation against an application's global/local/box state.
5 properties
3 required
TransactionProof
object
Proof of transaction in a block.
5 properties
5 required
AssetParams
object
AssetParams specifies the parameters for an asset. \[apar\] when part of an AssetConfig transaction. Definition: data/transactions/asset.go : AssetParams
15 properties
3 required
Version
object
algod version information.
4 properties
4 required
DryrunSource
object
DryrunSource is TEAL source text that gets uploaded, compiled, and inserted into transactions or application state.
4 properties
4 required
DryrunTxnResult
object
DryrunTxnResult contains any LogicSig or ApplicationCall program debug information and state updates from a dryrun.
11 properties
1 required
ApplicationInitialStates
object
An application's initial global/local/box states that were accessed during simulation.
4 properties
1 required
AccountStateDelta
object
Application state delta.
2 properties
2 required
Box
object
Box name and its content.
3 properties
3 required
ErrorResponse
object
An error response with optional data field.
2 properties
1 required
StateProofMessage
object
Represents the message that the state proofs are attesting to.
5 properties
5 required
LedgerStateDeltaForTransactionGroup
object
Contains a ledger delta for a single transaction group
2 properties
2 required
Application
object
Application index and its parameters
2 properties
1 required
SimulationTransactionExecTrace
object
The execution trace of calling an app or a logic sig, containing the inner app call trace in a recursive way.
9 properties
DryrunState
object
Stores the TEAL eval step data
5 properties
3 required
BoxDescriptor
object
Box descriptor describes a Box.
2 properties
1 required
EvalDeltaKeyValue
object
Key-value pairs for StateDelta.
2 properties
2 required
SimulateInitialStates
object
Initial states of resources that were accessed during simulation.
1 property
SimulationEvalOverrides
object
The set of parameters and limits override during simulation. If this set of parameters is present, then evaluation parameters may differ from standard evaluati…
6 properties
AssetHolding
object
Describes an asset held by an account. Definition: data/basics/userBalance.go : AssetHolding
3 properties
3 required
TealValue
object
Represents a TEAL value.
3 properties
3 required
AccountAssetHolding
object
AccountAssetHolding describes the account's asset holding and asset parameters (if either exist) for a specific asset ID.
2 properties
1 required
DryrunRequest
object
Request data type for dryrun endpoint. Given the Transactions and simulated ledger state upload, run TEAL scripts and return debugging information.
7 properties
7 required
PendingTransactionResponse
object
Details about a pending transaction. If the transaction was recently confirmed, includes confirmation details like the round and reward details.
14 properties
2 required
SimulateRequestTransactionGroup
object
A transaction group to simulate.
1 property
1 required
AssetHoldingReference
object
References an asset held by an account.
2 properties
2 required
EvalDelta
object
Represents a TEAL value delta.
3 properties
1 required
SimulateUnnamedResourcesAccessed
object
These are resources that were accessed by this group that would normally have caused failure, but were allowed in simulation. Depending on where this object is…
7 properties
AvmKeyValue
object
Represents an AVM key-value pair in an application store.
2 properties
2 required
Account
object
Account information at a given round. Definition: data/basics/userBalance.go : AccountData
27 properties
12 required
SimulateTransactionGroupResult
object
Simulation result for an atomic transaction group
6 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Algorand publishes across the network.
