Home

Algod REST API.

v1.0.0
Base URLs
https://algo.nownodes.io
https://algo-index.nownodes.io

API endpoint for algod operations.

Authentication

api-keyAuthapiKey

API Key: api-key in header

API Reference

Genesis

Gets the genesis information.

GET
https://algo.nownodes.io/genesis

Returns the entire genesis file in json.

Response

200OK

The genesis file in json.

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Health

Returns OK if healthy.

GET
https://algo.nownodes.io/health

Response

200OK

OK.

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Metrics

Return metrics about algod functioning.

GET
https://algo.nownodes.io/metrics

Response

200OK

text with #-comments and key:value lines

404Not Found

metrics were compiled out

Authorization

api-keyAuthapiKey in header

Ready

Returns OK if healthy and fully caught up.

GET
https://algo.nownodes.io/ready

Response

200OK

OK.

500Internal Server Error

Internal Error

503Service Unavailable

Node not ready yet

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Swagger

Gets the current swagger spec.

GET
https://algo.nownodes.io/swagger.json

Returns the entire swagger spec in json.

Response

200OK

The current swagger spec

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Gets the current swagger spec.

GET
https://algo.nownodes.io/swagger.json

Returns the entire swagger spec in json.

Response

200OK

The current swagger spec

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Accounts

Get account information.

GET
https://algo.nownodes.io/v2/accounts/{address}

Given a specific account public key, this call returns the accounts status, balance and spendable amounts

Parameters

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

addressstringrequiredpath

An account public key

excludestringallnonequery

When set to all will exclude asset holdings, application local state, created asset parameters, any created application parameters. Defaults to none.

Response

200OK

AccountResponse wraps the Account type in a response.

400Bad Request

Bad request

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get account information about a given app.

GET
https://algo.nownodes.io/v2/accounts/{address}/applications/{application-id}

Given a specific account public key and application ID, this call returns the account's application local state and global state (AppLocalState and AppParams, if either exists). Global state will only be returned if the provided address is the application's creator.

Parameters

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

addressstringrequiredpath

An account public key

application-idintegerrequiredpath

An application identifier

Response

200OK

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.

400Bad Request

Malformed address or application ID

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get account information about a given asset.

GET
https://algo.nownodes.io/v2/accounts/{address}/assets/{asset-id}

Given a specific account public key and asset ID, this call returns the account's asset holding and asset parameters (if either exist). Asset parameters will only be returned if the provided address is the asset's creator.

Parameters

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

addressstringrequiredpath

An account public key

asset-idintegerrequiredpath

An asset identifier

Response

200OK

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.

400Bad Request

Malformed address or asset ID

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get a list of unconfirmed transactions currently in the transaction pool by address.

GET
https://algo.nownodes.io/v2/accounts/{address}/transactions/pending

Get the list of pending transactions by address, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Parameters

addressstringrequiredpath

An account public key

maxintegerquery

Truncated number of transactions to display. If max=0, returns all pending txns.

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Response

200OK

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.

400Bad Request

Max must be a non-negative integer

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Applications

Get application information.

GET
https://algo.nownodes.io/v2/applications/{application-id}

Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.

Parameters

application-idintegerrequiredpath

An application identifier

Response

200OK

Application information

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

404Not Found

Application Not Found

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get box information for a given application.

GET
https://algo.nownodes.io/v2/applications/{application-id}/box

Given an application ID and box name, it returns the round, box name, and value (each base64 encoded). Box names must be in the goal app call arg encoding form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.

Parameters

application-idintegerrequiredpath

An application identifier

namestringrequiredquery

A box name, in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.

Response

200OK

Box information

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

404Not Found

Box Not Found

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get all box names for a given application.

GET
https://algo.nownodes.io/v2/applications/{application-id}/boxes

Given an application ID, return all Box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all Box names.

Parameters

application-iintegerrequiredpath

An application identifierd

maxintegerquery

Max number of box names to return. If max is not set, or max == 0, returns all box-names.

Response

200OK

Box names of an application

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Assets

Get asset information.

GET
https://algo.nownodes.io/v2/assets/{asset-id}

Given a asset ID, it returns asset information including creator, name, total supply and special addresses.

Parameters

asset-idintegerrequiredpath

An asset identifier

Response

200OK

Asset information

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

404Not Found

Application Not Found

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Blocks

Get the block for the given round.

GET
https://algo.nownodes.io/v2/blocks/{round}

Parameters

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

roundinteger>= 0requiredpath

The round from which to fetch block information.

Response

200OK

Encoded block object.

400Bad Request

Bad Request - Non integer number

401Unauthorized

Invalid API Token

404Not Found

None existing block

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get the block hash for the block on the given round.

GET
https://algo.nownodes.io/v2/blocks/{round}/hash

Parameters

roundinteger>= 0requiredpath

The round from which to fetch block hash information.

Response

200OK

Hash of a block header.

400Bad Request

Bad Request - Non integer number

401Unauthorized

Invalid API Token

404Not Found

None existing block

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Gets a proof for a given light block header inside a state proof commitment

GET
https://algo.nownodes.io/v2/blocks/{round}/lightheader/proof

Parameters

roundinteger>= 0requiredpath

The round to which the light block header belongs.

Response

200OK

Proof of a light block header.

401Unauthorized

Invalid API Token

404Not Found

Could not create proof since some data is missing

408Request Timeout

timed out on request

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get a proof for a transaction in a block.

GET
https://algo.nownodes.io/v2/blocks/{round}/transactions/{txid}/proof

Parameters

roundintegerrequiredpath

The round in which the transaction appears.

txidstringrequiredpath

The transaction ID for which to generate a proof.

hashtypestringsha512_256sha256query

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

  • sha512_256
  • sha256
formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Response

200OK

Proof of transaction in a block.

400Bad Request

Malformed round number or transaction ID

401Unauthorized

Invalid API token

404Not Found

Non-existent block or transaction

500Internal Server Error

Internal error, including protocol not supporting proofs.

default

Unknown error

Authorization

api-keyAuthapiKey in header

Get the top level transaction IDs for the block on the given round.

GET
https://algo.nownodes.io/v2/blocks/{round}/txids

Parameters

roundinteger>= 0requiredpath

The round from which to fetch block transaction IDs.

Response

200OK

Top level transaction IDs in a block.

400Bad Request

Bad Request - Non integer number

401Unauthorized

Invalid API Token

404Not Found

Non existing block

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Starts a catchpoint catchup.

POST
https://algo.nownodes.io/v2/blocks/{round}/txids

Given a catchpoint, it starts catching up to this catchpoint

Parameters

catchpointstring<catchpoint>requiredpath

A catch point

minintegerquery

Specify the minimum number of blocks which the ledger must be advanced by in order to start the catchup. This is useful for simplifying tools which support fast catchup, they can run the catchup unconditionally and the node will skip the catchup if it is not needed.

Response

200OK

An catchpoint start response.

201Created

An catchpoint start response.

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

408Request Timeout

Request Timeout

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Deltas

Get a LedgerStateDelta object for a given transaction group

GET
https://algo.nownodes.io/v2/deltas/txn/group/{id}

Get a ledger delta for a given transaction group.

Parameters

idstringrequiredpath

A transaction ID, or transaction group ID

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Response

200OK

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

401Unauthorized

Invalid API Token

404Not Found

Could not find a delta for transaction ID or group ID

408Request Timeout

timed out on request

500Internal Server Error

Internal Error

501Not Implemented

Not Implemented

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get a LedgerStateDelta object for a given round

GET
https://algo.nownodes.io/v2/deltas/{round}

Get ledger deltas for a round.

Parameters

roundinteger>= 0requiredpath

The round for which the deltas are desired.

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Response

200OK

Contains ledger deltas

401Unauthorized

Invalid API Token

404Not Found

Could not find a delta for round

408Request Timeout

timed out on request

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get LedgerStateDelta objects for all transaction groups in a given round

GET
https://algo.nownodes.io/v2/deltas/{round}/txn/group

Get ledger deltas for transaction groups in a given round.

Parameters

roundinteger>= 0requiredpath

The round for which the deltas are desired.

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Response

200OK

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

401Unauthorized

Invalid API Token

404Not Found

Could not find deltas for round

408Request Timeout

timed out on request

500Internal Server Error

Internal Error

501Not Implemented

Not Implemented

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Devmode

Returns the timestamp offset. Timestamp offsets can only be set in dev mode.

GET
https://algo.nownodes.io/v2/devmode/blocks/offset

Gets the current timestamp offset.

Response

200OK

Response containing the timestamp offset in seconds

400Bad Request

TimeStamp offset not set.

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Given a timestamp offset in seconds, adds the offset to every subsequent block header's timestamp.

POST
https://algo.nownodes.io/v2/devmode/blocks/offset/{offset}

Sets the timestamp offset (seconds) for blocks in dev mode. Providing an offset of 0 will unset this value and try to use the real clock for the timestamp.

Parameters

offsetinteger>= 0requiredpath

The timestamp offset for blocks in dev mode.

Response

200OK

OK

400Bad Request

Cannot set timestamp offset to a negative integer.

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Experimental

Returns OK if experimental API is enabled.

GET
https://algo.nownodes.io/v2/experimental

Response

200OK

Experimental API enabled

404Not Found

Experimental API not enabled

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Ledger

Get the current supply reported by the ledger.

GET
https://algo.nownodes.io/v2/ledger/supply

Response

200OK

Supply represents the current supply of MicroAlgos in the system.

401Unauthorized

Invalid API Token

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Returns the minimum sync round the ledger is keeping in cache.

GET
https://algo.nownodes.io/v2/ledger/sync

Gets the minimum sync round for the ledger.

Response

200OK

Response containing the ledger's minimum sync round

400Bad Request

Sync round not set.

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Given a round, tells the ledger to keep that round in its cache.

POST
https://algo.nownodes.io/v2/ledger/sync/{round}

Sets the minimum sync round on the ledger.

Parameters

roundinteger>= 0requiredpath

The round for which the deltas are desired.

Response

200OK

Valid response

400Bad Request

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

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Participation

Return a list of participation keys

GET
https://algo.nownodes.io/v2/participation

Return a list of participation keys

Response

200OK

A list of participation keys

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

404Not Found

Participation Key Not Found

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Add a participation key to the node

POST
https://algo.nownodes.io/v2/participation

Body

application/msgpack

The participation key to add to the node

string<binary>

Response

200OK

Participation ID of the submission

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

404Not Found

Participation Key Not Found

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Generate and install participation keys to the node.

POST
https://algo.nownodes.io/v2/participation/generate/{address}

Parameters

addressstringrequiredpath

An account public key

dilutionintegerquery

Key dilution for two-level participation keys (defaults to sqrt of validity window).

firstintegerrequiredquery

First round for participation key.

lastintegerrequiredquery

Last round for participation key.

Response

200OK

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

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get participation key info given a participation ID

GET
https://algo.nownodes.io/v2/participation/{participation-id}

Given a participation ID, return information about that participation key

Parameters

participation-idstringrequiredpath

Response

200OK

A detailed description of a participation ID

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

404Not Found

Participation Key Not Found

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Append state proof keys to a participation key

POST
https://algo.nownodes.io/v2/participation/{participation-id}

Given a participation ID, append state proof keys to a particular set of participation keys

Body

application/msgpack

The state proof keys to add to an existing participation ID

string<binary>

Parameters

participation-idstringrequiredpath

Response

200OK

A detailed description of a participation ID

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

404Not Found

Participation Key Not Found

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Shutdown

POST
https://algo.nownodes.io/v2/shutdown

Special management endpoint to shutdown the node. Optionally provide a timeout parameter to indicate that the node should begin shutting down after a number of seconds.

Parameters

timeoutinteger0query

Response

200OK

Valid response

Authorization

api-keyAuthapiKey in header

Stateproofs

Get a state proof that covers a given round

GET
https://algo.nownodes.io/v2/stateproofs/{round}

Parameters

roundinteger>= 0requiredpath

The round for which a state proof is desired.

Response

200OK

StateProofResponse wraps the StateProof type in a response.

401Unauthorized

Invalid API Token

404Not Found

Could not find a state proof that covers a given round

408Request Timeout

timed out on request

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Status

Gets the current node status.

GET
https://algo.nownodes.io/v2/status

Response

200OK

Valid response

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Gets the node status after waiting for a round after the given round.

GET
https://algo.nownodes.io/v2/status/wait-for-block-after/{round}

Waits for a block to appear after round {round} and returns the node's status at the time. There is a 1 minute timeout, when reached the current status is returned regardless of whether or not it is the round after the given round.

Parameters

roundinteger>= 0requiredpath

The round to wait until returning status

Response

200OK

Valid response

400Bad Request

Bad Request -- number must be non-negative integer

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Teal

Compile TEAL source code to binary, produce its hash

POST
https://algo.nownodes.io/v2/teal/compile

Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style). This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.

Body

text/plain

TEAL source code to be compiled

string<binary>

Parameters

sourcemapbooleanquery

When set to true, returns the source map of the program as a JSON. Defaults to false.

Response

200OK

Teal compile Result

400Bad Request

Bad Request - Teal Compile Error

401Unauthorized

Invalid API Token

404Not Found

Developer API not enabled

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Disassemble program bytes into the TEAL source code.

POST
https://algo.nownodes.io/v2/teal/disassemble

Given the program bytes, return the TEAL source code in plain text. This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.

Body

application/x-binary

TEAL program binary to be disassembled

string<byte>

Response

200OK

Teal disassembly Result

400Bad Request

Bad Request - Teal Compile Error

401Unauthorized

Invalid API Token

404Not Found

Developer API not enabled

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Provide debugging information for a transaction (or group).

POST
https://algo.nownodes.io/v2/teal/dryrun

Executes TEAL program(s) in context and returns debugging information about the execution. This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.

Body

application/json

Transaction (or group) and any accompanying state-simulation data.

application/jsonDryrunRequest

Request data type for dryrun endpoint. Given the Transactions and simulated ledger state upload, run TEAL scripts and return debugging information.

accountsArray<Account>required
Show child attributes
addressstringrequired

the account public key

amountintegerrequired

[algo] total number of MicroAlgos in the account

amount-without-pending-rewardsintegerrequired

specifies the amount of MicroAlgos in the account, without the pending rewards.

apps-local-stateArray<ApplicationLocalState>

[appl] applications local data stored in this account.

Note the raw object uses map[int] -> AppLocalState for this type.

Show child attributes
idintegerrequired

The application which this local state is for.

key-valueArray<TealKeyValue>

Represents a key-value store for use in an application.

Show child attributes
keystringrequired
valueTealValuerequired

Represents a TEAL value.

Show child attributes
bytesstringrequired

[tb] bytes value.

typeintegerrequired

[tt] value type. Value 1 refers to bytes, value 2 refers to uint

uintintegerrequired

[ui] uint value.

schemaApplicationStateSchemarequired

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

apps-total-extra-pagesinteger

[teap] the sum of all extra application program pages for this account.

apps-total-schemaApplicationStateSchema

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

assetsArray<AssetHolding>

[asset] assets held by this account.

Note the raw object uses map[int] -> AssetHolding for this type.

Show child attributes
amountintegerrequired

[a] number of units held.

asset-idintegerrequired

Asset ID of the holding.

is-frozenbooleanrequired

[f] whether or not the holding is frozen.

auth-addrstring

[spend] the address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field.

created-appsArray<Application>

[appp] parameters of applications created by this account including app global data.

Note: the raw account uses map[int] -> AppParams for this type.

Show child attributes
idintegerrequired

[appidx] application index.

paramsApplicationParamsrequired

Stores the global information associated with an application.

Show child attributes
approval-programstring<byte>required

[approv] approval program.

clear-state-programstring<byte>required

[clearp] approval program.

creatorstringrequired

The address that created this application. This is the address where the parameters and global state for this application can be found.

extra-program-pagesinteger

[epp] the amount of extra program pages available to this app.

global-stateArray<TealKeyValue>

Represents a key-value store for use in an application.

Show child attributes
keystringrequired
valueTealValuerequired

Represents a TEAL value.

Show child attributes
bytesstringrequired

[tb] bytes value.

typeintegerrequired

[tt] value type. Value 1 refers to bytes, value 2 refers to uint

uintintegerrequired

[ui] uint value.

global-state-schemaApplicationStateSchema

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

local-state-schemaApplicationStateSchema

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

created-assetsArray<Asset>

[apar] parameters of assets created by this account.

Note: the raw account uses map[int] -> Asset for this type.

Show child attributes
indexintegerrequired

unique asset identifier

paramsAssetParamsrequired

AssetParams specifies the parameters for an asset.

[apar] when part of an AssetConfig transaction.

Definition: data/transactions/asset.go : AssetParams

Show child attributes
clawbackstring

[c] Address of account used to clawback holdings of this asset. If empty, clawback is not permitted.

creatorstringrequired

The address that created this asset. This is the address where the parameters for this asset can be found, and also the address where unwanted asset units can be sent in the worst case.

decimalsinteger[0, 19]required

[dc] The number of digits to use after the decimal point when displaying this asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in tenths. If 2, the base unit of the asset is in hundredths, and so on. This value must be between 0 and 19 (inclusive).

default-frozenboolean

[df] Whether holdings of this asset are frozen by default.

freezestring

[f] Address of account used to freeze holdings of this asset. If empty, freezing is not permitted.

managerstring

[m] Address of account used to manage the keys of this asset and to destroy it.

metadata-hashstring<byte>

[am] A commitment to some unspecified asset metadata. The format of this metadata is up to the application.

namestring

[an] Name of this asset, as supplied by the creator. Included only when the asset name is composed of printable utf-8 characters.

name-b64string<byte>

Base64 encoded name of this asset, as supplied by the creator.

reservestring

[r] Address of account holding reserve (non-minted) units of this asset.

totalintegerrequired

[t] The total number of units of this asset.

unit-namestring

[un] Name of a unit of this asset, as supplied by the creator. Included only when the name of a unit of this asset is composed of printable utf-8 characters.

unit-name-b64string<byte>

Base64 encoded name of a unit of this asset, as supplied by the creator.

urlstring

[au] URL where more information about the asset can be retrieved. Included only when the URL is composed of printable utf-8 characters.

url-b64string<byte>

Base64 encoded URL where more information about the asset can be retrieved.

min-balanceintegerrequired

MicroAlgo balance required by the account.

The requirement grows based on asset and application usage.

participationAccountParticipation

AccountParticipation describes the parameters used by this account in consensus protocol.

Show child attributes
selection-participation-keystring<byte>required

[sel] Selection public key (if any) currently registered for this round.

state-proof-keystring<byte>

[stprf] Root of the state proof key (if any)

vote-first-validintegerrequired

[voteFst] First round for which this participation is valid.

vote-key-dilutionintegerrequired

[voteKD] Number of subkeys in each batch of participation keys.

vote-last-validintegerrequired

[voteLst] Last round for which this participation is valid.

vote-participation-keystring<byte>required

[vote] root participation public key (if any) currently registered for this round.

pending-rewardsintegerrequired

amount of MicroAlgos of pending rewards in this account.

reward-baseinteger

[ebase] used as part of the rewards computation. Only applicable to accounts which are participating.

rewardsintegerrequired

[ern] total rewards of MicroAlgos the account has received, including pending rewards.

roundintegerrequired

The round for which this information is relevant.

sig-typestringsigmsiglsig

Indicates what type of signature is used by this account, must be one of:

  • sig
  • msig
  • lsig
statusstringrequired

[onl] delegation status of the account's MicroAlgos

  • Offline - indicates that the associated account is delegated.
  • Online - indicates that the associated account used as part of the delegation pool.
  • NotParticipating - indicates that the associated account is neither a delegator nor a delegate.
total-apps-opted-inintegerrequired

The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account.

total-assets-opted-inintegerrequired

The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account.

total-box-bytesinteger

[tbxb] The total number of bytes used by this account's app's box keys and values.

total-boxesinteger

[tbx] The number of existing boxes created by this account's app.

total-created-appsintegerrequired

The count of all apps (AppParams objects) created by this account.

total-created-assetsintegerrequired

The count of all assets (AssetParams objects) created by this account.

appsArray<Application>required
Show child attributes
idintegerrequired

[appidx] application index.

paramsApplicationParamsrequired

Stores the global information associated with an application.

Show child attributes
approval-programstring<byte>required

[approv] approval program.

clear-state-programstring<byte>required

[clearp] approval program.

creatorstringrequired

The address that created this application. This is the address where the parameters and global state for this application can be found.

extra-program-pagesinteger

[epp] the amount of extra program pages available to this app.

global-stateArray<TealKeyValue>

Represents a key-value store for use in an application.

Show child attributes
keystringrequired
valueTealValuerequired

Represents a TEAL value.

Show child attributes
bytesstringrequired

[tb] bytes value.

typeintegerrequired

[tt] value type. Value 1 refers to bytes, value 2 refers to uint

uintintegerrequired

[ui] uint value.

global-state-schemaApplicationStateSchema

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

local-state-schemaApplicationStateSchema

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

latest-timestampinteger<int64>required

LatestTimestamp is available to some TEAL scripts. Defaults to the latest confirmed timestamp this algod is attached to.

protocol-versionstringrequired

ProtocolVersion specifies a specific version string to operate under, otherwise whatever the current protocol of the network this algod is running in.

roundintegerrequired

Round is available to some TEAL scripts. Defaults to the current round on the network this algod is attached to.

sourcesArray<DryrunSource>required
Show child attributes
app-indexintegerrequired
field-namestringrequired

FieldName is what kind of sources this is. If lsig then it goes into the transactions[this.TxnIndex].LogicSig. If approv or clearp it goes into the Approval Program or Clear State Program of application[this.AppIndex].

sourcestringrequired
txn-indexintegerrequired
txnsArray<string>required
application/msgpackDryrunRequest

Request data type for dryrun endpoint. Given the Transactions and simulated ledger state upload, run TEAL scripts and return debugging information.

accountsArray<Account>required
Show child attributes
addressstringrequired

the account public key

amountintegerrequired

[algo] total number of MicroAlgos in the account

amount-without-pending-rewardsintegerrequired

specifies the amount of MicroAlgos in the account, without the pending rewards.

apps-local-stateArray<ApplicationLocalState>

[appl] applications local data stored in this account.

Note the raw object uses map[int] -> AppLocalState for this type.

Show child attributes
idintegerrequired

The application which this local state is for.

key-valueArray<TealKeyValue>

Represents a key-value store for use in an application.

Show child attributes
keystringrequired
valueTealValuerequired

Represents a TEAL value.

Show child attributes
bytesstringrequired

[tb] bytes value.

typeintegerrequired

[tt] value type. Value 1 refers to bytes, value 2 refers to uint

uintintegerrequired

[ui] uint value.

schemaApplicationStateSchemarequired

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

apps-total-extra-pagesinteger

[teap] the sum of all extra application program pages for this account.

apps-total-schemaApplicationStateSchema

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

assetsArray<AssetHolding>

[asset] assets held by this account.

Note the raw object uses map[int] -> AssetHolding for this type.

Show child attributes
amountintegerrequired

[a] number of units held.

asset-idintegerrequired

Asset ID of the holding.

is-frozenbooleanrequired

[f] whether or not the holding is frozen.

auth-addrstring

[spend] the address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field.

created-appsArray<Application>

[appp] parameters of applications created by this account including app global data.

Note: the raw account uses map[int] -> AppParams for this type.

Show child attributes
idintegerrequired

[appidx] application index.

paramsApplicationParamsrequired

Stores the global information associated with an application.

Show child attributes
approval-programstring<byte>required

[approv] approval program.

clear-state-programstring<byte>required

[clearp] approval program.

creatorstringrequired

The address that created this application. This is the address where the parameters and global state for this application can be found.

extra-program-pagesinteger

[epp] the amount of extra program pages available to this app.

global-stateArray<TealKeyValue>

Represents a key-value store for use in an application.

Show child attributes
keystringrequired
valueTealValuerequired

Represents a TEAL value.

Show child attributes
bytesstringrequired

[tb] bytes value.

typeintegerrequired

[tt] value type. Value 1 refers to bytes, value 2 refers to uint

uintintegerrequired

[ui] uint value.

global-state-schemaApplicationStateSchema

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

local-state-schemaApplicationStateSchema

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

created-assetsArray<Asset>

[apar] parameters of assets created by this account.

Note: the raw account uses map[int] -> Asset for this type.

Show child attributes
indexintegerrequired

unique asset identifier

paramsAssetParamsrequired

AssetParams specifies the parameters for an asset.

[apar] when part of an AssetConfig transaction.

Definition: data/transactions/asset.go : AssetParams

Show child attributes
clawbackstring

[c] Address of account used to clawback holdings of this asset. If empty, clawback is not permitted.

creatorstringrequired

The address that created this asset. This is the address where the parameters for this asset can be found, and also the address where unwanted asset units can be sent in the worst case.

decimalsinteger[0, 19]required

[dc] The number of digits to use after the decimal point when displaying this asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in tenths. If 2, the base unit of the asset is in hundredths, and so on. This value must be between 0 and 19 (inclusive).

default-frozenboolean

[df] Whether holdings of this asset are frozen by default.

freezestring

[f] Address of account used to freeze holdings of this asset. If empty, freezing is not permitted.

managerstring

[m] Address of account used to manage the keys of this asset and to destroy it.

metadata-hashstring<byte>

[am] A commitment to some unspecified asset metadata. The format of this metadata is up to the application.

namestring

[an] Name of this asset, as supplied by the creator. Included only when the asset name is composed of printable utf-8 characters.

name-b64string<byte>

Base64 encoded name of this asset, as supplied by the creator.

reservestring

[r] Address of account holding reserve (non-minted) units of this asset.

totalintegerrequired

[t] The total number of units of this asset.

unit-namestring

[un] Name of a unit of this asset, as supplied by the creator. Included only when the name of a unit of this asset is composed of printable utf-8 characters.

unit-name-b64string<byte>

Base64 encoded name of a unit of this asset, as supplied by the creator.

urlstring

[au] URL where more information about the asset can be retrieved. Included only when the URL is composed of printable utf-8 characters.

url-b64string<byte>

Base64 encoded URL where more information about the asset can be retrieved.

min-balanceintegerrequired

MicroAlgo balance required by the account.

The requirement grows based on asset and application usage.

participationAccountParticipation

AccountParticipation describes the parameters used by this account in consensus protocol.

Show child attributes
selection-participation-keystring<byte>required

[sel] Selection public key (if any) currently registered for this round.

state-proof-keystring<byte>

[stprf] Root of the state proof key (if any)

vote-first-validintegerrequired

[voteFst] First round for which this participation is valid.

vote-key-dilutionintegerrequired

[voteKD] Number of subkeys in each batch of participation keys.

vote-last-validintegerrequired

[voteLst] Last round for which this participation is valid.

vote-participation-keystring<byte>required

[vote] root participation public key (if any) currently registered for this round.

pending-rewardsintegerrequired

amount of MicroAlgos of pending rewards in this account.

reward-baseinteger

[ebase] used as part of the rewards computation. Only applicable to accounts which are participating.

rewardsintegerrequired

[ern] total rewards of MicroAlgos the account has received, including pending rewards.

roundintegerrequired

The round for which this information is relevant.

sig-typestringsigmsiglsig

Indicates what type of signature is used by this account, must be one of:

  • sig
  • msig
  • lsig
statusstringrequired

[onl] delegation status of the account's MicroAlgos

  • Offline - indicates that the associated account is delegated.
  • Online - indicates that the associated account used as part of the delegation pool.
  • NotParticipating - indicates that the associated account is neither a delegator nor a delegate.
total-apps-opted-inintegerrequired

The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account.

total-assets-opted-inintegerrequired

The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account.

total-box-bytesinteger

[tbxb] The total number of bytes used by this account's app's box keys and values.

total-boxesinteger

[tbx] The number of existing boxes created by this account's app.

total-created-appsintegerrequired

The count of all apps (AppParams objects) created by this account.

total-created-assetsintegerrequired

The count of all assets (AssetParams objects) created by this account.

appsArray<Application>required
Show child attributes
idintegerrequired

[appidx] application index.

paramsApplicationParamsrequired

Stores the global information associated with an application.

Show child attributes
approval-programstring<byte>required

[approv] approval program.

clear-state-programstring<byte>required

[clearp] approval program.

creatorstringrequired

The address that created this application. This is the address where the parameters and global state for this application can be found.

extra-program-pagesinteger

[epp] the amount of extra program pages available to this app.

global-stateArray<TealKeyValue>

Represents a key-value store for use in an application.

Show child attributes
keystringrequired
valueTealValuerequired

Represents a TEAL value.

Show child attributes
bytesstringrequired

[tb] bytes value.

typeintegerrequired

[tt] value type. Value 1 refers to bytes, value 2 refers to uint

uintintegerrequired

[ui] uint value.

global-state-schemaApplicationStateSchema

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

local-state-schemaApplicationStateSchema

Specifies maximums on the number of each type that may be stored.

Show child attributes
num-byte-sliceintegerrequired

[nbs] num of byte slices.

num-uintintegerrequired

[nui] num of uints.

latest-timestampinteger<int64>required

LatestTimestamp is available to some TEAL scripts. Defaults to the latest confirmed timestamp this algod is attached to.

protocol-versionstringrequired

ProtocolVersion specifies a specific version string to operate under, otherwise whatever the current protocol of the network this algod is running in.

roundintegerrequired

Round is available to some TEAL scripts. Defaults to the current round on the network this algod is attached to.

sourcesArray<DryrunSource>required
Show child attributes
app-indexintegerrequired
field-namestringrequired

FieldName is what kind of sources this is. If lsig then it goes into the transactions[this.TxnIndex].LogicSig. If approv or clearp it goes into the Approval Program or Clear State Program of application[this.AppIndex].

sourcestringrequired
txn-indexintegerrequired
txnsArray<string>required

Response

200OK

DryrunResponse contains per-txn debug information from a dryrun.

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

404Not Found

Developer API not enabled

500Internal Server Error

Internal Error

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Transactions

Broadcasts a raw transaction or transaction group to the network.

POST
https://algo.nownodes.io/v2/transactions

Body

application/x-binary

The byte encoded signed transaction to broadcast to network

string<binary>

Response

200OK

Transaction ID of the submission.

400Bad Request

Bad Request - Malformed Algorand transaction

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

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.

POST
https://algo.nownodes.io/v2/transactions/async

Body

application/x-binary

The byte encoded signed transaction to broadcast to network

string<binary>

Response

200OK

Valid response

400Bad Request

Bad Request - Malformed Algorand transaction

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get parameters for constructing a new transaction

GET
https://algo.nownodes.io/v2/transactions/params

Response

200OK

TransactionParams contains the parameters that help a client construct a new transaction.

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get a list of unconfirmed transactions currently in the transaction pool.

GET
https://algo.nownodes.io/v2/transactions/pending

Get the list of pending transactions, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.

Parameters

maxintegerquery

Truncated number of transactions to display. If max=0, returns all pending txns.

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Response

200OK

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.

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Get a specific pending transaction.

GET
https://algo.nownodes.io/v2/transactions/pending/{txid}

Given a transaction ID of a recently submitted transaction, it returns information about it. There are several cases when this might succeed:

  • transaction committed (committed round > 0)
  • transaction still in the pool (committed round = 0, pool error = "")
  • transaction removed from pool due to error (committed round = 0, pool error != "") Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.

Parameters

txidstringrequiredpath

A transaction ID

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Response

200OK

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.

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

404Not Found

Transaction Not Found

default

Unknown Error

Authorization

api-keyAuthapiKey in header

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.

POST
https://algo.nownodes.io/v2/transactions/simulate

Body

application/json

The transactions to simulate, along with any other inputs.

application/jsonSimulateRequest

Request type for simulation endpoint.

allow-empty-signaturesboolean

Allows transactions without signatures to be simulated as if they had correct signatures.

allow-more-loggingboolean

Lifts limits on log opcode usage during simulation.

allow-unnamed-resourcesboolean

Allows access to unnamed resources during simulation.

exec-trace-configSimulateTraceConfig

An object that configures simulation execution trace.

Show child attributes
enableboolean

A boolean option for opting in execution trace features simulation endpoint.

scratch-changeboolean

A boolean option enabling returning scratch slot changes together with execution trace during simulation.

stack-changeboolean

A boolean option enabling returning stack changes together with execution trace during simulation.

state-changeboolean

A boolean option enabling returning application state changes (global, local, and box changes) with the execution trace during simulation.

extra-opcode-budgetinteger

Applies extra opcode budget during simulation for each transaction group.

roundinteger

If provided, specifies the round preceding the simulation. State changes through this round will be used to run this simulation. Usually only the 4 most recent rounds will be available (controlled by the node config value MaxAcctLookback). If not specified, defaults to the latest available round.

txn-groupsArray<SimulateRequestTransactionGroup>required

The transaction groups to simulate.

Show child attributes
txnsArray<string>required

An atomic transaction group.

application/msgpackSimulateRequest

Request type for simulation endpoint.

allow-empty-signaturesboolean

Allows transactions without signatures to be simulated as if they had correct signatures.

allow-more-loggingboolean

Lifts limits on log opcode usage during simulation.

allow-unnamed-resourcesboolean

Allows access to unnamed resources during simulation.

exec-trace-configSimulateTraceConfig

An object that configures simulation execution trace.

Show child attributes
enableboolean

A boolean option for opting in execution trace features simulation endpoint.

scratch-changeboolean

A boolean option enabling returning scratch slot changes together with execution trace during simulation.

stack-changeboolean

A boolean option enabling returning stack changes together with execution trace during simulation.

state-changeboolean

A boolean option enabling returning application state changes (global, local, and box changes) with the execution trace during simulation.

extra-opcode-budgetinteger

Applies extra opcode budget during simulation for each transaction group.

roundinteger

If provided, specifies the round preceding the simulation. State changes through this round will be used to run this simulation. Usually only the 4 most recent rounds will be available (controlled by the node config value MaxAcctLookback). If not specified, defaults to the latest available round.

txn-groupsArray<SimulateRequestTransactionGroup>required

The transaction groups to simulate.

Show child attributes
txnsArray<string>required

An atomic transaction group.

Parameters

formatstringjsonmsgpackquery

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

Response

200OK

Result of a transaction group simulation.

400Bad Request

Bad Request

401Unauthorized

Invalid API Token

500Internal Server Error

Internal Error

503Service Unavailable

Service Temporarily Unavailable

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Versions

GET
https://algo.nownodes.io/versions

Retrieves the supported API versions, binary build versions, and genesis information.

Response

200OK

VersionsResponse is the response to 'GET /versions'

Authorization

api-keyAuthapiKey in header

Retrieves the current version

GET
https://algo.nownodes.io/versions

Body

application/json

VersionsRequest is the request for GET /versions

VersionsRequest

Response

200OK

Response to GET /versions

Authorization

api-keyAuthapiKey in header

Key

Generate a key

POST
https://algo.nownodes.io/v1/key

Generates the next key in the deterministic key sequence (as determined by the master derivation key) and adds it to the wallet, returning the public key.

Body

application/json

APIV1POSTKeyRequest is the request for POST /v1/key

display_mnemonicboolean
wallet_handle_tokenstring

Response

200OK

Response to POST /v1/key

Authorization

api-keyAuthapiKey in header

Export a key

POST
https://algo.nownodes.io/v1/key/export

Export the secret key associated with the passed public key.

Body

application/json

APIV1POSTKeyExportRequest is the request for POST /v1/key/export

addressstring
wallet_handle_tokenstring
wallet_passwordstring

Response

200OK

Response to POST /v1/key/export

Authorization

api-keyAuthapiKey in header

Import a key

POST
https://algo.nownodes.io/v1/key/import

Import an externally generated key into the wallet. Note that if you wish to back up the imported key, you must do so by backing up the entire wallet database, because imported keys were not derived from the wallet's master derivation key.

Body

application/json

APIV1POSTKeyImportRequest is the request for POST /v1/key/import

private_keyArray<integer>
wallet_handle_tokenstring

Response

200OK

Response to POST /v1/key/import

Authorization

api-keyAuthapiKey in header

List keys in wallet

POST
https://algo.nownodes.io/v1/key/list

Lists all of the public keys in this wallet. All of them have a stored private key.

Body

application/json

APIV1POSTKeyListRequest is the request for POST /v1/key/list

wallet_handle_tokenstring

Response

200OK

Response to POST /v1/key/list

Authorization

api-keyAuthapiKey in header

Master-key

Export the master derivation key from a wallet

POST
https://algo.nownodes.io/v1/master-key/export

Export the master derivation key from the wallet. This key is a master "backup" key for the underlying wallet. With it, you can regenerate all of the wallets that have been generated with this wallet's POST /v1/key endpoint. This key will not allow you to recover keys imported from other wallets, however.

Body

application/json

APIV1POSTMasterKeyExportRequest is the request for POST /v1/master-key/export

wallet_handle_tokenstring
wallet_passwordstring

Response

200OK

Response to POST /v1/master-key/export

Authorization

api-keyAuthapiKey in header

Multisig

Export multisig address metadata

POST
https://algo.nownodes.io/v1/multisig/export

Given a multisig address whose preimage this wallet stores, returns the information used to generate the address, including public keys, threshold, and multisig version.

Body

application/json

APIV1POSTMultisigExportRequest is the request for POST /v1/multisig/export

addressstring
wallet_handle_tokenstring

Response

200OK

Response to POST /v1/multisig/export

Authorization

api-keyAuthapiKey in header

Import a multisig account

POST
https://algo.nownodes.io/v1/multisig/import

Generates a multisig account from the passed public keys array and multisig metadata, and stores all of this in the wallet.

Body

application/json

APIV1POSTMultisigImportRequest is the request for POST /v1/multisig/import

multisig_versioninteger<uint8>
pksArray<PublicKey>
thresholdinteger<uint8>
wallet_handle_tokenstring

Response

200OK

Response to POST /v1/multisig/import

Authorization

api-keyAuthapiKey in header

List multisig accounts

POST
https://algo.nownodes.io/v1/multisig/list

Lists all of the multisig accounts whose preimages this wallet stores

Body

application/json

APIV1POSTMultisigListRequest is the request for POST /v1/multisig/list

wallet_handle_tokenstring

Response

200OK

Response to POST /v1/multisig/list

Authorization

api-keyAuthapiKey in header

Sign a multisig transaction

POST
https://algo.nownodes.io/v1/multisig/sign

Start a multisig signature, or add a signature to a partially completed multisig signature object.

Body

application/json

APIV1POSTMultisigTransactionSignRequest is the request for POST /v1/multisig/sign

partial_multisigMultisigSig

MultisigSig is the structure that holds multiple Subsigs

Show child attributes
SubsigsArray<MultisigSubsig>
Show child attributes
KeyArray<integer>
SigArray<integer>
Thresholdinteger<uint8>
Versioninteger<uint8>
public_keyArray<integer>
signerArray<integer>
transactionstring<byte>
wallet_handle_tokenstring
wallet_passwordstring

Response

200OK

Response to POST /v1/multisig/sign

Authorization

api-keyAuthapiKey in header

Sign a program for a multisig account

POST
https://algo.nownodes.io/v1/multisig/signprogram

Start a multisig signature, or add a signature to a partially completed multisig signature object.

Body

application/json

APIV1POSTMultisigProgramSignRequest is the request for POST /v1/multisig/signprogram

addressstring
datastring<byte>
partial_multisigMultisigSig

MultisigSig is the structure that holds multiple Subsigs

Show child attributes
SubsigsArray<MultisigSubsig>
Show child attributes
KeyArray<integer>
SigArray<integer>
Thresholdinteger<uint8>
Versioninteger<uint8>
public_keyArray<integer>
wallet_handle_tokenstring
wallet_passwordstring

Response

200OK

Response to POST /v1/multisig/signdata

Authorization

api-keyAuthapiKey in header

Program

Sign program

POST
https://algo.nownodes.io/v1/program/sign

Signs the passed program with a key from the wallet, determined by the account named in the request.

Body

application/json

APIV1POSTProgramSignRequest is the request for POST /v1/program/sign

addressstring
datastring<byte>
wallet_handle_tokenstring
wallet_passwordstring

Response

200OK

Response to POST /v1/data/sign

Authorization

api-keyAuthapiKey in header

Transaction

Sign a transaction

POST
https://algo.nownodes.io/v1/transaction/sign

Signs the passed transaction with a key from the wallet, determined by the sender encoded in the transaction.

Body

application/json

APIV1POSTTransactionSignRequest is the request for POST /v1/transaction/sign

public_keyArray<integer>
transactionstring<byte>

Base64 encoding of msgpack encoding of a Transaction object Note: SDK and goal usually generate SignedTxn objects in that case, the field txn / Transaction of the generated SignedTxn object needs to be used

wallet_handle_tokenstring
wallet_passwordstring

Response

200OK

Response to POST /v1/transaction/sign

Authorization

api-keyAuthapiKey in header

Wallet

Create a wallet

POST
https://algo.nownodes.io/v1/wallet

Create a new wallet (collection of keys) with the given parameters.

Body

application/json

APIV1POSTWalletRequest is the request for POST /v1/wallet

master_derivation_keyArray<integer>

MasterDerivationKey is used to derive ed25519 keys for use in wallets

wallet_driver_namestring
wallet_namestring
wallet_passwordstring

Response

200OK

Response to POST /v1/wallet

Authorization

api-keyAuthapiKey in header

Get wallet info

POST
https://algo.nownodes.io/v1/wallet/info

Returns information about the wallet associated with the passed wallet handle token. Additionally returns expiration information about the token itself.

Body

application/json

APIV1POSTWalletInfoRequest is the request for POST /v1/wallet/info

wallet_handle_tokenstring

Response

200OK

Response to POST /v1/wallet/info

Authorization

api-keyAuthapiKey in header

Initialize a wallet handle token

POST
https://algo.nownodes.io/v1/wallet/init

Unlock the wallet and return a wallet handle token that can be used for subsequent operations. These tokens expire periodically and must be renewed. You can POST the token to /v1/wallet/info to see how much time remains until expiration, and renew it with /v1/wallet/renew. When you're done, you can invalidate the token with /v1/wallet/release.

Body

application/json

APIV1POSTWalletInitRequest is the request for POST /v1/wallet/init

wallet_idstring
wallet_passwordstring

Response

200OK

Response to POST /v1/wallet/init

Authorization

api-keyAuthapiKey in header

Release a wallet handle token

POST
https://algo.nownodes.io/v1/wallet/release

Invalidate the passed wallet handle token, making it invalid for use in subsequent requests.

Body

application/json

APIV1POSTWalletReleaseRequest is the request for POST /v1/wallet/release

wallet_handle_tokenstring

Response

200OK

Response to POST /v1/wallet/release

Authorization

api-keyAuthapiKey in header

Rename a wallet

POST
https://algo.nownodes.io/v1/wallet/rename

Rename the underlying wallet to something else

Body

application/json

APIV1POSTWalletRenameRequest is the request for POST /v1/wallet/rename

wallet_idstring
wallet_namestring
wallet_passwordstring

Response

200OK

Response to POST /v1/wallet/rename

Authorization

api-keyAuthapiKey in header

Renew a wallet handle token

POST
https://algo.nownodes.io/v1/wallet/renew

Renew a wallet handle token, increasing its expiration duration to its initial value

Body

application/json

APIV1POSTWalletRenewRequest is the request for POST /v1/wallet/renew

wallet_handle_tokenstring

Response

200OK

Response POST /v1/wallet/renew

Authorization

api-keyAuthapiKey in header

Wallets

List wallets

GET
https://algo.nownodes.io/v1/wallets

Lists all of the wallets that kmd is aware of.

Body

application/json

APIV1GETWalletsRequest is the request for GET /v1/wallets

ListWalletsRequest

Response

200OK

Response to GET /v1/wallets

Authorization

api-keyAuthapiKey in header

Indexer

Health

Returns 200 if healthy.

GET
https://algo.nownodes.io/health

Response

200OK

(empty)

default

Unknown Error

Authorization

api-keyAuthapiKey in header

Accounts

GET
https://algo.nownodes.io/v2/accounts

Search for accounts.

Parameters

asset-idintegerquery

Asset ID

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

currency-greater-thanintegerquery

Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

excludeArray<string>allassetscreated-assetsapps-local-statecreated-appsnonequery

Exclude additional items such as asset holdings, application local data stored for this account, asset parameters created by this account, and application parameters created by this account.

currency-less-thanintegerquery

Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

auth-addrstringquery

Include accounts configured to use this spending key.

roundintegerquery

Include results for the specified round. For performance reasons, this parameter may be disabled on some configurations. Using application-id or asset-id filters will return both creator and opt-in accounts. Filtering by include-all will return creator and opt-in accounts for deleted assets and accounts. Non-opt-in managers are not included in the results when asset-id is used.

application-idintegerquery

Application ID

Response

200OK

(empty)

400Bad Request

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/accounts/{account-id}

Lookup account information.

Parameters

account-idstringrequiredpath

account string

roundintegerquery

Include results for the specified round.

include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

excludeArray<string>allassetscreated-assetsapps-local-statecreated-appsnonequery

Exclude additional items such as asset holdings, application local data stored for this account, asset parameters created by this account, and application parameters created by this account.

Response

200OK

(empty)

400Bad Request

Response for errors

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/accounts/{account-id}/apps-local-state

Lookup an account's asset holdings, optionally for a specific ID.

Parameters

account-idstringrequiredpath

account string

application-idintegerquery

Application ID

include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

Response

200OK

(empty)

400Bad Request

Response for errors

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/accounts/{account-id}/assets

Lookup an account's asset holdings, optionally for a specific ID.

Parameters

account-idstringrequiredpath

account string

asset-idintegerquery

Asset ID

include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

Response

200OK

(empty)

400Bad Request

Response for errors

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/accounts/{account-id}/created-applications

Lookup an account's created application parameters, optionally for a specific ID.

Parameters

account-idstringrequiredpath

account string

application-idintegerquery

Application ID

include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

Response

200OK

(empty)

400Bad Request

Response for errors

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/accounts/{account-id}/created-assets

Lookup an account's created asset parameters, optionally for a specific ID.

Parameters

account-idstringrequiredpath

account string

asset-idintegerquery

Asset ID

include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

Response

200OK

(empty)

400Bad Request

Response for errors

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/accounts/{account-id}/transactions

Lookup account transactions. Transactions are returned newest to oldest.

Parameters

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

note-prefixstringquery

Specifies a prefix which must be contained in the note field.

tx-typestringpaykeyregacfgaxferafrzapplstpfquery
sig-typestringsigmsiglsigquery

SigType filters just results using the specified type of signature:

  • sig - Standard
  • msig - MultiSig
  • lsig - LogicSig
txidstringquery

Lookup the specific transaction by ID.

roundintegerquery

Include results for the specified round.

min-roundintegerquery

Include results at or after the specified min-round.

max-roundintegerquery

Include results at or before the specified max-round.

asset-idintegerquery

Asset ID

before-timestring<date-time>query

Include results before the given time. Must be an RFC 3339 formatted string.

after-timestring<date-time>query

Include results after the given time. Must be an RFC 3339 formatted string.

currency-greater-thanintegerquery

Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

currency-less-thanintegerquery

Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

account-idstringrequiredpath

account string

rekey-tobooleanquery

Include results which include the rekey-to field.

Response

200OK

(empty)

400Bad Request

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header

Applications

GET
https://algo.nownodes.io/v2/applications

Search for applications

Parameters

application-idintegerquery

Application ID

creatorstringquery

Filter just applications with the given creator address.

include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

Response

200OK

(empty)

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/applications/{application-id}

Lookup application.

Parameters

application-idintegerrequiredpath
include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

Response

200OK

(empty)

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header

Get box information for a given application.

GET
https://algo.nownodes.io/v2/applications/{application-id}/box

Given an application ID and box name, returns base64 encoded box name and value. Box names must be in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, encode base 64 and use 'b64' prefix as in 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.

Parameters

application-idintegerrequiredpath
namestringrequiredquery

A box name in goal-arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.

Response

200OK

Box information

400Bad Request

Response for errors

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header

Get box names for a given application.

GET
https://algo.nownodes.io/v2/applications/{application-id}/boxes

Given an application ID, returns the box names of that application sorted lexicographically.

Parameters

application-idintegerrequiredpath
limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

Response

200OK

Box names of an application

400Bad Request

Response for errors

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/applications/{application-id}/logs

Lookup application logs.

Parameters

application-idintegerrequiredpath
limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

txidstringquery

Lookup the specific transaction by ID.

min-roundintegerquery

Include results at or after the specified min-round.

max-roundintegerquery

Include results at or before the specified max-round.

sender-addressstringquery

Only include transactions with this sender address.

Response

200OK

(empty)

Authorization

api-keyAuthapiKey in header

Assets

GET
https://algo.nownodes.io/v2/assets

Search for assets.

Parameters

include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

creatorstringquery

Filter just assets with the given creator address.

namestringquery

Filter just assets with the given name.

unitstringquery

Filter just assets with the given unit.

asset-idintegerquery

Asset ID

Response

200OK

(empty)

400Bad Request

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/assets/{asset-id}

Lookup asset information.

Parameters

asset-idintegerrequiredpath
include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

Response

200OK

(empty)

400Bad Request

Response for errors

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/assets/{asset-id}/balances

Lookup the list of accounts who hold this asset

Parameters

include-allbooleanquery

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

currency-greater-thanintegerquery

Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

currency-less-thanintegerquery

Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

asset-idintegerrequiredpath

Response

200OK

(empty)

400Bad Request

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/assets/{asset-id}/transactions

Lookup transactions for an asset. Transactions are returned oldest to newest.

Parameters

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

note-prefixstringquery

Specifies a prefix which must be contained in the note field.

tx-typestringpaykeyregacfgaxferafrzapplstpfquery
sig-typestringsigmsiglsigquery

SigType filters just results using the specified type of signature:

  • sig - Standard
  • msig - MultiSig
  • lsig - LogicSig
txidstringquery

Lookup the specific transaction by ID.

roundintegerquery

Include results for the specified round.

min-roundintegerquery

Include results at or after the specified min-round.

max-roundintegerquery

Include results at or before the specified max-round.

before-timestring<date-time>query

Include results before the given time. Must be an RFC 3339 formatted string.

after-timestring<date-time>query

Include results after the given time. Must be an RFC 3339 formatted string.

currency-greater-thanintegerquery

Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

currency-less-thanintegerquery

Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

addressstringquery

Only include transactions with this address in one of the transaction fields.

address-rolestringsenderreceiverfreeze-targetquery

Combine with the address parameter to define what type of address to search for.

exclude-close-tobooleanquery

Combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true.

asset-idintegerrequiredpath
rekey-tobooleanquery

Include results which include the rekey-to field.

Response

200OK

(empty)

400Bad Request

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header

Blocks

GET
https://algo.nownodes.io/v2/blocks/{round-number}

Lookup block.

Parameters

round-numberintegerrequiredpath

Round number

header-onlybooleanquery

Header only flag. When this is set to true, returned block does not contain the transactions

Response

200OK

(empty)

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header

Transactions

GET
https://algo.nownodes.io/v2/transactions

Search for transactions. Transactions are returned oldest to newest unless the address parameter is used, in which case results are returned newest to oldest.

Parameters

limitintegerquery

Maximum number of results to return. There could be additional pages even if the limit is not reached.

nextstringquery

The next page of results. Use the next token provided by the previous results.

note-prefixstringquery

Specifies a prefix which must be contained in the note field.

tx-typestringpaykeyregacfgaxferafrzapplstpfquery
sig-typestringsigmsiglsigquery

SigType filters just results using the specified type of signature:

  • sig - Standard
  • msig - MultiSig
  • lsig - LogicSig
txidstringquery

Lookup the specific transaction by ID.

roundintegerquery

Include results for the specified round.

min-roundintegerquery

Include results at or after the specified min-round.

max-roundintegerquery

Include results at or before the specified max-round.

asset-idintegerquery

Asset ID

before-timestring<date-time>query

Include results before the given time. Must be an RFC 3339 formatted string.

after-timestring<date-time>query

Include results after the given time. Must be an RFC 3339 formatted string.

currency-greater-thanintegerquery

Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

currency-less-thanintegerquery

Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.

addressstringquery

Only include transactions with this address in one of the transaction fields.

address-rolestringsenderreceiverfreeze-targetquery

Combine with the address parameter to define what type of address to search for.

exclude-close-tobooleanquery

Combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true.

rekey-tobooleanquery

Include results which include the rekey-to field.

application-idintegerquery

Application ID

Response

200OK

(empty)

400Bad Request

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header
GET
https://algo.nownodes.io/v2/transactions/{txid}

Lookup a single transaction.

Parameters

txidstringrequiredpath

Response

200OK

(empty)

400Bad Request

Response for errors

404Not Found

Response for errors

500Internal Server Error

Response for errors

Authorization

api-keyAuthapiKey in header