searchForTransactions
GET /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
Query Parameters
Maximum number of results to return. There could be additional pages even if the limit is not reached.
The next page of results. Use the next token provided by the previous results.
Specifies a prefix which must be contained in the note field.
SigType filters just results using the specified type of signature:
- sig - Standard
- msig - MultiSig
- lsig - LogicSig
Lookup the specific transaction by ID.
Include results for the specified round.
Include results at or after the specified min-round.
Include results at or before the specified max-round.
Asset ID
Include results before the given time. Must be an RFC 3339 formatted string.
Include results after the given time. Must be an RFC 3339 formatted string.
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.
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.
Only include transactions with this address in one of the transaction fields.
Combine with the address parameter to define what type of address to search for.
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.
Include results which include the rekey-to field.
Application ID
Responses
200
(empty)
object
Round at which the results were computed.
Used for pagination, when making another request provide this token with the next parameter.
Contains all fields common to all transactions and serves as an envelope to all transactions type. Represents both regular and inner transactions.
Definition: data/transactions/signedtxn.go : SignedTxn data/transactions/transaction.go : Transaction
object
Fields for application transactions.
Definition: data/transactions/application.go : ApplicationCallTxnFields
object
[apat] List of accounts in addition to the sender that may be accessed from the application’s approval-program and clear-state-program.
[apaa] transaction specific arguments accessed from the application’s approval-program and clear-state-program.
[apid] ID of the application being configured or empty if creating.
[apap] Logic executed for every application transaction, except when on-completion is set to “clear”. It can read and write global state for the application, as well as account-specific local state. Approval programs may reject the transaction.
[apsu] Logic executed for application transactions with on-completion set to “clear”. It can read and write global state for the application, as well as account-specific local state. Clear state programs cannot reject the transaction.
[epp] specifies the additional app program len requested in pages.
[apfa] Lists the applications in addition to the application-id whose global states may be accessed by this application’s approval-program and clear-state-program. The access is read-only.
[apas] lists the assets whose parameters may be accessed by this application’s ApprovalProgram and ClearStateProgram. The access is read-only.
Represents a [apls] local-state or [apgs] global-state schema. These schemas determine how much storage may be used in a local-state or global-state for an application. The more space used, the larger minimum balance must be maintained in the account holding the data.
object
Maximum number of TEAL byte slices that may be stored in the key/value store.
Maximum number of TEAL uints that may be stored in the key/value store.
Represents a [apls] local-state or [apgs] global-state schema. These schemas determine how much storage may be used in a local-state or global-state for an application. The more space used, the larger minimum balance must be maintained in the account holding the data.
object
Maximum number of TEAL byte slices that may be stored in the key/value store.
Maximum number of TEAL uints that may be stored in the key/value store.
[apan] defines the what additional actions occur with the transaction.
Valid types:
- noop
- optin
- closeout
- clear
- update
- update
- delete
Fields for asset allocation, re-configuration, and destruction.
A zero value for asset-id indicates asset creation. A zero value for the params indicates asset destruction.
Definition: data/transactions/asset.go : AssetConfigTxnFields
object
[xaid] ID of the asset being configured or empty if creating.
AssetParams specifies the parameters for an asset.
[apar] when part of an AssetConfig transaction.
Definition: data/transactions/asset.go : AssetParams
object
Address of account used to clawback holdings of this asset. If empty, clawback is not permitted.
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.
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).
Whether holdings of this asset are frozen by default.
Address of account used to freeze holdings of this asset. If empty, freezing is not permitted.
Address of account used to manage the keys of this asset and to destroy it.
A commitment to some unspecified asset metadata. The format of this metadata is up to the application.
Name of this asset, as supplied by the creator. Included only when the asset name is composed of printable utf-8 characters.
Base64 encoded name of this asset, as supplied by the creator.
Address of account holding reserve (non-minted) units of this asset.
The total number of units of this asset.
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.
Base64 encoded name of a unit of this asset, as supplied by the creator.
URL where more information about the asset can be retrieved. Included only when the URL is composed of printable utf-8 characters.
Base64 encoded URL where more information about the asset can be retrieved.
Fields for an asset freeze transaction.
Definition: data/transactions/asset.go : AssetFreezeTxnFields
object
[fadd] Address of the account whose asset is being frozen or thawed.
[faid] ID of the asset being frozen or thawed.
[afrz] The new freeze status.
Fields for an asset transfer transaction.
Definition: data/transactions/asset.go : AssetTransferTxnFields
object
[aamt] Amount of asset to transfer. A zero amount transferred to self allocates that asset in the account’s Assets map.
[xaid] ID of the asset being transferred.
Number of assets transferred to the close-to account as part of the transaction.
[aclose] Indicates that the asset should be removed from the account’s Assets map, and specifies where the remaining asset holdings should be transferred. It’s always valid to transfer remaining asset holdings to the creator account.
[arcv] Recipient address of the transfer.
[asnd] The effective sender during a clawback transactions. If this is not a zero value, the real transaction sender must be the Clawback address from the AssetParams.
[sgnr] this is included with signed transactions when the signing address does not equal the sender. The backend can use this to ensure that auth addr is equal to the accounts auth addr.
[rc] rewards applied to close-remainder-to account.
[ca] closing amount for transaction.
Round when the transaction was confirmed.
Specifies an application index (ID) if an application was created with this transaction.
Specifies an asset index (ID) if an asset was created with this transaction.
[fee] Transaction fee.
[fv] First valid round for this transaction.
[gh] Hash of genesis block.
[gen] genesis block ID.
Application state delta.
Key-value pairs for StateDelta.
object
Represents a TEAL value delta.
object
[at] delta action.
[bs] bytes value.
[ui] uint value.
[grp] Base64 encoded byte array of a sha512/256 digest. When present indicates that this transaction is part of a transaction group and the value is the sha512/256 hash of the transactions in that group.
Fields for a heartbeat transaction.
Definition: data/transactions/heartbeat.go : HeartbeatTxnFields
object
[hbad] HbAddress is the account this txn is proving onlineness for.
[hbkd] HbKeyDilution must match HbAddress account’s current KeyDilution.
[hbprf] HbProof is a signature using HeartbeatAddress’s partkey, thereby showing it is online.
object
[p] Public key of the heartbeat message.
[p1s] Signature of OneTimeSignatureSubkeyOffsetID(PK, Batch, Offset) under the key PK2.
[p2] Key for new-style two-level ephemeral signature.
[p2s] Signature of OneTimeSignatureSubkeyBatchID(PK2, Batch) under the master key (OneTimeSignatureVerifier).
[s] Signature of the heartbeat message.
[hbsd] HbSeed must be the block seed for the this transaction’s firstValid block.
[hbvid] HbVoteID must match the HbAddress account’s current VoteID.
Transaction ID
Offset into the round where this transaction was confirmed.
Fields for a keyreg transaction.
Definition: data/transactions/keyreg.go : KeyregTxnFields
object
[nonpart] Mark the account as participating or non-participating.
[selkey] Public key used with the Verified Random Function (VRF) result during committee selection.
[sprfkey] State proof key used in key registration transactions.
[votefst] First round this participation key is valid.
[votekd] Number of subkeys in each batch of participation keys.
[votelst] Last round this participation key is valid.
[votekey] Participation public key used in key registration transactions.
[lv] Last valid round for this transaction.
[lx] Base64 encoded 32-byte array. Lease enforces mutual exclusion of transactions. If this field is nonzero, then once the transaction is confirmed, it acquires the lease identified by the (Sender, Lease) pair of the transaction until the LastValid round passes. While this transaction possesses the lease, no other transaction specifying this lease can be confirmed.
[ld] Local state key/value changes for the application being executed by this transaction.
Application state delta.
object
Application state delta.
Key-value pairs for StateDelta.
object
Represents a TEAL value delta.
object
[at] delta action.
[bs] bytes value.
[ui] uint value.
[lg] Logs for the application being executed by this transaction.
[note] Free form data.
Fields for a payment transaction.
Definition: data/transactions/payment.go : PaymentTxnFields
object
[amt] number of MicroAlgos intended to be transferred.
Number of MicroAlgos that were sent to the close-remainder-to address when closing the sender account.
[close] when set, indicates that the sending account should be closed and all remaining funds be transferred to this address.
[rcv] receiver’s address.
[rr] rewards applied to receiver account.
[rekey] when included in a valid transaction, the accounts auth addr will be updated with this value and future signatures must be signed with the key represented by this address.
Time when the block this transaction is in was confirmed.
[snd] Sender’s address.
[rs] rewards applied to sender account.
Validation signature associated with some data. Only one of the signatures should be provided.
object
[lsig] Programatic transaction signature.
Definition: data/transactions/logicsig.go
object
[arg] Logic arguments, base64 encoded.
[l] Program signed by a signature or multi signature, or hashed to be the address of ana ccount. Base64 encoded TEAL program.
[msig] structure holding multiple subsignatures.
Definition: crypto/multisig.go : MultisigSig
object
[subsig] holds pairs of public key and signatures.
object
[pk]
[s]
[thr]
[v]
[sig] ed25519 signature.
[msig] structure holding multiple subsignatures.
Definition: crypto/multisig.go : MultisigSig
object
[subsig] holds pairs of public key and signatures.
object
[pk]
[s]
[thr]
[v]
[sig] Standard ed25519 signature.
Fields for a state proof transaction.
Definition: data/transactions/stateproof.go : StateProofTxnFields
object
object
[b]
[f]
[l]
[P]
[v]
[sp] represents a state proof.
Definition: crypto/stateproof/structs.go : StateProof
object
object
object
[t]
[pth]
[td]
[pr] Sequence of reveal positions.
[r] Note that this is actually stored as a map[uint64] - Reveal in the actual msgp
object
object
object
[cmt] Represents the root of the vector commitment tree.
[lf] Key lifetime.
[w]
The position in the signature and participants arrays corresponding to this entry.
object
[l] The total weight of signatures in the lower-numbered slots.
object
object
object
[t]
[pth]
[td]
[vkey]
[v] Salt version of the merkle signature.
[c]
object
object
[t]
[pth]
[td]
[w]
[sptype] Type of the state proof. Integer representing an entry defined in protocol/stateproof.go
[type] Indicates what type of transaction this is. Different types have different fields.
Valid types, and where their fields are stored:
- [pay] payment-transaction
- [keyreg] keyreg-transaction
- [acfg] asset-config-transaction
- [axfer] asset-transfer-transaction
- [afrz] asset-freeze-transaction
- [appl] application-transaction
- [stpf] state-proof-transaction
- [hb] heartbeat-transaction
400
Response for errors
object
object
500
Response for errors