indexer
Paths¶
GET /health¶
Returns 200 if healthy.
GET /health
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | HealthCheck |
default | Unknown Error | No Content |
Produces
application/json
Tags
- common
GET /v2/accounts¶
Description Search for accounts.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query | application-id optional |
Application ID | integer |
Query | asset-id optional |
Asset ID | integer |
Query | auth-addr optional |
Include accounts configured to use this spending key. | string |
Query | currency-greater-than optional |
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. | integer |
Query | currency-less-than optional |
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. | integer |
Query | exclude optional |
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. | < enum (all, assets, created-assets, apps-local-state, created-apps, none) > array |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Query | round optional |
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. | integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
accounts required |
< Account > array | |
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- search
GET /v2/accounts/{account-id}¶
Description Lookup account information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | account-id required |
account string | string |
Query | exclude optional |
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. | < enum (all, assets, created-assets, apps-local-state, created-apps, none) > array |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Query | round optional |
Include results for the specified round. | integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
account required |
Account | |
current-round required |
Round at which the results were computed. | integer |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/accounts/{account-id}/apps-local-state¶
Description Lookup an account's asset holdings, optionally for a specific ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | account-id required |
account string | string |
Query | application-id optional |
Application ID | integer |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
apps-local-states required |
< ApplicationLocalState > array | |
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/accounts/{account-id}/assets¶
Description Lookup an account's asset holdings, optionally for a specific ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | account-id required |
account string | string |
Query | asset-id optional |
Asset ID | integer |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
assets required |
< AssetHolding > array | |
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/accounts/{account-id}/created-applications¶
Description Lookup an account's created application parameters, optionally for a specific ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | account-id required |
account string | string |
Query | application-id optional |
Application ID | integer |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
applications required |
< Application > array | |
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/accounts/{account-id}/created-assets¶
Description Lookup an account's created asset parameters, optionally for a specific ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | account-id required |
account string | string |
Query | asset-id optional |
Asset ID | integer |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
assets required |
< Asset > array | |
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/accounts/{account-id}/transactions¶
Description Lookup account transactions. Transactions are returned newest to oldest.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | account-id required |
account string | string |
Query | after-time optional |
Include results after the given time. Must be an RFC 3339 formatted string. | string (date-time) |
Query | asset-id optional |
Asset ID | integer |
Query | before-time optional |
Include results before the given time. Must be an RFC 3339 formatted string. | string (date-time) |
Query | currency-greater-than optional |
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. | integer |
Query | currency-less-than optional |
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. | integer |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | max-round optional |
Include results at or before the specified max-round. | integer |
Query | min-round optional |
Include results at or after the specified min-round. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Query | note-prefix optional |
Specifies a prefix which must be contained in the note field. | string |
Query | rekey-to optional |
Include results which include the rekey-to field. | boolean |
Query | round optional |
Include results for the specified round. | integer |
Query | sig-type optional |
SigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig |
enum (sig, msig, lsig) |
Query | tx-type optional |
enum (pay, keyreg, acfg, axfer, afrz, appl, stpf) | |
Query | txid optional |
Lookup the specific transaction by ID. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
transactions required |
< Transaction > array |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/applications¶
Description Search for applications
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query | application-id optional |
Application ID | integer |
Query | creator optional |
Filter just applications with the given creator address. | string |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
applications required |
< Application > array | |
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- search
GET /v2/applications/{application-id}¶
Description Lookup application.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | application-id required |
integer | |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
application optional |
Application | |
current-round required |
Round at which the results were computed. | integer |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/applications/{application-id}/box¶
Get box information for a given application.
GET /v2/applications/{application-id}/box
Description 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
Type | Name | Description | Schema |
---|---|---|---|
Path | application-id required |
integer | |
Query | name required |
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...'. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Box information | Box |
400 | Response for errors | Response 400 |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/applications/{application-id}/boxes¶
Get box names for a given application.
GET /v2/applications/{application-id}/boxes
Description Given an application ID, returns the box names of that application sorted lexicographically.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | application-id required |
integer | |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Box names of an application | Response 200 |
400 | Response for errors | Response 400 |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
application-id required |
[appidx] application index. | integer |
boxes required |
< BoxDescriptor > array | |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- search
GET /v2/applications/{application-id}/logs¶
Description Lookup application logs.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | application-id required |
integer | |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | max-round optional |
Include results at or before the specified max-round. | integer |
Query | min-round optional |
Include results at or after the specified min-round. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Query | sender-address optional |
Only include transactions with this sender address. | string |
Query | txid optional |
Lookup the specific transaction by ID. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
Name | Description | Schema |
---|---|---|
application-id required |
[appidx] application index. | integer |
current-round required |
Round at which the results were computed. | integer |
log-data optional |
< ApplicationLogData > array | |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/assets¶
Description Search for assets.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query | asset-id optional |
Asset ID | integer |
Query | creator optional |
Filter just assets with the given creator address. | string |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | name optional |
Filter just assets with the given name. | string |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Query | unit optional |
Filter just assets with the given unit. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
assets required |
< Asset > array | |
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- search
GET /v2/assets/{asset-id}¶
Description Lookup asset information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | asset-id required |
integer | |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
asset required |
Asset | |
current-round required |
Round at which the results were computed. | integer |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/assets/{asset-id}/balances¶
Description Lookup the list of accounts who hold this asset
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | asset-id required |
integer | |
Query | currency-greater-than optional |
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. | integer |
Query | currency-less-than optional |
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. | integer |
Query | include-all optional |
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. | boolean |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
balances required |
< MiniAssetHolding > array | |
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/assets/{asset-id}/transactions¶
Description Lookup transactions for an asset. Transactions are returned oldest to newest.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | asset-id required |
integer | |
Query | address optional |
Only include transactions with this address in one of the transaction fields. | string |
Query | address-role optional |
Combine with the address parameter to define what type of address to search for. | enum (sender, receiver, freeze-target) |
Query | after-time optional |
Include results after the given time. Must be an RFC 3339 formatted string. | string (date-time) |
Query | before-time optional |
Include results before the given time. Must be an RFC 3339 formatted string. | string (date-time) |
Query | currency-greater-than optional |
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. | integer |
Query | currency-less-than optional |
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. | integer |
Query | exclude-close-to optional |
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. | boolean |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | max-round optional |
Include results at or before the specified max-round. | integer |
Query | min-round optional |
Include results at or after the specified min-round. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Query | note-prefix optional |
Specifies a prefix which must be contained in the note field. | string |
Query | rekey-to optional |
Include results which include the rekey-to field. | boolean |
Query | round optional |
Include results for the specified round. | integer |
Query | sig-type optional |
SigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig |
enum (sig, msig, lsig) |
Query | tx-type optional |
enum (pay, keyreg, acfg, axfer, afrz, appl, stpf) | |
Query | txid optional |
Lookup the specific transaction by ID. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
transactions required |
< Transaction > array |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/blocks/{round-number}¶
Description Lookup block.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | round-number required |
Round number | integer |
Query | header-only optional |
Header only flag. When this is set to true, returned block does not contain the transactions | boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Block |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
GET /v2/transactions¶
Description 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
Type | Name | Description | Schema |
---|---|---|---|
Query | address optional |
Only include transactions with this address in one of the transaction fields. | string |
Query | address-role optional |
Combine with the address parameter to define what type of address to search for. | enum (sender, receiver, freeze-target) |
Query | after-time optional |
Include results after the given time. Must be an RFC 3339 formatted string. | string (date-time) |
Query | application-id optional |
Application ID | integer |
Query | asset-id optional |
Asset ID | integer |
Query | before-time optional |
Include results before the given time. Must be an RFC 3339 formatted string. | string (date-time) |
Query | currency-greater-than optional |
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. | integer |
Query | currency-less-than optional |
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. | integer |
Query | exclude-close-to optional |
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. | boolean |
Query | limit optional |
Maximum number of results to return. There could be additional pages even if the limit is not reached. | integer |
Query | max-round optional |
Include results at or before the specified max-round. | integer |
Query | min-round optional |
Include results at or after the specified min-round. | integer |
Query | next optional |
The next page of results. Use the next token provided by the previous results. | string |
Query | note-prefix optional |
Specifies a prefix which must be contained in the note field. | string |
Query | rekey-to optional |
Include results which include the rekey-to field. | boolean |
Query | round optional |
Include results for the specified round. | integer |
Query | sig-type optional |
SigType filters just results using the specified type of signature: * sig - Standard * msig - MultiSig * lsig - LogicSig |
enum (sig, msig, lsig) |
Query | tx-type optional |
enum (pay, keyreg, acfg, axfer, afrz, appl, stpf) | |
Query | txid optional |
Lookup the specific transaction by ID. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
current-round required |
Round at which the results were computed. | integer |
next-token optional |
Used for pagination, when making another request provide this token with the next parameter. | string |
transactions required |
< Transaction > array |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- search
GET /v2/transactions/{txid}¶
Description Lookup a single transaction.
Parameters
Type | Name | Schema |
---|---|---|
Path | txid required |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | (empty) | Response 200 |
400 | Response for errors | Response 400 |
404 | Response for errors | Response 404 |
500 | Response for errors | Response 500 |
Name | Description | Schema |
---|---|---|
current-round required |
Round at which the results were computed. | integer |
transaction required |
Transaction |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Name | Schema |
---|---|
data optional |
object |
message required |
string |
Consumes
application/json
Produces
application/json
Tags
- lookup
Definitions¶
Account¶
Account information at a given round.
Definition: data/basics/userBalance.go : AccountData
Name | Description | Schema |
---|---|---|
address required |
the account public key | string |
amount required |
[algo] total number of MicroAlgos in the account | integer |
amount-without-pending-rewards required |
specifies the amount of MicroAlgos in the account, without the pending rewards. | integer |
apps-local-state optional |
[appl] applications local data stored in this account. Note the raw object uses map[int] -> AppLocalState for this type. |
< ApplicationLocalState > array |
apps-total-extra-pages optional |
[teap] the sum of all extra application program pages for this account. | integer |
apps-total-schema optional |
[tsch] stores the sum of all of the local schemas and global schemas in this account. Note: the raw account uses StateSchema for this type. |
ApplicationStateSchema |
assets optional |
[asset] assets held by this account. Note the raw object uses map[int] -> AssetHolding for this type. |
< AssetHolding > array |
auth-addr optional |
[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. | string |
closed-at-round optional |
Round during which this account was most recently closed. | integer |
created-apps optional |
[appp] parameters of applications created by this account including app global data. Note: the raw account uses map[int] -> AppParams for this type. |
< Application > array |
created-assets optional |
[apar] parameters of assets created by this account. Note: the raw account uses map[int] -> Asset for this type. |
< Asset > array |
created-at-round optional |
Round during which this account first appeared in a transaction. | integer |
deleted optional |
Whether or not this account is currently closed. | boolean |
participation optional |
AccountParticipation | |
pending-rewards required |
amount of MicroAlgos of pending rewards in this account. | integer |
reward-base optional |
[ebase] used as part of the rewards computation. Only applicable to accounts which are participating. | integer |
rewards required |
[ern] total rewards of MicroAlgos the account has received, including pending rewards. | integer |
round required |
The round for which this information is relevant. | integer |
sig-type optional |
Indicates what type of signature is used by this account, must be one of: * sig * msig * lsig * or null if unknown |
enum (sig, msig, lsig) |
status required |
[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. |
string |
total-apps-opted-in required |
The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account. | integer |
total-assets-opted-in required |
The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account. | integer |
total-box-bytes required |
For app-accounts only. The total number of bytes allocated for the keys and values of boxes which belong to the associated application. | integer |
total-boxes required |
For app-accounts only. The total number of boxes which belong to the associated application. | integer |
total-created-apps required |
The count of all apps (AppParams objects) created by this account. | integer |
total-created-assets required |
The count of all assets (AssetParams objects) created by this account. | integer |
AccountParticipation¶
AccountParticipation describes the parameters used by this account in consensus protocol.
Name | Description | Schema |
---|---|---|
selection-participation-key required |
[sel] Selection public key (if any) currently registered for this round. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
state-proof-key optional |
[stprf] Root of the state proof key (if any) Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
vote-first-valid required |
[voteFst] First round for which this participation is valid. | integer |
vote-key-dilution required |
[voteKD] Number of subkeys in each batch of participation keys. | integer |
vote-last-valid required |
[voteLst] Last round for which this participation is valid. | integer |
vote-participation-key required |
[vote] root participation public key (if any) currently registered for this round. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
AccountStateDelta¶
Application state delta.
Name | Schema |
---|---|
address required |
string |
delta required |
StateDelta |
Application¶
Application index and its parameters
Name | Description | Schema |
---|---|---|
created-at-round optional |
Round when this application was created. | integer |
deleted optional |
Whether or not this application is currently deleted. | boolean |
deleted-at-round optional |
Round when this application was deleted. | integer |
id required |
[appidx] application index. | integer |
params required |
[appparams] application parameters. | ApplicationParams |
ApplicationLocalState¶
Stores local state associated with an application.
Name | Description | Schema |
---|---|---|
closed-out-at-round optional |
Round when account closed out of the application. | integer |
deleted optional |
Whether or not the application local state is currently deleted from its account. | boolean |
id required |
The application which this local state is for. | integer |
key-value optional |
[tkv] storage. | TealKeyValueStore |
opted-in-at-round optional |
Round when the account opted into the application. | integer |
schema required |
[hsch] schema. | ApplicationStateSchema |
ApplicationLogData¶
Stores the global information associated with an application.
Name | Description | Schema |
---|---|---|
logs required |
[lg] Logs for the application being executed by the transaction. | < string (byte) > array |
txid required |
Transaction ID | string |
ApplicationParams¶
Stores the global information associated with an application.
Name | Description | Schema |
---|---|---|
approval-program required |
[approv] approval program. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
clear-state-program required |
[clearp] approval program. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
creator optional |
The address that created this application. This is the address where the parameters and global state for this application can be found. | string |
extra-program-pages optional |
[epp] the amount of extra program pages available to this app. | integer |
global-state optional |
[\gs] global schema | TealKeyValueStore |
global-state-schema optional |
[\gsch] global schema | ApplicationStateSchema |
local-state-schema optional |
[\lsch] local schema | ApplicationStateSchema |
ApplicationStateSchema¶
Specifies maximums on the number of each type that may be stored.
Name | Description | Schema |
---|---|---|
num-byte-slice required |
[nbs] num of byte slices. | integer |
num-uint required |
[nui] num of uints. | integer |
Asset¶
Specifies both the unique identifier and the parameters for an asset
Name | Description | Schema |
---|---|---|
created-at-round optional |
Round during which this asset was created. | integer |
deleted optional |
Whether or not this asset is currently deleted. | boolean |
destroyed-at-round optional |
Round during which this asset was destroyed. | integer |
index required |
unique asset identifier | integer |
params required |
AssetParams |
AssetHolding¶
Describes an asset held by an account.
Definition: data/basics/userBalance.go : AssetHolding
Name | Description | Schema |
---|---|---|
amount required |
[a] number of units held. | integer |
asset-id required |
Asset ID of the holding. | integer |
deleted optional |
Whether or not the asset holding is currently deleted from its account. | boolean |
is-frozen required |
[f] whether or not the holding is frozen. | boolean |
opted-in-at-round optional |
Round during which the account opted into this asset holding. | integer |
opted-out-at-round optional |
Round during which the account opted out of this asset holding. | integer |
AssetParams¶
AssetParams specifies the parameters for an asset.
[apar] when part of an AssetConfig transaction.
Definition: data/transactions/asset.go : AssetParams
Name | Description | Schema |
---|---|---|
clawback optional |
[c] Address of account used to clawback holdings of this asset. If empty, clawback is not permitted. | string |
creator required |
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. | string |
decimals 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). Minimum value : 0 Maximum value : 19 |
integer |
default-frozen optional |
[df] Whether holdings of this asset are frozen by default. | boolean |
freeze optional |
[f] Address of account used to freeze holdings of this asset. If empty, freezing is not permitted. | string |
manager optional |
[m] Address of account used to manage the keys of this asset and to destroy it. | string |
metadata-hash optional |
[am] A commitment to some unspecified asset metadata. The format of this metadata is up to the application. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
name optional |
[an] Name of this asset, as supplied by the creator. Included only when the asset name is composed of printable utf-8 characters. | string |
name-b64 optional |
Base64 encoded name of this asset, as supplied by the creator. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
reserve optional |
[r] Address of account holding reserve (non-minted) units of this asset. | string |
total required |
[t] The total number of units of this asset. | integer |
unit-name optional |
[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. | string |
unit-name-b64 optional |
Base64 encoded name of a unit of this asset, as supplied by the creator. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
url optional |
[au] URL where more information about the asset can be retrieved. Included only when the URL is composed of printable utf-8 characters. | string |
url-b64 optional |
Base64 encoded URL where more information about the asset can be retrieved. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
Block¶
Block information.
Definition: data/bookkeeping/block.go : Block
Name | Description | Schema |
---|---|---|
genesis-hash required |
[gh] hash to which this block belongs. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
genesis-id required |
[gen] ID to which this block belongs. | string |
participation-updates optional |
ParticipationUpdates | |
previous-block-hash required |
[prev] Previous block hash. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
rewards optional |
BlockRewards | |
round required |
[rnd] Current round on which this block was appended to the chain. | integer |
seed required |
[seed] Sortition seed. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
state-proof-tracking optional |
Tracks the status of state proofs. | < StateProofTracking > array |
timestamp required |
[ts] Block creation timestamp in seconds since eposh | integer |
transactions optional |
[txns] list of transactions corresponding to a given round. | < Transaction > array |
transactions-root required |
[txn] TransactionsRoot authenticates the set of transactions appearing in the block. More specifically, it's the root of a merkle tree whose leaves are the block's Txids, in lexicographic order. For the empty block, it's 0. Note that the TxnRoot does not authenticate the signatures on the transactions, only the transactions themselves. Two blocks with the same transactions but in a different order and with different signatures will have the same TxnRoot. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
transactions-root-sha256 required |
[txn256] TransactionsRootSHA256 is an auxiliary TransactionRoot, built using a vector commitment instead of a merkle tree, and SHA256 hash function instead of the default SHA512_256. This commitment can be used on environments where only the SHA256 function exists. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
txn-counter optional |
[tc] TxnCounter counts the number of transactions committed in the ledger, from the time at which support for this feature was introduced. Specifically, TxnCounter is the number of the next transaction that will be committed after this block. It is 0 when no transactions have ever been committed (since TxnCounter started being supported). |
integer |
upgrade-state optional |
BlockUpgradeState | |
upgrade-vote optional |
BlockUpgradeVote |
BlockRewards¶
Fields relating to rewards,
Name | Description | Schema |
---|---|---|
fee-sink required |
[fees] accepts transaction fees, it can only spend to the incentive pool. | string |
rewards-calculation-round required |
[rwcalr] number of leftover MicroAlgos after the distribution of rewards-rate MicroAlgos for every reward unit in the next round. | integer |
rewards-level required |
[earn] How many rewards, in MicroAlgos, have been distributed to each RewardUnit of MicroAlgos since genesis. | integer |
rewards-pool required |
[rwd] accepts periodic injections from the fee-sink and continually redistributes them as rewards. | string |
rewards-rate required |
[rate] Number of new MicroAlgos added to the participation stake from rewards at the next round. | integer |
rewards-residue required |
[frac] Number of leftover MicroAlgos after the distribution of RewardsRate/rewardUnits MicroAlgos for every reward unit in the next round. | integer |
BlockUpgradeState¶
Fields relating to a protocol upgrade.
Name | Description | Schema |
---|---|---|
current-protocol required |
[proto] The current protocol version. | string |
next-protocol optional |
[nextproto] The next proposed protocol version. | string |
next-protocol-approvals optional |
[nextyes] Number of blocks which approved the protocol upgrade. | integer |
next-protocol-switch-on optional |
[nextswitch] Round on which the protocol upgrade will take effect. | integer |
next-protocol-vote-before optional |
[nextbefore] Deadline round for this protocol upgrade (No votes will be consider after this round). | integer |
BlockUpgradeVote¶
Fields relating to voting for a protocol upgrade.
Name | Description | Schema |
---|---|---|
upgrade-approve optional |
[upgradeyes] Indicates a yes vote for the current proposal. | boolean |
upgrade-delay optional |
[upgradedelay] Indicates the time between acceptance and execution. | integer |
upgrade-propose optional |
[upgradeprop] Indicates a proposed upgrade. | string |
Box¶
Box name and its content.
Name | Description | Schema |
---|---|---|
name required |
[name] box name, base64 encoded Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
round required |
The round for which this information is relevant | integer |
value required |
[value] box value, base64 encoded. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
BoxDescriptor¶
Box descriptor describes an app box without a value.
Name | Description | Schema |
---|---|---|
name required |
Base64 encoded box name Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
EvalDelta¶
Represents a TEAL value delta.
Name | Description | Schema |
---|---|---|
action required |
[at] delta action. | integer |
bytes optional |
[bs] bytes value. | string |
uint optional |
[ui] uint value. | integer |
EvalDeltaKeyValue¶
Key-value pairs for StateDelta.
Name | Schema |
---|---|
key required |
string |
value required |
EvalDelta |
HashFactory¶
Name | Description | Schema |
---|---|---|
hash-type optional |
[t] | integer |
Hashtype¶
The type of hash function used to create the proof, must be one of: * sha512_256 * sha256
Type : enum (sha512_256, sha256)
HealthCheck¶
A health check response.
Name | Description | Schema |
---|---|---|
data optional |
object | |
db-available required |
boolean | |
errors optional |
< string > array | |
is-migrating required |
boolean | |
message required |
string | |
round required |
integer | |
version required |
Current version. | string |
IndexerStateProofMessage¶
Name | Description | Schema |
---|---|---|
block-headers-commitment optional |
[b] Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
first-attested-round optional |
[f] | integer |
latest-attested-round optional |
[l] | integer |
ln-proven-weight optional |
[P] | integer |
voters-commitment optional |
[v] Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
MerkleArrayProof¶
Name | Description | Schema |
---|---|---|
hash-factory optional |
HashFactory | |
path optional |
[pth] | < string (byte) > array |
tree-depth optional |
[td] | integer |
MiniAssetHolding¶
A simplified version of AssetHolding
Name | Description | Schema |
---|---|---|
address required |
string | |
amount required |
integer | |
deleted optional |
Whether or not this asset holding is currently deleted from its account. | boolean |
is-frozen required |
boolean | |
opted-in-at-round optional |
Round during which the account opted into the asset. | integer |
opted-out-at-round optional |
Round during which the account opted out of the asset. | integer |
OnCompletion¶
[apan] defines the what additional actions occur with the transaction.
Valid types: * noop * optin * closeout * clear * update * update * delete
Type : enum (noop, optin, closeout, clear, update, delete)
ParticipationUpdates¶
Participation account data that needs to be checked/acted on by the network.
Name | Description | Schema |
---|---|---|
expired-participation-accounts optional |
[partupdrmv] a list of online accounts that needs to be converted to offline since their participation key expired. | < string > array |
StateDelta¶
Application state delta.
Type : < EvalDeltaKeyValue > array
StateProofFields¶
[sp] represents a state proof.
Definition: crypto/stateproof/structs.go : StateProof
Name | Description | Schema |
---|---|---|
part-proofs optional |
[P] | MerkleArrayProof |
positions-to-reveal optional |
[pr] Sequence of reveal positions. | < integer > array |
reveals optional |
[r] Note that this is actually stored as a map[uint64] - Reveal in the actual msgp | < StateProofReveal > array |
salt-version optional |
[v] Salt version of the merkle signature. | integer |
sig-commit optional |
[c] Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
sig-proofs optional |
[S] | MerkleArrayProof |
signed-weight optional |
[w] | integer |
StateProofParticipant¶
Name | Description | Schema |
---|---|---|
verifier optional |
[p] | StateProofVerifier |
weight optional |
[w] | integer |
StateProofReveal¶
Name | Description | Schema |
---|---|---|
participant optional |
[p] | StateProofParticipant |
position optional |
The position in the signature and participants arrays corresponding to this entry. | integer |
sig-slot optional |
[s] | StateProofSigSlot |
StateProofSigSlot¶
Name | Description | Schema |
---|---|---|
lower-sig-weight optional |
[l] The total weight of signatures in the lower-numbered slots. | integer |
signature optional |
StateProofSignature |
StateProofSignature¶
Name | Description | Schema |
---|---|---|
falcon-signature optional |
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
merkle-array-index optional |
integer | |
proof optional |
MerkleArrayProof | |
verifying-key optional |
[vkey] Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
StateProofTracking¶
Name | Description | Schema |
---|---|---|
next-round optional |
[n] Next round for which we will accept a state proof transaction. | integer |
online-total-weight optional |
[t] The total number of microalgos held by the online accounts during the StateProof round. | integer |
type optional |
State Proof Type. Note the raw object uses map with this as key. | integer |
voters-commitment optional |
[v] Root of a vector commitment containing online accounts that will help sign the proof. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
StateProofVerifier¶
Name | Description | Schema |
---|---|---|
commitment optional |
[cmt] Represents the root of the vector commitment tree. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
key-lifetime optional |
[lf] Key lifetime. | integer |
StateSchema¶
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.
Name | Description | Schema |
---|---|---|
num-byte-slice required |
Maximum number of TEAL byte slices that may be stored in the key/value store. | integer |
num-uint required |
Maximum number of TEAL uints that may be stored in the key/value store. | integer |
TealKeyValue¶
Represents a key-value pair in an application store.
Name | Schema |
---|---|
key required |
string |
value required |
TealValue |
TealKeyValueStore¶
Represents a key-value store for use in an application.
Type : < TealKeyValue > array
TealValue¶
Represents a TEAL value.
Name | Description | Schema |
---|---|---|
bytes required |
[tb] bytes value. | string |
type required |
[tt] value type. Value 1 refers to bytes, value 2 refers to uint |
integer |
uint required |
[ui] uint value. | integer |
Transaction¶
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
Name | Description | Schema |
---|---|---|
application-transaction optional |
TransactionApplication | |
asset-config-transaction optional |
TransactionAssetConfig | |
asset-freeze-transaction optional |
TransactionAssetFreeze | |
asset-transfer-transaction optional |
TransactionAssetTransfer | |
auth-addr optional |
[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. | string |
close-rewards optional |
[rc] rewards applied to close-remainder-to account. | integer |
closing-amount optional |
[ca] closing amount for transaction. | integer |
confirmed-round optional |
Round when the transaction was confirmed. | integer |
created-application-index optional |
Specifies an application index (ID) if an application was created with this transaction. | integer |
created-asset-index optional |
Specifies an asset index (ID) if an asset was created with this transaction. | integer |
fee required |
[fee] Transaction fee. | integer |
first-valid required |
[fv] First valid round for this transaction. | integer |
genesis-hash optional |
[gh] Hash of genesis block. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
genesis-id optional |
[gen] genesis block ID. | string |
global-state-delta optional |
[gd] Global state key/value changes for the application being executed by this transaction. | StateDelta |
group optional |
[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. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
id optional |
Transaction ID | string |
inner-txns optional |
Inner transactions produced by application execution. | < Transaction > array |
intra-round-offset optional |
Offset into the round where this transaction was confirmed. | integer |
keyreg-transaction optional |
TransactionKeyreg | |
last-valid required |
[lv] Last valid round for this transaction. | integer |
lease optional |
[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. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
local-state-delta optional |
[ld] Local state key/value changes for the application being executed by this transaction. | < AccountStateDelta > array |
logs optional |
[lg] Logs for the application being executed by this transaction. | < string (byte) > array |
note optional |
[note] Free form data. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
payment-transaction optional |
TransactionPayment | |
receiver-rewards optional |
[rr] rewards applied to receiver account. | integer |
rekey-to optional |
[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. | string |
round-time optional |
Time when the block this transaction is in was confirmed. | integer |
sender required |
[snd] Sender's address. | string |
sender-rewards optional |
[rs] rewards applied to sender account. | integer |
signature optional |
TransactionSignature | |
state-proof-transaction optional |
TransactionStateProof | |
tx-type required |
[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 |
enum (pay, keyreg, acfg, axfer, afrz, appl, stpf) |
TransactionApplication¶
Fields for application transactions.
Definition: data/transactions/application.go : ApplicationCallTxnFields
Name | Description | Schema |
---|---|---|
accounts optional |
[apat] List of accounts in addition to the sender that may be accessed from the application's approval-program and clear-state-program. | < string > array |
application-args optional |
[apaa] transaction specific arguments accessed from the application's approval-program and clear-state-program. | < string > array |
application-id required |
[apid] ID of the application being configured or empty if creating. | integer |
approval-program optional |
[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. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
clear-state-program optional |
[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. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
extra-program-pages optional |
[epp] specifies the additional app program len requested in pages. | integer |
foreign-apps optional |
[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. | < integer > array |
foreign-assets optional |
[apas] lists the assets whose parameters may be accessed by this application's ApprovalProgram and ClearStateProgram. The access is read-only. | < integer > array |
global-state-schema optional |
StateSchema | |
local-state-schema optional |
StateSchema | |
on-completion required |
OnCompletion |
TransactionAssetConfig¶
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
Name | Description | Schema |
---|---|---|
asset-id optional |
[xaid] ID of the asset being configured or empty if creating. | integer |
params optional |
AssetParams |
TransactionAssetFreeze¶
Fields for an asset freeze transaction.
Definition: data/transactions/asset.go : AssetFreezeTxnFields
Name | Description | Schema |
---|---|---|
address required |
[fadd] Address of the account whose asset is being frozen or thawed. | string |
asset-id required |
[faid] ID of the asset being frozen or thawed. | integer |
new-freeze-status required |
[afrz] The new freeze status. | boolean |
TransactionAssetTransfer¶
Fields for an asset transfer transaction.
Definition: data/transactions/asset.go : AssetTransferTxnFields
Name | Description | Schema |
---|---|---|
amount required |
[aamt] Amount of asset to transfer. A zero amount transferred to self allocates that asset in the account's Assets map. | integer |
asset-id required |
[xaid] ID of the asset being transferred. | integer |
close-amount optional |
Number of assets transferred to the close-to account as part of the transaction. | integer |
close-to optional |
[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. | string |
receiver required |
[arcv] Recipient address of the transfer. | string |
sender optional |
[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. | string |
TransactionKeyreg¶
Fields for a keyreg transaction.
Definition: data/transactions/keyreg.go : KeyregTxnFields
Name | Description | Schema |
---|---|---|
non-participation optional |
[nonpart] Mark the account as participating or non-participating. | boolean |
selection-participation-key optional |
[selkey] Public key used with the Verified Random Function (VRF) result during committee selection. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
state-proof-key optional |
[sprfkey] State proof key used in key registration transactions. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
vote-first-valid optional |
[votefst] First round this participation key is valid. | integer |
vote-key-dilution optional |
[votekd] Number of subkeys in each batch of participation keys. | integer |
vote-last-valid optional |
[votelst] Last round this participation key is valid. | integer |
vote-participation-key optional |
[votekey] Participation public key used in key registration transactions. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
TransactionPayment¶
Fields for a payment transaction.
Definition: data/transactions/payment.go : PaymentTxnFields
Name | Description | Schema |
---|---|---|
amount required |
[amt] number of MicroAlgos intended to be transferred. | integer |
close-amount optional |
Number of MicroAlgos that were sent to the close-remainder-to address when closing the sender account. | integer |
close-remainder-to optional |
[close] when set, indicates that the sending account should be closed and all remaining funds be transferred to this address. | string |
receiver required |
[rcv] receiver's address. | string |
TransactionSignature¶
Validation signature associated with some data. Only one of the signatures should be provided.
Name | Description | Schema |
---|---|---|
logicsig optional |
TransactionSignatureLogicsig | |
multisig optional |
TransactionSignatureMultisig | |
sig optional |
[sig] Standard ed25519 signature. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
TransactionSignatureLogicsig¶
[lsig] Programatic transaction signature.
Definition: data/transactions/logicsig.go
Name | Description | Schema |
---|---|---|
args optional |
[arg] Logic arguments, base64 encoded. | < string > array |
logic required |
[l] Program signed by a signature or multi signature, or hashed to be the address of ana ccount. Base64 encoded TEAL program. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
multisig-signature optional |
TransactionSignatureMultisig | |
signature optional |
[sig] ed25519 signature. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
TransactionSignatureMultisig¶
[msig] structure holding multiple subsignatures.
Definition: crypto/multisig.go : MultisigSig
Name | Description | Schema |
---|---|---|
subsignature optional |
[subsig] holds pairs of public key and signatures. | < TransactionSignatureMultisigSubsignature > array |
threshold optional |
[thr] | integer |
version optional |
[v] | integer |
TransactionSignatureMultisigSubsignature¶
Name | Description | Schema |
---|---|---|
public-key optional |
[pk] Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
signature optional |
[s] Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" |
string (byte) |
TransactionStateProof¶
Fields for a state proof transaction.
Definition: data/transactions/stateproof.go : StateProofTxnFields
Name | Description | Schema |
---|---|---|
message optional |
[spmsg] | IndexerStateProofMessage |
state-proof optional |
StateProofFields | |
state-proof-type optional |
[sptype] Type of the state proof. Integer representing an entry defined in protocol/stateproof.go | integer |