Skip to content
@algofam/algo-fetch

$OpenApiTs

$OpenApiTs: object

Type declaration

/debug/settings/pprof

/debug/settings/pprof: object

/debug/settings/pprof.get

/debug/settings/pprof.get: object

/debug/settings/pprof.get.res

/debug/settings/pprof.get.res: object

/debug/settings/pprof.get.res.200

/debug/settings/pprof.get.res.200: DebugSettingsProf

DebugPprof is the response to the /debug/extra/pprof endpoint

/debug/settings/pprof.put

/debug/settings/pprof.put: object

/debug/settings/pprof.put.res

/debug/settings/pprof.put.res: object

/debug/settings/pprof.put.res.200

/debug/settings/pprof.put.res.200: DebugSettingsProf

DebugPprof is the response to the /debug/extra/pprof endpoint

/genesis

/genesis: object

/genesis.get

/genesis.get: object

/genesis.get.res

/genesis.get.res: object

/genesis.get.res.200

/genesis.get.res.200: string

The genesis file in json.

/genesis.get.res.default

/genesis.get.res.default: unknown

Unknown Error

/health

/health: object

/health.get

/health.get: object

/health.get.res

/health.get.res: object

/health.get.res.200

/health.get.res.200: unknown

OK.

/health.get.res.default

/health.get.res.default: unknown

Unknown Error

/metrics

/metrics: object

/metrics.get

/metrics.get: object

/metrics.get.res

/metrics.get.res: object

/metrics.get.res.200

/metrics.get.res.200: unknown

text with #-comments and key:value lines

/metrics.get.res.404

/metrics.get.res.404: unknown

metrics were compiled out

/ready

/ready: object

/ready.get

/ready.get: object

/ready.get.res

/ready.get.res: object

/ready.get.res.200

/ready.get.res.200: unknown

OK.

/ready.get.res.500

/ready.get.res.500: unknown

Internal Error

/ready.get.res.503

/ready.get.res.503: unknown

Node not ready yet

/ready.get.res.default

/ready.get.res.default: unknown

Unknown Error

/swagger.json

/swagger.json: object

/swagger.json.get

/swagger.json.get: object

/swagger.json.get.res

/swagger.json.get.res: object

/swagger.json.get.res.200

/swagger.json.get.res.200: string

The current swagger spec

/swagger.json.get.res.default

/swagger.json.get.res.default: unknown

Unknown Error

/v2/accounts/{address}

/v2/accounts/{address}: object

/v2/accounts/{address}.get

/v2/accounts/{address}.get: object

/v2/accounts/{address}.get.req

/v2/accounts/{address}.get.req: AccountInformationData

/v2/accounts/{address}.get.res

/v2/accounts/{address}.get.res: object

/v2/accounts/{address}.get.res.200

/v2/accounts/{address}.get.res.200: Account

AccountResponse wraps the Account type in a response.

/v2/accounts/{address}.get.res.400

/v2/accounts/{address}.get.res.400: ErrorResponse

Bad request

/v2/accounts/{address}.get.res.401

/v2/accounts/{address}.get.res.401: ErrorResponse

Invalid API Token

/v2/accounts/{address}.get.res.500

/v2/accounts/{address}.get.res.500: ErrorResponse

Internal Error

/v2/accounts/{address}.get.res.default

/v2/accounts/{address}.get.res.default: unknown

Unknown Error

/v2/accounts/{address}/applications/{application-id}

/v2/accounts/{address}/applications/{application-id}: object

/v2/accounts/{address}/applications/{application-id}.get

/v2/accounts/{address}/applications/{application-id}.get: object

/v2/accounts/{address}/applications/{application-id}.get.req

/v2/accounts/{address}/applications/{application-id}.get.req: AccountApplicationInformationData

/v2/accounts/{address}/applications/{application-id}.get.res

/v2/accounts/{address}/applications/{application-id}.get.res: object

/v2/accounts/{address}/applications/{application-id}.get.res.200

/v2/accounts/{address}/applications/{application-id}.get.res.200: object

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.

/v2/accounts/{address}/applications/{application-id}.get.res.200.app-local-state?

optional /v2/accounts/{address}/applications/{application-id}.get.res.200.app-local-state: ApplicationLocalState

/v2/accounts/{address}/applications/{application-id}.get.res.200.created-app?

optional /v2/accounts/{address}/applications/{application-id}.get.res.200.created-app: ApplicationParams

/v2/accounts/{address}/applications/{application-id}.get.res.200.round

/v2/accounts/{address}/applications/{application-id}.get.res.200.round: number

The round for which this information is relevant.

/v2/accounts/{address}/applications/{application-id}.get.res.400

/v2/accounts/{address}/applications/{application-id}.get.res.400: ErrorResponse

Malformed address or application ID

/v2/accounts/{address}/applications/{application-id}.get.res.401

/v2/accounts/{address}/applications/{application-id}.get.res.401: ErrorResponse

Invalid API Token

/v2/accounts/{address}/applications/{application-id}.get.res.500

/v2/accounts/{address}/applications/{application-id}.get.res.500: ErrorResponse

Internal Error

/v2/accounts/{address}/applications/{application-id}.get.res.default

/v2/accounts/{address}/applications/{application-id}.get.res.default: unknown

Unknown Error

/v2/accounts/{address}/assets

/v2/accounts/{address}/assets: object

/v2/accounts/{address}/assets.get

/v2/accounts/{address}/assets.get: object

/v2/accounts/{address}/assets.get.req

/v2/accounts/{address}/assets.get.req: AccountAssetsInformationData

/v2/accounts/{address}/assets.get.res

/v2/accounts/{address}/assets.get.res: object

/v2/accounts/{address}/assets.get.res.200

/v2/accounts/{address}/assets.get.res.200: object

AccountAssetsInformationResponse contains a list of assets held by an account.

/v2/accounts/{address}/assets.get.res.200.asset-holdings?

optional /v2/accounts/{address}/assets.get.res.200.asset-holdings: AccountAssetHolding[]

/v2/accounts/{address}/assets.get.res.200.next-token?

optional /v2/accounts/{address}/assets.get.res.200.next-token: string

Used for pagination, when making another request provide this token with the next parameter.

/v2/accounts/{address}/assets.get.res.200.round

/v2/accounts/{address}/assets.get.res.200.round: number

The round for which this information is relevant.

/v2/accounts/{address}/assets.get.res.400

/v2/accounts/{address}/assets.get.res.400: ErrorResponse

Malformed address

/v2/accounts/{address}/assets.get.res.401

/v2/accounts/{address}/assets.get.res.401: ErrorResponse

Invalid API Token

/v2/accounts/{address}/assets.get.res.500

/v2/accounts/{address}/assets.get.res.500: ErrorResponse

Internal Error

/v2/accounts/{address}/assets.get.res.default

/v2/accounts/{address}/assets.get.res.default: unknown

Unknown Error

/v2/accounts/{address}/assets/{asset-id}

/v2/accounts/{address}/assets/{asset-id}: object

/v2/accounts/{address}/assets/{asset-id}.get

/v2/accounts/{address}/assets/{asset-id}.get: object

/v2/accounts/{address}/assets/{asset-id}.get.req

/v2/accounts/{address}/assets/{asset-id}.get.req: AccountAssetInformationData

/v2/accounts/{address}/assets/{asset-id}.get.res

/v2/accounts/{address}/assets/{asset-id}.get.res: object

/v2/accounts/{address}/assets/{asset-id}.get.res.200

/v2/accounts/{address}/assets/{asset-id}.get.res.200: object

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.

/v2/accounts/{address}/assets/{asset-id}.get.res.200.asset-holding?

optional /v2/accounts/{address}/assets/{asset-id}.get.res.200.asset-holding: AssetHolding

/v2/accounts/{address}/assets/{asset-id}.get.res.200.created-asset?

optional /v2/accounts/{address}/assets/{asset-id}.get.res.200.created-asset: AssetParams

/v2/accounts/{address}/assets/{asset-id}.get.res.200.round

/v2/accounts/{address}/assets/{asset-id}.get.res.200.round: number

The round for which this information is relevant.

/v2/accounts/{address}/assets/{asset-id}.get.res.400

/v2/accounts/{address}/assets/{asset-id}.get.res.400: ErrorResponse

Malformed address or asset ID

/v2/accounts/{address}/assets/{asset-id}.get.res.401

/v2/accounts/{address}/assets/{asset-id}.get.res.401: ErrorResponse

Invalid API Token

/v2/accounts/{address}/assets/{asset-id}.get.res.500

/v2/accounts/{address}/assets/{asset-id}.get.res.500: ErrorResponse

Internal Error

/v2/accounts/{address}/assets/{asset-id}.get.res.default

/v2/accounts/{address}/assets/{asset-id}.get.res.default: unknown

Unknown Error

/v2/accounts/{address}/transactions/pending

/v2/accounts/{address}/transactions/pending: object

/v2/accounts/{address}/transactions/pending.get

/v2/accounts/{address}/transactions/pending.get: object

/v2/accounts/{address}/transactions/pending.get.req

/v2/accounts/{address}/transactions/pending.get.req: GetPendingTransactionsByAddressData

/v2/accounts/{address}/transactions/pending.get.res

/v2/accounts/{address}/transactions/pending.get.res: object

/v2/accounts/{address}/transactions/pending.get.res.200

/v2/accounts/{address}/transactions/pending.get.res.200: object

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.

/v2/accounts/{address}/transactions/pending.get.res.200.top-transactions

/v2/accounts/{address}/transactions/pending.get.res.200.top-transactions: unknown[]

An array of signed transaction objects.

/v2/accounts/{address}/transactions/pending.get.res.200.total-transactions

/v2/accounts/{address}/transactions/pending.get.res.200.total-transactions: number

Total number of transactions in the pool.

/v2/accounts/{address}/transactions/pending.get.res.400

/v2/accounts/{address}/transactions/pending.get.res.400: ErrorResponse

Max must be a non-negative integer

/v2/accounts/{address}/transactions/pending.get.res.401

/v2/accounts/{address}/transactions/pending.get.res.401: ErrorResponse

Invalid API Token

/v2/accounts/{address}/transactions/pending.get.res.500

/v2/accounts/{address}/transactions/pending.get.res.500: ErrorResponse

Internal Error

/v2/accounts/{address}/transactions/pending.get.res.503

/v2/accounts/{address}/transactions/pending.get.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/accounts/{address}/transactions/pending.get.res.default

/v2/accounts/{address}/transactions/pending.get.res.default: unknown

Unknown Error

/v2/applications/{application-id}

/v2/applications/{application-id}: object

/v2/applications/{application-id}.get

/v2/applications/{application-id}.get: object

/v2/applications/{application-id}.get.req

/v2/applications/{application-id}.get.req: GetApplicationByIdData

/v2/applications/{application-id}.get.res

/v2/applications/{application-id}.get.res: object

/v2/applications/{application-id}.get.res.200

/v2/applications/{application-id}.get.res.200: Application

Application information

/v2/applications/{application-id}.get.res.400

/v2/applications/{application-id}.get.res.400: ErrorResponse

Bad Request

/v2/applications/{application-id}.get.res.401

/v2/applications/{application-id}.get.res.401: ErrorResponse

Invalid API Token

/v2/applications/{application-id}.get.res.404

/v2/applications/{application-id}.get.res.404: ErrorResponse

Application Not Found

/v2/applications/{application-id}.get.res.500

/v2/applications/{application-id}.get.res.500: ErrorResponse

Internal Error

/v2/applications/{application-id}.get.res.default

/v2/applications/{application-id}.get.res.default: unknown

Unknown Error

/v2/applications/{application-id}/box

/v2/applications/{application-id}/box: object

/v2/applications/{application-id}/box.get

/v2/applications/{application-id}/box.get: object

/v2/applications/{application-id}/box.get.req

/v2/applications/{application-id}/box.get.req: GetApplicationBoxByNameData

/v2/applications/{application-id}/box.get.res

/v2/applications/{application-id}/box.get.res: object

/v2/applications/{application-id}/box.get.res.200

/v2/applications/{application-id}/box.get.res.200: Box

Box information

/v2/applications/{application-id}/box.get.res.400

/v2/applications/{application-id}/box.get.res.400: ErrorResponse

Bad Request

/v2/applications/{application-id}/box.get.res.401

/v2/applications/{application-id}/box.get.res.401: ErrorResponse

Invalid API Token

/v2/applications/{application-id}/box.get.res.404

/v2/applications/{application-id}/box.get.res.404: ErrorResponse

Box Not Found

/v2/applications/{application-id}/box.get.res.500

/v2/applications/{application-id}/box.get.res.500: ErrorResponse

Internal Error

/v2/applications/{application-id}/box.get.res.default

/v2/applications/{application-id}/box.get.res.default: unknown

Unknown Error

/v2/applications/{application-id}/boxes

/v2/applications/{application-id}/boxes: object

/v2/applications/{application-id}/boxes.get

/v2/applications/{application-id}/boxes.get: object

/v2/applications/{application-id}/boxes.get.req

/v2/applications/{application-id}/boxes.get.req: GetApplicationBoxesData

/v2/applications/{application-id}/boxes.get.res

/v2/applications/{application-id}/boxes.get.res: object

/v2/applications/{application-id}/boxes.get.res.200

/v2/applications/{application-id}/boxes.get.res.200: object

Box names of an application

/v2/applications/{application-id}/boxes.get.res.200.boxes

/v2/applications/{application-id}/boxes.get.res.200.boxes: BoxDescriptor[]

/v2/applications/{application-id}/boxes.get.res.400

/v2/applications/{application-id}/boxes.get.res.400: ErrorResponse

Bad Request

/v2/applications/{application-id}/boxes.get.res.401

/v2/applications/{application-id}/boxes.get.res.401: ErrorResponse

Invalid API Token

/v2/applications/{application-id}/boxes.get.res.500

/v2/applications/{application-id}/boxes.get.res.500: ErrorResponse

Internal Error

/v2/applications/{application-id}/boxes.get.res.default

/v2/applications/{application-id}/boxes.get.res.default: unknown

Unknown Error

/v2/assets/{asset-id}

/v2/assets/{asset-id}: object

/v2/assets/{asset-id}.get

/v2/assets/{asset-id}.get: object

/v2/assets/{asset-id}.get.req

/v2/assets/{asset-id}.get.req: GetAssetByIdData

/v2/assets/{asset-id}.get.res

/v2/assets/{asset-id}.get.res: object

/v2/assets/{asset-id}.get.res.200

/v2/assets/{asset-id}.get.res.200: Asset

Asset information

/v2/assets/{asset-id}.get.res.400

/v2/assets/{asset-id}.get.res.400: ErrorResponse

Bad Request

/v2/assets/{asset-id}.get.res.401

/v2/assets/{asset-id}.get.res.401: ErrorResponse

Invalid API Token

/v2/assets/{asset-id}.get.res.404

/v2/assets/{asset-id}.get.res.404: ErrorResponse

Application Not Found

/v2/assets/{asset-id}.get.res.500

/v2/assets/{asset-id}.get.res.500: ErrorResponse

Internal Error

/v2/assets/{asset-id}.get.res.default

/v2/assets/{asset-id}.get.res.default: unknown

Unknown Error

/v2/blocks/{round}

/v2/blocks/{round}: object

/v2/blocks/{round}.get

/v2/blocks/{round}.get: object

/v2/blocks/{round}.get.req

/v2/blocks/{round}.get.req: GetBlockData

/v2/blocks/{round}.get.res

/v2/blocks/{round}.get.res: object

/v2/blocks/{round}.get.res.200

/v2/blocks/{round}.get.res.200: object

Encoded block object.

/v2/blocks/{round}.get.res.200.block

/v2/blocks/{round}.get.res.200.block: unknown

Block header data.

/v2/blocks/{round}.get.res.200.cert?

optional /v2/blocks/{round}.get.res.200.cert: unknown

Optional certificate object. This is only included when the format is set to message pack.

/v2/blocks/{round}.get.res.400

/v2/blocks/{round}.get.res.400: ErrorResponse

Bad Request - Non integer number

/v2/blocks/{round}.get.res.401

/v2/blocks/{round}.get.res.401: ErrorResponse

Invalid API Token

/v2/blocks/{round}.get.res.404

/v2/blocks/{round}.get.res.404: ErrorResponse

None existing block

/v2/blocks/{round}.get.res.500

/v2/blocks/{round}.get.res.500: ErrorResponse

Internal Error

/v2/blocks/{round}.get.res.default

/v2/blocks/{round}.get.res.default: unknown

Unknown Error

/v2/blocks/{round}/hash

/v2/blocks/{round}/hash: object

/v2/blocks/{round}/hash.get

/v2/blocks/{round}/hash.get: object

/v2/blocks/{round}/hash.get.req

/v2/blocks/{round}/hash.get.req: GetBlockHashData

/v2/blocks/{round}/hash.get.res

/v2/blocks/{round}/hash.get.res: object

/v2/blocks/{round}/hash.get.res.200

/v2/blocks/{round}/hash.get.res.200: object

Hash of a block header.

/v2/blocks/{round}/hash.get.res.200.blockHash

/v2/blocks/{round}/hash.get.res.200.blockHash: string

Block header hash.

/v2/blocks/{round}/hash.get.res.400

/v2/blocks/{round}/hash.get.res.400: ErrorResponse

Bad Request - Non integer number

/v2/blocks/{round}/hash.get.res.401

/v2/blocks/{round}/hash.get.res.401: ErrorResponse

Invalid API Token

/v2/blocks/{round}/hash.get.res.404

/v2/blocks/{round}/hash.get.res.404: ErrorResponse

None existing block

/v2/blocks/{round}/hash.get.res.500

/v2/blocks/{round}/hash.get.res.500: ErrorResponse

Internal Error

/v2/blocks/{round}/hash.get.res.default

/v2/blocks/{round}/hash.get.res.default: unknown

Unknown Error

/v2/blocks/{round}/lightheader/proof

/v2/blocks/{round}/lightheader/proof: object

/v2/blocks/{round}/lightheader/proof.get

/v2/blocks/{round}/lightheader/proof.get: object

/v2/blocks/{round}/lightheader/proof.get.req

/v2/blocks/{round}/lightheader/proof.get.req: GetLightBlockHeaderProofData

/v2/blocks/{round}/lightheader/proof.get.res

/v2/blocks/{round}/lightheader/proof.get.res: object

/v2/blocks/{round}/lightheader/proof.get.res.200

/v2/blocks/{round}/lightheader/proof.get.res.200: LightBlockHeaderProof

Proof of a light block header.

/v2/blocks/{round}/lightheader/proof.get.res.401

/v2/blocks/{round}/lightheader/proof.get.res.401: ErrorResponse

Invalid API Token

/v2/blocks/{round}/lightheader/proof.get.res.404

/v2/blocks/{round}/lightheader/proof.get.res.404: ErrorResponse

Could not create proof since some data is missing

/v2/blocks/{round}/lightheader/proof.get.res.408

/v2/blocks/{round}/lightheader/proof.get.res.408: ErrorResponse

timed out on request

/v2/blocks/{round}/lightheader/proof.get.res.500

/v2/blocks/{round}/lightheader/proof.get.res.500: ErrorResponse

Internal Error

/v2/blocks/{round}/lightheader/proof.get.res.503

/v2/blocks/{round}/lightheader/proof.get.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/blocks/{round}/lightheader/proof.get.res.default

/v2/blocks/{round}/lightheader/proof.get.res.default: unknown

Unknown Error

/v2/blocks/{round}/logs

/v2/blocks/{round}/logs: object

/v2/blocks/{round}/logs.get

/v2/blocks/{round}/logs.get: object

/v2/blocks/{round}/logs.get.req

/v2/blocks/{round}/logs.get.req: GetBlockLogsData

/v2/blocks/{round}/logs.get.res

/v2/blocks/{round}/logs.get.res: object

/v2/blocks/{round}/logs.get.res.200

/v2/blocks/{round}/logs.get.res.200: object

All logs emitted in the given round. Each app call, whether top-level or inner, that contains logs results in a separate AppCallLogs object. Therefore there may be multiple AppCallLogs with the same application ID and outer transaction ID in the event of multiple inner app calls to the same app. App calls with no logs are not included in the response. AppCallLogs are returned in the same order that their corresponding app call appeared in the block (pre-order traversal of inner app calls)

/v2/blocks/{round}/logs.get.res.200.logs

/v2/blocks/{round}/logs.get.res.200.logs: AppCallLogs[]

/v2/blocks/{round}/logs.get.res.400

/v2/blocks/{round}/logs.get.res.400: ErrorResponse

Bad Request - Non integer number

/v2/blocks/{round}/logs.get.res.401

/v2/blocks/{round}/logs.get.res.401: ErrorResponse

Invalid API Token

/v2/blocks/{round}/logs.get.res.404

/v2/blocks/{round}/logs.get.res.404: ErrorResponse

Nonexistent block

/v2/blocks/{round}/logs.get.res.500

/v2/blocks/{round}/logs.get.res.500: ErrorResponse

Internal Error

/v2/blocks/{round}/transactions/{txid}/proof

/v2/blocks/{round}/transactions/{txid}/proof: object

/v2/blocks/{round}/transactions/{txid}/proof.get

/v2/blocks/{round}/transactions/{txid}/proof.get: object

/v2/blocks/{round}/transactions/{txid}/proof.get.req

/v2/blocks/{round}/transactions/{txid}/proof.get.req: GetTransactionProofData

/v2/blocks/{round}/transactions/{txid}/proof.get.res

/v2/blocks/{round}/transactions/{txid}/proof.get.res: object

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200: object

Proof of transaction in a block.

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200.hashtype

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200.hashtype: "sha512_256" | "sha256"

The type of hash function used to create the proof, must be one of:

  • sha512_256
  • sha256

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200.idx

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200.idx: number

Index of the transaction in the block’s payset.

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200.proof

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200.proof: string

Proof of transaction membership.

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200.stibhash

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200.stibhash: string

Hash of SignedTxnInBlock for verifying proof.

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200.treedepth

/v2/blocks/{round}/transactions/{txid}/proof.get.res.200.treedepth: number

Represents the depth of the tree that is being proven, i.e. the number of edges from a leaf to the root.

/v2/blocks/{round}/transactions/{txid}/proof.get.res.400

/v2/blocks/{round}/transactions/{txid}/proof.get.res.400: ErrorResponse

Malformed round number or transaction ID

/v2/blocks/{round}/transactions/{txid}/proof.get.res.401

/v2/blocks/{round}/transactions/{txid}/proof.get.res.401: ErrorResponse

Invalid API token

/v2/blocks/{round}/transactions/{txid}/proof.get.res.404

/v2/blocks/{round}/transactions/{txid}/proof.get.res.404: ErrorResponse

Non-existent block or transaction

/v2/blocks/{round}/transactions/{txid}/proof.get.res.500

/v2/blocks/{round}/transactions/{txid}/proof.get.res.500: ErrorResponse

Internal error, including protocol not supporting proofs.

/v2/blocks/{round}/transactions/{txid}/proof.get.res.default

/v2/blocks/{round}/transactions/{txid}/proof.get.res.default: unknown

Unknown error

/v2/blocks/{round}/txids

/v2/blocks/{round}/txids: object

/v2/blocks/{round}/txids.get

/v2/blocks/{round}/txids.get: object

/v2/blocks/{round}/txids.get.req

/v2/blocks/{round}/txids.get.req: GetBlockTxidsData

/v2/blocks/{round}/txids.get.res

/v2/blocks/{round}/txids.get.res: object

/v2/blocks/{round}/txids.get.res.200

/v2/blocks/{round}/txids.get.res.200: object

Top level transaction IDs in a block.

/v2/blocks/{round}/txids.get.res.200.blockTxids

/v2/blocks/{round}/txids.get.res.200.blockTxids: string[]

Block transaction IDs.

/v2/blocks/{round}/txids.get.res.400

/v2/blocks/{round}/txids.get.res.400: ErrorResponse

Bad Request - Non integer number

/v2/blocks/{round}/txids.get.res.401

/v2/blocks/{round}/txids.get.res.401: ErrorResponse

Invalid API Token

/v2/blocks/{round}/txids.get.res.404

/v2/blocks/{round}/txids.get.res.404: ErrorResponse

Non existing block

/v2/blocks/{round}/txids.get.res.500

/v2/blocks/{round}/txids.get.res.500: ErrorResponse

Internal Error

/v2/blocks/{round}/txids.get.res.default

/v2/blocks/{round}/txids.get.res.default: unknown

Unknown Error

/v2/catchup/{catchpoint}

/v2/catchup/{catchpoint}: object

/v2/catchup/{catchpoint}.delete

/v2/catchup/{catchpoint}.delete: object

/v2/catchup/{catchpoint}.delete.req

/v2/catchup/{catchpoint}.delete.req: AbortCatchupData

/v2/catchup/{catchpoint}.delete.res

/v2/catchup/{catchpoint}.delete.res: object

/v2/catchup/{catchpoint}.delete.res.200

/v2/catchup/{catchpoint}.delete.res.200: object

/v2/catchup/{catchpoint}.delete.res.200.catchup-message

/v2/catchup/{catchpoint}.delete.res.200.catchup-message: string

Catchup abort response string

/v2/catchup/{catchpoint}.delete.res.400

/v2/catchup/{catchpoint}.delete.res.400: ErrorResponse

Bad Request

/v2/catchup/{catchpoint}.delete.res.401

/v2/catchup/{catchpoint}.delete.res.401: ErrorResponse

Invalid API Token

/v2/catchup/{catchpoint}.delete.res.500

/v2/catchup/{catchpoint}.delete.res.500: ErrorResponse

Internal Error

/v2/catchup/{catchpoint}.delete.res.default

/v2/catchup/{catchpoint}.delete.res.default: unknown

Unknown Error

/v2/catchup/{catchpoint}.post

/v2/catchup/{catchpoint}.post: object

/v2/catchup/{catchpoint}.post.req

/v2/catchup/{catchpoint}.post.req: StartCatchupData

/v2/catchup/{catchpoint}.post.res

/v2/catchup/{catchpoint}.post.res: object

/v2/catchup/{catchpoint}.post.res.200

/v2/catchup/{catchpoint}.post.res.200: object

/v2/catchup/{catchpoint}.post.res.200.catchup-message

/v2/catchup/{catchpoint}.post.res.200.catchup-message: string

Catchup start response string

/v2/catchup/{catchpoint}.post.res.201

/v2/catchup/{catchpoint}.post.res.201: object

/v2/catchup/{catchpoint}.post.res.201.catchup-message

/v2/catchup/{catchpoint}.post.res.201.catchup-message: string

Catchup start response string

/v2/catchup/{catchpoint}.post.res.400

/v2/catchup/{catchpoint}.post.res.400: ErrorResponse

Bad Request

/v2/catchup/{catchpoint}.post.res.401

/v2/catchup/{catchpoint}.post.res.401: ErrorResponse

Invalid API Token

/v2/catchup/{catchpoint}.post.res.408

/v2/catchup/{catchpoint}.post.res.408: ErrorResponse

Request Timeout

/v2/catchup/{catchpoint}.post.res.500

/v2/catchup/{catchpoint}.post.res.500: ErrorResponse

Internal Error

/v2/catchup/{catchpoint}.post.res.default

/v2/catchup/{catchpoint}.post.res.default: unknown

Unknown Error

/v2/deltas/txn/group/{id}

/v2/deltas/txn/group/{id}: object

/v2/deltas/txn/group/{id}.get

/v2/deltas/txn/group/{id}.get: object

/v2/deltas/txn/group/{id}.get.req

/v2/deltas/txn/group/{id}.get.req: GetLedgerStateDeltaForTransactionGroupData

/v2/deltas/txn/group/{id}.get.res

/v2/deltas/txn/group/{id}.get.res: object

/v2/deltas/txn/group/{id}.get.res.200

/v2/deltas/txn/group/{id}.get.res.200: LedgerStateDelta

Response containing a ledger state delta for a single transaction group.

/v2/deltas/txn/group/{id}.get.res.401

/v2/deltas/txn/group/{id}.get.res.401: ErrorResponse

Invalid API Token

/v2/deltas/txn/group/{id}.get.res.404

/v2/deltas/txn/group/{id}.get.res.404: ErrorResponse

Could not find a delta for transaction ID or group ID

/v2/deltas/txn/group/{id}.get.res.408

/v2/deltas/txn/group/{id}.get.res.408: ErrorResponse

timed out on request

/v2/deltas/txn/group/{id}.get.res.500

/v2/deltas/txn/group/{id}.get.res.500: ErrorResponse

Internal Error

/v2/deltas/txn/group/{id}.get.res.501

/v2/deltas/txn/group/{id}.get.res.501: ErrorResponse

Not Implemented

/v2/deltas/txn/group/{id}.get.res.default

/v2/deltas/txn/group/{id}.get.res.default: unknown

Unknown Error

/v2/deltas/{round}

/v2/deltas/{round}: object

/v2/deltas/{round}.get

/v2/deltas/{round}.get: object

/v2/deltas/{round}.get.req

/v2/deltas/{round}.get.req: GetLedgerStateDeltaData

/v2/deltas/{round}.get.res

/v2/deltas/{round}.get.res: object

/v2/deltas/{round}.get.res.200

/v2/deltas/{round}.get.res.200: LedgerStateDelta

Contains ledger deltas

/v2/deltas/{round}.get.res.401

/v2/deltas/{round}.get.res.401: ErrorResponse

Invalid API Token

/v2/deltas/{round}.get.res.404

/v2/deltas/{round}.get.res.404: ErrorResponse

Could not find a delta for round

/v2/deltas/{round}.get.res.408

/v2/deltas/{round}.get.res.408: ErrorResponse

timed out on request

/v2/deltas/{round}.get.res.500

/v2/deltas/{round}.get.res.500: ErrorResponse

Internal Error

/v2/deltas/{round}.get.res.503

/v2/deltas/{round}.get.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/deltas/{round}.get.res.default

/v2/deltas/{round}.get.res.default: unknown

Unknown Error

/v2/deltas/{round}/txn/group

/v2/deltas/{round}/txn/group: object

/v2/deltas/{round}/txn/group.get

/v2/deltas/{round}/txn/group.get: object

/v2/deltas/{round}/txn/group.get.req

/v2/deltas/{round}/txn/group.get.req: GetTransactionGroupLedgerStateDeltasForRoundData

/v2/deltas/{round}/txn/group.get.res

/v2/deltas/{round}/txn/group.get.res: object

/v2/deltas/{round}/txn/group.get.res.200

/v2/deltas/{round}/txn/group.get.res.200: object

Response containing all ledger state deltas for transaction groups, with their associated Ids, in a single round.

/v2/deltas/{round}/txn/group.get.res.200.Deltas

/v2/deltas/{round}/txn/group.get.res.200.Deltas: LedgerStateDeltaForTransactionGroup[]

/v2/deltas/{round}/txn/group.get.res.401

/v2/deltas/{round}/txn/group.get.res.401: ErrorResponse

Invalid API Token

/v2/deltas/{round}/txn/group.get.res.404

/v2/deltas/{round}/txn/group.get.res.404: ErrorResponse

Could not find deltas for round

/v2/deltas/{round}/txn/group.get.res.408

/v2/deltas/{round}/txn/group.get.res.408: ErrorResponse

timed out on request

/v2/deltas/{round}/txn/group.get.res.500

/v2/deltas/{round}/txn/group.get.res.500: ErrorResponse

Internal Error

/v2/deltas/{round}/txn/group.get.res.501

/v2/deltas/{round}/txn/group.get.res.501: ErrorResponse

Not Implemented

/v2/deltas/{round}/txn/group.get.res.default

/v2/deltas/{round}/txn/group.get.res.default: unknown

Unknown Error

/v2/devmode/blocks/offset

/v2/devmode/blocks/offset: object

/v2/devmode/blocks/offset.get

/v2/devmode/blocks/offset.get: object

/v2/devmode/blocks/offset.get.res

/v2/devmode/blocks/offset.get.res: object

/v2/devmode/blocks/offset.get.res.200

/v2/devmode/blocks/offset.get.res.200: object

Response containing the timestamp offset in seconds

/v2/devmode/blocks/offset.get.res.200.offset

/v2/devmode/blocks/offset.get.res.200.offset: number

Timestamp offset in seconds.

/v2/devmode/blocks/offset.get.res.400

/v2/devmode/blocks/offset.get.res.400: ErrorResponse

TimeStamp offset not set.

/v2/devmode/blocks/offset.get.res.default

/v2/devmode/blocks/offset.get.res.default: unknown

Unknown Error

/v2/devmode/blocks/offset/{offset}

/v2/devmode/blocks/offset/{offset}: object

/v2/devmode/blocks/offset/{offset}.post

/v2/devmode/blocks/offset/{offset}.post: object

/v2/devmode/blocks/offset/{offset}.post.req

/v2/devmode/blocks/offset/{offset}.post.req: SetBlockTimeStampOffsetData

/v2/devmode/blocks/offset/{offset}.post.res

/v2/devmode/blocks/offset/{offset}.post.res: object

/v2/devmode/blocks/offset/{offset}.post.res.200

/v2/devmode/blocks/offset/{offset}.post.res.200: unknown

OK

/v2/devmode/blocks/offset/{offset}.post.res.400

/v2/devmode/blocks/offset/{offset}.post.res.400: ErrorResponse

Cannot set timestamp offset to a negative integer.

/v2/devmode/blocks/offset/{offset}.post.res.401

/v2/devmode/blocks/offset/{offset}.post.res.401: ErrorResponse

Invalid API Token

/v2/devmode/blocks/offset/{offset}.post.res.500

/v2/devmode/blocks/offset/{offset}.post.res.500: ErrorResponse

Internal Error

/v2/devmode/blocks/offset/{offset}.post.res.default

/v2/devmode/blocks/offset/{offset}.post.res.default: unknown

Unknown Error

/v2/experimental

/v2/experimental: object

/v2/experimental.get

/v2/experimental.get: object

/v2/experimental.get.res

/v2/experimental.get.res: object

/v2/experimental.get.res.200

/v2/experimental.get.res.200: unknown

Experimental API enabled

/v2/experimental.get.res.404

/v2/experimental.get.res.404: unknown

Experimental API not enabled

/v2/experimental.get.res.default

/v2/experimental.get.res.default: unknown

Unknown Error

/v2/ledger/supply

/v2/ledger/supply: object

/v2/ledger/supply.get

/v2/ledger/supply.get: object

/v2/ledger/supply.get.res

/v2/ledger/supply.get.res: object

/v2/ledger/supply.get.res.200

/v2/ledger/supply.get.res.200: object

Supply represents the current supply of MicroAlgos in the system.

/v2/ledger/supply.get.res.200.current_round

/v2/ledger/supply.get.res.200.current_round: number

Round

/v2/ledger/supply.get.res.200.online-money

/v2/ledger/supply.get.res.200.online-money: number

OnlineMoney

/v2/ledger/supply.get.res.200.total-money

/v2/ledger/supply.get.res.200.total-money: number

TotalMoney

/v2/ledger/supply.get.res.401

/v2/ledger/supply.get.res.401: ErrorResponse

Invalid API Token

/v2/ledger/supply.get.res.default

/v2/ledger/supply.get.res.default: unknown

Unknown Error

/v2/ledger/sync

/v2/ledger/sync: object

/v2/ledger/sync.delete

/v2/ledger/sync.delete: object

/v2/ledger/sync.delete.res

/v2/ledger/sync.delete.res: object

/v2/ledger/sync.delete.res.200

/v2/ledger/sync.delete.res.200: unknown

/v2/ledger/sync.delete.res.400

/v2/ledger/sync.delete.res.400: ErrorResponse

Sync round not set.

/v2/ledger/sync.delete.res.401

/v2/ledger/sync.delete.res.401: ErrorResponse

Invalid API Token

/v2/ledger/sync.delete.res.500

/v2/ledger/sync.delete.res.500: ErrorResponse

Internal Error

/v2/ledger/sync.delete.res.503

/v2/ledger/sync.delete.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/ledger/sync.delete.res.default

/v2/ledger/sync.delete.res.default: unknown

Unknown Error

/v2/ledger/sync.get

/v2/ledger/sync.get: object

/v2/ledger/sync.get.res

/v2/ledger/sync.get.res: object

/v2/ledger/sync.get.res.200

/v2/ledger/sync.get.res.200: object

Response containing the ledger’s minimum sync round

/v2/ledger/sync.get.res.200.round

/v2/ledger/sync.get.res.200.round: number

The minimum sync round for the ledger.

/v2/ledger/sync.get.res.400

/v2/ledger/sync.get.res.400: ErrorResponse

Sync round not set.

/v2/ledger/sync.get.res.401

/v2/ledger/sync.get.res.401: ErrorResponse

Invalid API Token

/v2/ledger/sync.get.res.500

/v2/ledger/sync.get.res.500: ErrorResponse

Internal Error

/v2/ledger/sync.get.res.503

/v2/ledger/sync.get.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/ledger/sync.get.res.default

/v2/ledger/sync.get.res.default: unknown

Unknown Error

/v2/ledger/sync/{round}

/v2/ledger/sync/{round}: object

/v2/ledger/sync/{round}.post

/v2/ledger/sync/{round}.post: object

/v2/ledger/sync/{round}.post.req

/v2/ledger/sync/{round}.post.req: SetSyncRoundData

/v2/ledger/sync/{round}.post.res

/v2/ledger/sync/{round}.post.res: object

/v2/ledger/sync/{round}.post.res.200

/v2/ledger/sync/{round}.post.res.200: unknown

/v2/ledger/sync/{round}.post.res.400

/v2/ledger/sync/{round}.post.res.400: ErrorResponse

Can not set sync round to an earlier round than the current round.

/v2/ledger/sync/{round}.post.res.401

/v2/ledger/sync/{round}.post.res.401: ErrorResponse

Invalid API Token

/v2/ledger/sync/{round}.post.res.500

/v2/ledger/sync/{round}.post.res.500: ErrorResponse

Internal Error

/v2/ledger/sync/{round}.post.res.503

/v2/ledger/sync/{round}.post.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/ledger/sync/{round}.post.res.default

/v2/ledger/sync/{round}.post.res.default: unknown

Unknown Error

/v2/participation

/v2/participation: object

/v2/participation.get

/v2/participation.get: object

/v2/participation.get.res

/v2/participation.get.res: object

/v2/participation.get.res.200

/v2/participation.get.res.200: ParticipationKey[]

A list of participation keys

/v2/participation.get.res.400

/v2/participation.get.res.400: ErrorResponse

Bad Request

/v2/participation.get.res.401

/v2/participation.get.res.401: ErrorResponse

Invalid API Token

/v2/participation.get.res.404

/v2/participation.get.res.404: ErrorResponse

Participation Key Not Found

/v2/participation.get.res.500

/v2/participation.get.res.500: ErrorResponse

Internal Error

/v2/participation.get.res.default

/v2/participation.get.res.default: unknown

Unknown Error

/v2/participation.post

/v2/participation.post: object

/v2/participation.post.req

/v2/participation.post.req: AddParticipationKeyData

/v2/participation.post.res

/v2/participation.post.res: object

/v2/participation.post.res.200

/v2/participation.post.res.200: object

Participation ID of the submission

/v2/participation.post.res.200.partId

/v2/participation.post.res.200.partId: string

encoding of the participation ID.

/v2/participation.post.res.400

/v2/participation.post.res.400: ErrorResponse

Bad Request

/v2/participation.post.res.401

/v2/participation.post.res.401: ErrorResponse

Invalid API Token

/v2/participation.post.res.404

/v2/participation.post.res.404: ErrorResponse

Participation Key Not Found

/v2/participation.post.res.500

/v2/participation.post.res.500: ErrorResponse

Internal Error

/v2/participation.post.res.503

/v2/participation.post.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/participation.post.res.default

/v2/participation.post.res.default: unknown

Unknown Error

/v2/participation/generate/{address}

/v2/participation/generate/{address}: object

/v2/participation/generate/{address}.post

/v2/participation/generate/{address}.post: object

/v2/participation/generate/{address}.post.req

/v2/participation/generate/{address}.post.req: GenerateParticipationKeysData

/v2/participation/generate/{address}.post.res

/v2/participation/generate/{address}.post.res: object

/v2/participation/generate/{address}.post.res.200

/v2/participation/generate/{address}.post.res.200: string

An empty JSON object is returned if the generation process was started. Currently no status is available.

/v2/participation/generate/{address}.post.res.400

/v2/participation/generate/{address}.post.res.400: ErrorResponse

Bad Request

/v2/participation/generate/{address}.post.res.401

/v2/participation/generate/{address}.post.res.401: ErrorResponse

Invalid API Token

/v2/participation/generate/{address}.post.res.500

/v2/participation/generate/{address}.post.res.500: ErrorResponse

Internal Error

/v2/participation/generate/{address}.post.res.503

/v2/participation/generate/{address}.post.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/participation/generate/{address}.post.res.default

/v2/participation/generate/{address}.post.res.default: unknown

Unknown Error

/v2/participation/{participation-id}

/v2/participation/{participation-id}: object

/v2/participation/{participation-id}.delete

/v2/participation/{participation-id}.delete: object

/v2/participation/{participation-id}.delete.req

/v2/participation/{participation-id}.delete.req: DeleteParticipationKeyByIdData

/v2/participation/{participation-id}.delete.res

/v2/participation/{participation-id}.delete.res: object

/v2/participation/{participation-id}.delete.res.200

/v2/participation/{participation-id}.delete.res.200: unknown

Participation key got deleted by ID

/v2/participation/{participation-id}.delete.res.400

/v2/participation/{participation-id}.delete.res.400: ErrorResponse

Bad Request

/v2/participation/{participation-id}.delete.res.401

/v2/participation/{participation-id}.delete.res.401: ErrorResponse

Invalid API Token

/v2/participation/{participation-id}.delete.res.404

/v2/participation/{participation-id}.delete.res.404: ErrorResponse

Participation Key Not Found

/v2/participation/{participation-id}.delete.res.500

/v2/participation/{participation-id}.delete.res.500: ErrorResponse

Internal Error

/v2/participation/{participation-id}.delete.res.default

/v2/participation/{participation-id}.delete.res.default: unknown

Unknown Error

/v2/participation/{participation-id}.get

/v2/participation/{participation-id}.get: object

/v2/participation/{participation-id}.get.req

/v2/participation/{participation-id}.get.req: GetParticipationKeyByIdData

/v2/participation/{participation-id}.get.res

/v2/participation/{participation-id}.get.res: object

/v2/participation/{participation-id}.get.res.200

/v2/participation/{participation-id}.get.res.200: ParticipationKey

A detailed description of a participation ID

/v2/participation/{participation-id}.get.res.400

/v2/participation/{participation-id}.get.res.400: ErrorResponse

Bad Request

/v2/participation/{participation-id}.get.res.401

/v2/participation/{participation-id}.get.res.401: ErrorResponse

Invalid API Token

/v2/participation/{participation-id}.get.res.404

/v2/participation/{participation-id}.get.res.404: ErrorResponse

Participation Key Not Found

/v2/participation/{participation-id}.get.res.500

/v2/participation/{participation-id}.get.res.500: ErrorResponse

Internal Error

/v2/participation/{participation-id}.get.res.default

/v2/participation/{participation-id}.get.res.default: unknown

Unknown Error

/v2/participation/{participation-id}.post

/v2/participation/{participation-id}.post: object

/v2/participation/{participation-id}.post.req

/v2/participation/{participation-id}.post.req: AppendKeysData

/v2/participation/{participation-id}.post.res

/v2/participation/{participation-id}.post.res: object

/v2/participation/{participation-id}.post.res.200

/v2/participation/{participation-id}.post.res.200: ParticipationKey

A detailed description of a participation ID

/v2/participation/{participation-id}.post.res.400

/v2/participation/{participation-id}.post.res.400: ErrorResponse

Bad Request

/v2/participation/{participation-id}.post.res.401

/v2/participation/{participation-id}.post.res.401: ErrorResponse

Invalid API Token

/v2/participation/{participation-id}.post.res.404

/v2/participation/{participation-id}.post.res.404: ErrorResponse

Participation Key Not Found

/v2/participation/{participation-id}.post.res.500

/v2/participation/{participation-id}.post.res.500: ErrorResponse

Internal Error

/v2/participation/{participation-id}.post.res.default

/v2/participation/{participation-id}.post.res.default: unknown

Unknown Error

/v2/shutdown

/v2/shutdown: object

/v2/shutdown.post

/v2/shutdown.post: object

/v2/shutdown.post.req

/v2/shutdown.post.req: ShutdownNodeData

/v2/shutdown.post.res

/v2/shutdown.post.res: object

/v2/shutdown.post.res.200

/v2/shutdown.post.res.200: object

Index Signature

[key: string]: unknown

/v2/stateproofs/{round}

/v2/stateproofs/{round}: object

/v2/stateproofs/{round}.get

/v2/stateproofs/{round}.get: object

/v2/stateproofs/{round}.get.req

/v2/stateproofs/{round}.get.req: GetStateProofData

/v2/stateproofs/{round}.get.res

/v2/stateproofs/{round}.get.res: object

/v2/stateproofs/{round}.get.res.200

/v2/stateproofs/{round}.get.res.200: StateProof

StateProofResponse wraps the StateProof type in a response.

/v2/stateproofs/{round}.get.res.401

/v2/stateproofs/{round}.get.res.401: ErrorResponse

Invalid API Token

/v2/stateproofs/{round}.get.res.404

/v2/stateproofs/{round}.get.res.404: ErrorResponse

Could not find a state proof that covers a given round

/v2/stateproofs/{round}.get.res.408

/v2/stateproofs/{round}.get.res.408: ErrorResponse

timed out on request

/v2/stateproofs/{round}.get.res.500

/v2/stateproofs/{round}.get.res.500: ErrorResponse

Internal Error

/v2/stateproofs/{round}.get.res.503

/v2/stateproofs/{round}.get.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/stateproofs/{round}.get.res.default

/v2/stateproofs/{round}.get.res.default: unknown

Unknown Error

/v2/status

/v2/status: object

/v2/status.get

/v2/status.get: object

/v2/status.get.res

/v2/status.get.res: object

/v2/status.get.res.200

/v2/status.get.res.200: object

/v2/status.get.res.200.catchpoint?

optional /v2/status.get.res.200.catchpoint: string

The current catchpoint that is being caught up to

/v2/status.get.res.200.catchpoint-acquired-blocks?

optional /v2/status.get.res.200.catchpoint-acquired-blocks: number

The number of blocks that have already been obtained by the node as part of the catchup

/v2/status.get.res.200.catchpoint-processed-accounts?

optional /v2/status.get.res.200.catchpoint-processed-accounts: number

The number of accounts from the current catchpoint that have been processed so far as part of the catchup

/v2/status.get.res.200.catchpoint-processed-kvs?

optional /v2/status.get.res.200.catchpoint-processed-kvs: number

The number of key-values (KVs) from the current catchpoint that have been processed so far as part of the catchup

/v2/status.get.res.200.catchpoint-total-accounts?

optional /v2/status.get.res.200.catchpoint-total-accounts: number

The total number of accounts included in the current catchpoint

/v2/status.get.res.200.catchpoint-total-blocks?

optional /v2/status.get.res.200.catchpoint-total-blocks: number

The total number of blocks that are required to complete the current catchpoint catchup

/v2/status.get.res.200.catchpoint-total-kvs?

optional /v2/status.get.res.200.catchpoint-total-kvs: number

The total number of key-values (KVs) included in the current catchpoint

/v2/status.get.res.200.catchpoint-verified-accounts?

optional /v2/status.get.res.200.catchpoint-verified-accounts: number

The number of accounts from the current catchpoint that have been verified so far as part of the catchup

/v2/status.get.res.200.catchpoint-verified-kvs?

optional /v2/status.get.res.200.catchpoint-verified-kvs: number

The number of key-values (KVs) from the current catchpoint that have been verified so far as part of the catchup

/v2/status.get.res.200.catchup-time

/v2/status.get.res.200.catchup-time: number

CatchupTime in nanoseconds

/v2/status.get.res.200.last-catchpoint?

optional /v2/status.get.res.200.last-catchpoint: string

The last catchpoint seen by the node

/v2/status.get.res.200.last-round

/v2/status.get.res.200.last-round: number

LastRound indicates the last round seen

/v2/status.get.res.200.last-version

/v2/status.get.res.200.last-version: string

LastVersion indicates the last consensus version supported

/v2/status.get.res.200.next-version

/v2/status.get.res.200.next-version: string

NextVersion of consensus protocol to use

/v2/status.get.res.200.next-version-round

/v2/status.get.res.200.next-version-round: number

NextVersionRound is the round at which the next consensus version will apply

/v2/status.get.res.200.next-version-supported

/v2/status.get.res.200.next-version-supported: boolean

NextVersionSupported indicates whether the next consensus version is supported by this node

/v2/status.get.res.200.stopped-at-unsupported-round

/v2/status.get.res.200.stopped-at-unsupported-round: boolean

StoppedAtUnsupportedRound indicates that the node does not support the new rounds and has stopped making progress

/v2/status.get.res.200.time-since-last-round

/v2/status.get.res.200.time-since-last-round: number

TimeSinceLastRound in nanoseconds

/v2/status.get.res.200.upgrade-delay?

optional /v2/status.get.res.200.upgrade-delay: number

Upgrade delay

/v2/status.get.res.200.upgrade-next-protocol-vote-before?

optional /v2/status.get.res.200.upgrade-next-protocol-vote-before: number

Next protocol round

/v2/status.get.res.200.upgrade-no-votes?

optional /v2/status.get.res.200.upgrade-no-votes: number

No votes cast for consensus upgrade

/v2/status.get.res.200.upgrade-node-vote?

optional /v2/status.get.res.200.upgrade-node-vote: boolean

This node’s upgrade vote

/v2/status.get.res.200.upgrade-vote-rounds?

optional /v2/status.get.res.200.upgrade-vote-rounds: number

Total voting rounds for current upgrade

/v2/status.get.res.200.upgrade-votes?

optional /v2/status.get.res.200.upgrade-votes: number

Total votes cast for consensus upgrade

/v2/status.get.res.200.upgrade-votes-required?

optional /v2/status.get.res.200.upgrade-votes-required: number

Yes votes required for consensus upgrade

/v2/status.get.res.200.upgrade-yes-votes?

optional /v2/status.get.res.200.upgrade-yes-votes: number

Yes votes cast for consensus upgrade

/v2/status.get.res.401

/v2/status.get.res.401: ErrorResponse

Invalid API Token

/v2/status.get.res.500

/v2/status.get.res.500: string

Internal Error

/v2/status.get.res.default

/v2/status.get.res.default: unknown

Unknown Error

/v2/status/wait-for-block-after/{round}

/v2/status/wait-for-block-after/{round}: object

/v2/status/wait-for-block-after/{round}.get

/v2/status/wait-for-block-after/{round}.get: object

/v2/status/wait-for-block-after/{round}.get.req

/v2/status/wait-for-block-after/{round}.get.req: WaitForBlockData

/v2/status/wait-for-block-after/{round}.get.res

/v2/status/wait-for-block-after/{round}.get.res: object

/v2/status/wait-for-block-after/{round}.get.res.200

/v2/status/wait-for-block-after/{round}.get.res.200: object

/v2/status/wait-for-block-after/{round}.get.res.200.catchpoint?

optional /v2/status/wait-for-block-after/{round}.get.res.200.catchpoint: string

The current catchpoint that is being caught up to

/v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-acquired-blocks?

optional /v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-acquired-blocks: number

The number of blocks that have already been obtained by the node as part of the catchup

/v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-processed-accounts?

optional /v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-processed-accounts: number

The number of accounts from the current catchpoint that have been processed so far as part of the catchup

/v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-processed-kvs?

optional /v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-processed-kvs: number

The number of key-values (KVs) from the current catchpoint that have been processed so far as part of the catchup

/v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-total-accounts?

optional /v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-total-accounts: number

The total number of accounts included in the current catchpoint

/v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-total-blocks?

optional /v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-total-blocks: number

The total number of blocks that are required to complete the current catchpoint catchup

/v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-total-kvs?

optional /v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-total-kvs: number

The total number of key-values (KVs) included in the current catchpoint

/v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-verified-accounts?

optional /v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-verified-accounts: number

The number of accounts from the current catchpoint that have been verified so far as part of the catchup

/v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-verified-kvs?

optional /v2/status/wait-for-block-after/{round}.get.res.200.catchpoint-verified-kvs: number

The number of key-values (KVs) from the current catchpoint that have been verified so far as part of the catchup

/v2/status/wait-for-block-after/{round}.get.res.200.catchup-time

/v2/status/wait-for-block-after/{round}.get.res.200.catchup-time: number

CatchupTime in nanoseconds

/v2/status/wait-for-block-after/{round}.get.res.200.last-catchpoint?

optional /v2/status/wait-for-block-after/{round}.get.res.200.last-catchpoint: string

The last catchpoint seen by the node

/v2/status/wait-for-block-after/{round}.get.res.200.last-round

/v2/status/wait-for-block-after/{round}.get.res.200.last-round: number

LastRound indicates the last round seen

/v2/status/wait-for-block-after/{round}.get.res.200.last-version

/v2/status/wait-for-block-after/{round}.get.res.200.last-version: string

LastVersion indicates the last consensus version supported

/v2/status/wait-for-block-after/{round}.get.res.200.next-version

/v2/status/wait-for-block-after/{round}.get.res.200.next-version: string

NextVersion of consensus protocol to use

/v2/status/wait-for-block-after/{round}.get.res.200.next-version-round

/v2/status/wait-for-block-after/{round}.get.res.200.next-version-round: number

NextVersionRound is the round at which the next consensus version will apply

/v2/status/wait-for-block-after/{round}.get.res.200.next-version-supported

/v2/status/wait-for-block-after/{round}.get.res.200.next-version-supported: boolean

NextVersionSupported indicates whether the next consensus version is supported by this node

/v2/status/wait-for-block-after/{round}.get.res.200.stopped-at-unsupported-round

/v2/status/wait-for-block-after/{round}.get.res.200.stopped-at-unsupported-round: boolean

StoppedAtUnsupportedRound indicates that the node does not support the new rounds and has stopped making progress

/v2/status/wait-for-block-after/{round}.get.res.200.time-since-last-round

/v2/status/wait-for-block-after/{round}.get.res.200.time-since-last-round: number

TimeSinceLastRound in nanoseconds

/v2/status/wait-for-block-after/{round}.get.res.200.upgrade-delay?

optional /v2/status/wait-for-block-after/{round}.get.res.200.upgrade-delay: number

Upgrade delay

/v2/status/wait-for-block-after/{round}.get.res.200.upgrade-next-protocol-vote-before?

optional /v2/status/wait-for-block-after/{round}.get.res.200.upgrade-next-protocol-vote-before: number

Next protocol round

/v2/status/wait-for-block-after/{round}.get.res.200.upgrade-no-votes?

optional /v2/status/wait-for-block-after/{round}.get.res.200.upgrade-no-votes: number

No votes cast for consensus upgrade

/v2/status/wait-for-block-after/{round}.get.res.200.upgrade-node-vote?

optional /v2/status/wait-for-block-after/{round}.get.res.200.upgrade-node-vote: boolean

This node’s upgrade vote

/v2/status/wait-for-block-after/{round}.get.res.200.upgrade-vote-rounds?

optional /v2/status/wait-for-block-after/{round}.get.res.200.upgrade-vote-rounds: number

Total voting rounds for current upgrade

/v2/status/wait-for-block-after/{round}.get.res.200.upgrade-votes?

optional /v2/status/wait-for-block-after/{round}.get.res.200.upgrade-votes: number

Total votes cast for consensus upgrade

/v2/status/wait-for-block-after/{round}.get.res.200.upgrade-votes-required?

optional /v2/status/wait-for-block-after/{round}.get.res.200.upgrade-votes-required: number

Yes votes required for consensus upgrade

/v2/status/wait-for-block-after/{round}.get.res.200.upgrade-yes-votes?

optional /v2/status/wait-for-block-after/{round}.get.res.200.upgrade-yes-votes: number

Yes votes cast for consensus upgrade

/v2/status/wait-for-block-after/{round}.get.res.400

/v2/status/wait-for-block-after/{round}.get.res.400: ErrorResponse

Bad Request — number must be non-negative integer

/v2/status/wait-for-block-after/{round}.get.res.401

/v2/status/wait-for-block-after/{round}.get.res.401: ErrorResponse

Invalid API Token

/v2/status/wait-for-block-after/{round}.get.res.500

/v2/status/wait-for-block-after/{round}.get.res.500: ErrorResponse

Internal Error

/v2/status/wait-for-block-after/{round}.get.res.503

/v2/status/wait-for-block-after/{round}.get.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/status/wait-for-block-after/{round}.get.res.default

/v2/status/wait-for-block-after/{round}.get.res.default: unknown

Unknown Error

/v2/teal/compile

/v2/teal/compile: object

/v2/teal/compile.post

/v2/teal/compile.post: object

/v2/teal/compile.post.req

/v2/teal/compile.post.req: TealCompileData

/v2/teal/compile.post.res

/v2/teal/compile.post.res: object

/v2/teal/compile.post.res.200

/v2/teal/compile.post.res.200: object

Teal compile Result

/v2/teal/compile.post.res.200.hash

/v2/teal/compile.post.res.200.hash: string

base32 SHA512_256 of program bytes (Address style)

/v2/teal/compile.post.res.200.result

/v2/teal/compile.post.res.200.result: string

base64 encoded program bytes

/v2/teal/compile.post.res.200.sourcemap?

optional /v2/teal/compile.post.res.200.sourcemap: unknown

JSON of the source map

/v2/teal/compile.post.res.400

/v2/teal/compile.post.res.400: ErrorResponse

Bad Request - Teal Compile Error

/v2/teal/compile.post.res.401

/v2/teal/compile.post.res.401: ErrorResponse

Invalid API Token

/v2/teal/compile.post.res.404

/v2/teal/compile.post.res.404: unknown

Developer API not enabled

/v2/teal/compile.post.res.500

/v2/teal/compile.post.res.500: ErrorResponse

Internal Error

/v2/teal/compile.post.res.default

/v2/teal/compile.post.res.default: unknown

Unknown Error

/v2/teal/disassemble

/v2/teal/disassemble: object

/v2/teal/disassemble.post

/v2/teal/disassemble.post: object

/v2/teal/disassemble.post.req

/v2/teal/disassemble.post.req: TealDisassembleData

/v2/teal/disassemble.post.res

/v2/teal/disassemble.post.res: object

/v2/teal/disassemble.post.res.200

/v2/teal/disassemble.post.res.200: object

Teal disassembly Result

/v2/teal/disassemble.post.res.200.result

/v2/teal/disassemble.post.res.200.result: string

disassembled Teal code

/v2/teal/disassemble.post.res.400

/v2/teal/disassemble.post.res.400: ErrorResponse

Bad Request - Teal Compile Error

/v2/teal/disassemble.post.res.401

/v2/teal/disassemble.post.res.401: ErrorResponse

Invalid API Token

/v2/teal/disassemble.post.res.404

/v2/teal/disassemble.post.res.404: unknown

Developer API not enabled

/v2/teal/disassemble.post.res.500

/v2/teal/disassemble.post.res.500: ErrorResponse

Internal Error

/v2/teal/disassemble.post.res.default

/v2/teal/disassemble.post.res.default: unknown

Unknown Error

/v2/teal/dryrun

/v2/teal/dryrun: object

/v2/teal/dryrun.post

/v2/teal/dryrun.post: object

/v2/teal/dryrun.post.req

/v2/teal/dryrun.post.req: TealDryrunData

/v2/teal/dryrun.post.res

/v2/teal/dryrun.post.res: object

/v2/teal/dryrun.post.res.200

/v2/teal/dryrun.post.res.200: object

DryrunResponse contains per-txn debug information from a dryrun.

/v2/teal/dryrun.post.res.200.error

/v2/teal/dryrun.post.res.200.error: string

/v2/teal/dryrun.post.res.200.protocol-version

/v2/teal/dryrun.post.res.200.protocol-version: string

Protocol version is the protocol version Dryrun was operated under.

/v2/teal/dryrun.post.res.200.txns

/v2/teal/dryrun.post.res.200.txns: DryrunTxnResult[]

/v2/teal/dryrun.post.res.400

/v2/teal/dryrun.post.res.400: ErrorResponse

Bad Request

/v2/teal/dryrun.post.res.401

/v2/teal/dryrun.post.res.401: ErrorResponse

Invalid API Token

/v2/teal/dryrun.post.res.404

/v2/teal/dryrun.post.res.404: unknown

Developer API not enabled

/v2/teal/dryrun.post.res.500

/v2/teal/dryrun.post.res.500: ErrorResponse

Internal Error

/v2/teal/dryrun.post.res.default

/v2/teal/dryrun.post.res.default: unknown

Unknown Error

/v2/transactions

/v2/transactions: object

/v2/transactions.post

/v2/transactions.post: object

/v2/transactions.post.req

/v2/transactions.post.req: RawTransactionData

/v2/transactions.post.res

/v2/transactions.post.res: object

/v2/transactions.post.res.200

/v2/transactions.post.res.200: object

Transaction ID of the submission.

/v2/transactions.post.res.200.txId

/v2/transactions.post.res.200.txId: string

encoding of the transaction hash.

/v2/transactions.post.res.400

/v2/transactions.post.res.400: ErrorResponse

Bad Request - Malformed Algorand transaction

/v2/transactions.post.res.401

/v2/transactions.post.res.401: ErrorResponse

Invalid API Token

/v2/transactions.post.res.500

/v2/transactions.post.res.500: ErrorResponse

Internal Error

/v2/transactions.post.res.503

/v2/transactions.post.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/transactions.post.res.default

/v2/transactions.post.res.default: unknown

Unknown Error

/v2/transactions/async

/v2/transactions/async: object

/v2/transactions/async.post

/v2/transactions/async.post: object

/v2/transactions/async.post.req

/v2/transactions/async.post.req: RawTransactionAsyncData

/v2/transactions/async.post.res

/v2/transactions/async.post.res: object

/v2/transactions/async.post.res.200

/v2/transactions/async.post.res.200: unknown

/v2/transactions/async.post.res.400

/v2/transactions/async.post.res.400: ErrorResponse

Bad Request - Malformed Algorand transaction

/v2/transactions/async.post.res.401

/v2/transactions/async.post.res.401: ErrorResponse

Invalid API Token

/v2/transactions/async.post.res.500

/v2/transactions/async.post.res.500: ErrorResponse

Internal Error

/v2/transactions/async.post.res.503

/v2/transactions/async.post.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/transactions/async.post.res.default

/v2/transactions/async.post.res.default: unknown

Unknown Error

/v2/transactions/params

/v2/transactions/params: object

/v2/transactions/params.get

/v2/transactions/params.get: object

/v2/transactions/params.get.res

/v2/transactions/params.get.res: object

/v2/transactions/params.get.res.200

/v2/transactions/params.get.res.200: object

TransactionParams contains the parameters that help a client construct a new transaction.

/v2/transactions/params.get.res.200.consensus-version

/v2/transactions/params.get.res.200.consensus-version: string

ConsensusVersion indicates the consensus protocol version as of LastRound.

/v2/transactions/params.get.res.200.fee

/v2/transactions/params.get.res.200.fee: number

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.

/v2/transactions/params.get.res.200.genesis-hash

/v2/transactions/params.get.res.200.genesis-hash: string

GenesisHash is the hash of the genesis block.

/v2/transactions/params.get.res.200.genesis-id

/v2/transactions/params.get.res.200.genesis-id: string

GenesisID is an ID listed in the genesis block.

/v2/transactions/params.get.res.200.last-round

/v2/transactions/params.get.res.200.last-round: number

LastRound indicates the last round seen

/v2/transactions/params.get.res.200.min-fee

/v2/transactions/params.get.res.200.min-fee: number

The minimum transaction fee (not per byte) required for the txn to validate for the current network protocol.

/v2/transactions/params.get.res.401

/v2/transactions/params.get.res.401: ErrorResponse

Invalid API Token

/v2/transactions/params.get.res.500

/v2/transactions/params.get.res.500: ErrorResponse

Internal Error

/v2/transactions/params.get.res.503

/v2/transactions/params.get.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/transactions/params.get.res.default

/v2/transactions/params.get.res.default: unknown

Unknown Error

/v2/transactions/pending

/v2/transactions/pending: object

/v2/transactions/pending.get

/v2/transactions/pending.get: object

/v2/transactions/pending.get.req

/v2/transactions/pending.get.req: GetPendingTransactionsData

/v2/transactions/pending.get.res

/v2/transactions/pending.get.res: object

/v2/transactions/pending.get.res.200

/v2/transactions/pending.get.res.200: object

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.

/v2/transactions/pending.get.res.200.top-transactions

/v2/transactions/pending.get.res.200.top-transactions: unknown[]

An array of signed transaction objects.

/v2/transactions/pending.get.res.200.total-transactions

/v2/transactions/pending.get.res.200.total-transactions: number

Total number of transactions in the pool.

/v2/transactions/pending.get.res.401

/v2/transactions/pending.get.res.401: ErrorResponse

Invalid API Token

/v2/transactions/pending.get.res.500

/v2/transactions/pending.get.res.500: ErrorResponse

Internal Error

/v2/transactions/pending.get.res.503

/v2/transactions/pending.get.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/transactions/pending.get.res.default

/v2/transactions/pending.get.res.default: unknown

Unknown Error

/v2/transactions/pending/{txid}

/v2/transactions/pending/{txid}: object

/v2/transactions/pending/{txid}.get

/v2/transactions/pending/{txid}.get: object

/v2/transactions/pending/{txid}.get.req

/v2/transactions/pending/{txid}.get.req: PendingTransactionInformationData

/v2/transactions/pending/{txid}.get.res

/v2/transactions/pending/{txid}.get.res: object

/v2/transactions/pending/{txid}.get.res.200

/v2/transactions/pending/{txid}.get.res.200: PendingTransactionResponse

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.

/v2/transactions/pending/{txid}.get.res.400

/v2/transactions/pending/{txid}.get.res.400: ErrorResponse

Bad Request

/v2/transactions/pending/{txid}.get.res.401

/v2/transactions/pending/{txid}.get.res.401: ErrorResponse

Invalid API Token

/v2/transactions/pending/{txid}.get.res.404

/v2/transactions/pending/{txid}.get.res.404: ErrorResponse

Transaction Not Found

/v2/transactions/pending/{txid}.get.res.default

/v2/transactions/pending/{txid}.get.res.default: unknown

Unknown Error

/v2/transactions/simulate

/v2/transactions/simulate: object

/v2/transactions/simulate.post

/v2/transactions/simulate.post: object

/v2/transactions/simulate.post.req

/v2/transactions/simulate.post.req: SimulateTransactionData

/v2/transactions/simulate.post.res

/v2/transactions/simulate.post.res: object

/v2/transactions/simulate.post.res.200

/v2/transactions/simulate.post.res.200: object

Result of a transaction group simulation.

/v2/transactions/simulate.post.res.200.eval-overrides?

optional /v2/transactions/simulate.post.res.200.eval-overrides: SimulationEvalOverrides

/v2/transactions/simulate.post.res.200.exec-trace-config?

optional /v2/transactions/simulate.post.res.200.exec-trace-config: SimulateTraceConfig

/v2/transactions/simulate.post.res.200.initial-states?

optional /v2/transactions/simulate.post.res.200.initial-states: SimulateInitialStates

/v2/transactions/simulate.post.res.200.last-round

/v2/transactions/simulate.post.res.200.last-round: number

The round immediately preceding this simulation. State changes through this round were used to run this simulation.

/v2/transactions/simulate.post.res.200.txn-groups

/v2/transactions/simulate.post.res.200.txn-groups: SimulateTransactionGroupResult[]

A result object for each transaction group that was simulated.

/v2/transactions/simulate.post.res.200.version

/v2/transactions/simulate.post.res.200.version: number

The version of this response object.

/v2/transactions/simulate.post.res.400

/v2/transactions/simulate.post.res.400: ErrorResponse

Bad Request

/v2/transactions/simulate.post.res.401

/v2/transactions/simulate.post.res.401: ErrorResponse

Invalid API Token

/v2/transactions/simulate.post.res.500

/v2/transactions/simulate.post.res.500: ErrorResponse

Internal Error

/v2/transactions/simulate.post.res.503

/v2/transactions/simulate.post.res.503: ErrorResponse

Service Temporarily Unavailable

/v2/transactions/simulate.post.res.default

/v2/transactions/simulate.post.res.default: unknown

Unknown Error

/versions

/versions: object

/versions.get

/versions.get: object

/versions.get.res

/versions.get.res: object

/versions.get.res.200

/versions.get.res.200: Version

VersionsResponse is the response to ‘GET /versions’

Defined in

types.gen.ts:2145