Indexer 3.9.0 to 3.10.0 API CHANGES
v1.0.0https://algo-index.nownodes.ioThis page lists what changed in the Indexer API between versions 3.9.0 and 3.10.0. Only added and changed methods are listed. Everything not mentioned here works exactly as described in the main Indexer reference. No method was removed in this release.
Added
GET /v2/applications/{application-id}/boxes— new optional query parameterinclude. Passinclude=valuesto get the content of every box in the same response.
Changed
GET /v2/applications/{application-id}/boxes— the response now also carriesround, and every entry ofboxesmay carryvalue.GET /v2/blocks/{round-number}— the block may now carrycongestion-taxandload.GET /v2/transactions,GET /v2/transactions/{txid},GET /v2/accounts/{account-id}/transactions,GET /v2/assets/{asset-id}/transactions— a transaction signature may now be a post-quantum signature:signature.pqsigandsignature.logicsig.pqsig.GET /v2/accounts,GET /v2/accounts/{account-id}— thesig-typefield of an account may now bepqsig. Thesig-typefilter of the transaction search methods accepts the same new value.- The heartbeat transaction object gained the
hb-challenge-discountfield.
About consensus version v42
Indexer 3.10.0 is the release that understands consensus version v42 (post-quantum Falcon-1024
signatures, block load tracking). Mainnet upgrades to v42 at round 64318659. Everything v42 brings —
congestion-tax, load, pqsig, hb-challenge-discount — starts appearing in responses only after
that round. The new include parameter of the box search and the round field of its response work
right away, they do not depend on the upgrade.
Indexer 3.10.0 must be run together with node 5.0.0 and Conduit 1.10.0.
Authentication
api-keyAuthapiKeyAPI Key: api-key in header
Changelog indexer 3.9.0 to 3.10.0
Accounts
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed in 3.10.0. The sig-type field of an account may now be pqsig. Returned only from consensus version v42 onwards. Mainnet upgrades to v42 at round 64318659, until then the field is never returned.
Search for accounts.
Parameters
asset-idintegerqueryAsset ID
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
currency-greater-thanintegerqueryResults 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-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
excludeArray<string>allassetscreated-assetsapps-local-statecreated-appsnonequeryExclude 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-thanintegerqueryResults 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-addrstringqueryInclude accounts configured to use this spending key.
roundintegerqueryInclude 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-idintegerqueryApplication ID
Response
(empty)
Response for errors
Response for errors
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed in 3.10.0. The sig-type field of an account may now be pqsig. Returned only from consensus version v42 onwards. Mainnet upgrades to v42 at round 64318659, until then the field is never returned.
Lookup account information.
Parameters
account-idstringrequiredpathaccount string
roundintegerqueryInclude results for the specified round.
include-allbooleanqueryInclude all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
excludeArray<string>allassetscreated-assetsapps-local-statecreated-appsnonequeryExclude 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
(empty)
Response for errors
Response for errors
Response for errors
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed in 3.10.0. A transaction signature may now be a post-quantum signature: signature.pqsig and signature.logicsig.pqsig. Returned only from consensus version v42 onwards. Mainnet upgrades to v42 at round 64318659, until then the field is never returned.
Lookup account transactions. Transactions are returned newest to oldest.
Parameters
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
note-prefixstringquerySpecifies a prefix which must be contained in the note field.
tx-typestringpaykeyregacfgaxferafrzapplstpfquerysig-typestringsigmsiglsigpqsigquerySigType filters just results using the specified type of signature:
- sig - Standard
- msig - MultiSig
- lsig - LogicSig
- pqsig - Post-Quantum
pqsig was added in 3.10.0.
txidstringqueryLookup the specific transaction by ID.
roundintegerqueryInclude results for the specified round.
min-roundintegerqueryInclude results at or after the specified min-round.
max-roundintegerqueryInclude results at or before the specified max-round.
asset-idintegerqueryAsset ID
before-timestring<date-time>queryInclude results before the given time. Must be an RFC 3339 formatted string.
after-timestring<date-time>queryInclude results after the given time. Must be an RFC 3339 formatted string.
currency-greater-thanintegerqueryResults 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-thanintegerqueryResults 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-idstringrequiredpathaccount string
rekey-tobooleanqueryInclude results which include the rekey-to field.
Response
(empty)
Response for errors
Response for errors
Applications
Get box names for a given application.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed in 3.10.0. New optional query parameter include: include=values adds the content of every box to the response. The response also carries the new round field, and every entry of boxes carries value when the values were requested. An unknown value of include is ignored, the request still succeeds.
Given an application ID, returns the box names of that application sorted lexicographically.
Parameters
application-idintegerrequiredpathlimitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
includeArray<string>valuesqueryInclude additional items in the response. Use values to include box values. Multiple values can be comma-separated. Added in 3.10.0.
Response
Box names of an application
Response for errors
Response for errors
Response for errors
Assets
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed in 3.10.0. A transaction signature may now be a post-quantum signature: signature.pqsig and signature.logicsig.pqsig. Returned only from consensus version v42 onwards. Mainnet upgrades to v42 at round 64318659, until then the field is never returned.
Lookup transactions for an asset. Transactions are returned oldest to newest.
Parameters
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
note-prefixstringquerySpecifies a prefix which must be contained in the note field.
tx-typestringpaykeyregacfgaxferafrzapplstpfquerysig-typestringsigmsiglsigpqsigquerySigType filters just results using the specified type of signature:
- sig - Standard
- msig - MultiSig
- lsig - LogicSig
- pqsig - Post-Quantum
pqsig was added in 3.10.0.
txidstringqueryLookup the specific transaction by ID.
roundintegerqueryInclude results for the specified round.
min-roundintegerqueryInclude results at or after the specified min-round.
max-roundintegerqueryInclude results at or before the specified max-round.
before-timestring<date-time>queryInclude results before the given time. Must be an RFC 3339 formatted string.
after-timestring<date-time>queryInclude results after the given time. Must be an RFC 3339 formatted string.
currency-greater-thanintegerqueryResults 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-thanintegerqueryResults 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.
addressstringqueryOnly include transactions with this address in one of the transaction fields.
address-rolestringsenderreceiverfreeze-targetqueryCombine with the address parameter to define what type of address to search for.
exclude-close-tobooleanqueryCombine 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-idintegerrequiredpathrekey-tobooleanqueryInclude results which include the rekey-to field.
Response
(empty)
Response for errors
Response for errors
Blocks
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed in 3.10.0. A block may now carry congestion-tax and load. Returned only from consensus version v42 onwards. Mainnet upgrades to v42 at round 64318659, until then the field is never returned.
Lookup block.
Parameters
round-numberintegerrequiredpathRound number
header-onlybooleanqueryHeader only flag. When this is set to true, returned block does not contain the transactions
Response
(empty)
Response for errors
Response for errors
Transactions
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed in 3.10.0. A transaction signature may now be a post-quantum signature: signature.pqsig and signature.logicsig.pqsig. Returned only from consensus version v42 onwards. Mainnet upgrades to v42 at round 64318659, until then the field is never returned.
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
limitintegerqueryMaximum number of results to return. There could be additional pages even if the limit is not reached.
nextstringqueryThe next page of results. Use the next token provided by the previous results.
note-prefixstringquerySpecifies a prefix which must be contained in the note field.
tx-typestringpaykeyregacfgaxferafrzapplstpfquerysig-typestringsigmsiglsigpqsigquerySigType filters just results using the specified type of signature:
- sig - Standard
- msig - MultiSig
- lsig - LogicSig
- pqsig - Post-Quantum
pqsig was added in 3.10.0.
txidstringqueryLookup the specific transaction by ID.
roundintegerqueryInclude results for the specified round.
min-roundintegerqueryInclude results at or after the specified min-round.
max-roundintegerqueryInclude results at or before the specified max-round.
asset-idintegerqueryAsset ID
before-timestring<date-time>queryInclude results before the given time. Must be an RFC 3339 formatted string.
after-timestring<date-time>queryInclude results after the given time. Must be an RFC 3339 formatted string.
currency-greater-thanintegerqueryResults 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-thanintegerqueryResults 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.
addressstringqueryOnly include transactions with this address in one of the transaction fields.
address-rolestringsenderreceiverfreeze-targetqueryCombine with the address parameter to define what type of address to search for.
exclude-close-tobooleanqueryCombine 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-tobooleanqueryInclude results which include the rekey-to field.
application-idintegerqueryApplication ID
Response
(empty)
Response for errors
Response for errors
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed in 3.10.0. A transaction signature may now be a post-quantum signature: signature.pqsig and signature.logicsig.pqsig. Returned only from consensus version v42 onwards. Mainnet upgrades to v42 at round 64318659, until then the field is never returned.
Lookup a single transaction.
Parameters
txidstringrequiredpathResponse
(empty)
Response for errors
Response for errors
Response for errors