The lookup API from Algorand — 14 operation(s) for lookup.
openapi: 3.0.1
info:
contact:
email: contact@algorand.com
name: algorand
url: https://www.algorand.com/get-in-touch/contact
description: API endpoint for algod operations.
title: Algod REST API. common lookup API
version: 0.0.1
servers:
- url: http://localhost/
- url: https://localhost/
security:
- api_key: []
tags:
- name: lookup
paths:
/v2/accounts/{account-id}:
get:
description: Lookup account information.
operationId: lookupAccountByID
parameters:
- description: account string
in: path
name: account-id
required: true
schema:
type: string
- description: Include results for the specified round.
in: query
name: round
schema:
type: integer
- description: Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
in: query
name: include-all
schema:
type: boolean
- description: 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.
explode: false
in: query
name: exclude
schema:
items:
enum:
- all
- assets
- created-assets
- apps-local-state
- created-apps
- none
type: string
type: array
style: form
responses:
'200':
content:
application/json:
schema:
properties:
account:
$ref: '#/components/schemas/Account'
current-round:
description: Round at which the results were computed.
type: integer
required:
- account
- current-round
type: object
description: (empty)
'400':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'404':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'500':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
tags:
- lookup
/v2/accounts/{account-id}/apps-local-state:
get:
description: Lookup an account's asset holdings, optionally for a specific ID.
operationId: lookupAccountAppLocalStates
parameters:
- description: account string
in: path
name: account-id
required: true
schema:
type: string
- description: Application ID
in: query
name: application-id
schema:
type: integer
- description: Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
in: query
name: include-all
schema:
type: boolean
- description: Maximum number of results to return. There could be additional pages even if the limit is not reached.
in: query
name: limit
schema:
type: integer
- description: The next page of results. Use the next token provided by the previous results.
in: query
name: next
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
apps-local-states:
items:
$ref: '#/components/schemas/ApplicationLocalState'
type: array
current-round:
description: Round at which the results were computed.
type: integer
next-token:
description: Used for pagination, when making another request provide this token with the next parameter.
type: string
required:
- apps-local-states
- current-round
type: object
description: (empty)
'400':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'404':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'500':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
tags:
- lookup
/v2/accounts/{account-id}/assets:
get:
description: Lookup an account's asset holdings, optionally for a specific ID.
operationId: lookupAccountAssets
parameters:
- description: account string
in: path
name: account-id
required: true
schema:
type: string
- description: Asset ID
in: query
name: asset-id
schema:
type: integer
- description: Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
in: query
name: include-all
schema:
type: boolean
- description: Maximum number of results to return. There could be additional pages even if the limit is not reached.
in: query
name: limit
schema:
type: integer
- description: The next page of results. Use the next token provided by the previous results.
in: query
name: next
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
assets:
items:
$ref: '#/components/schemas/AssetHolding'
type: array
current-round:
description: Round at which the results were computed.
type: integer
next-token:
description: Used for pagination, when making another request provide this token with the next parameter.
type: string
required:
- assets
- current-round
type: object
description: (empty)
'400':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'404':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'500':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
tags:
- lookup
/v2/accounts/{account-id}/created-applications:
get:
description: Lookup an account's created application parameters, optionally for a specific ID.
operationId: lookupAccountCreatedApplications
parameters:
- description: account string
in: path
name: account-id
required: true
schema:
type: string
- description: Application ID
in: query
name: application-id
schema:
type: integer
- description: Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
in: query
name: include-all
schema:
type: boolean
- description: Maximum number of results to return. There could be additional pages even if the limit is not reached.
in: query
name: limit
schema:
type: integer
- description: The next page of results. Use the next token provided by the previous results.
in: query
name: next
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
applications:
items:
$ref: '#/components/schemas/Application'
type: array
current-round:
description: Round at which the results were computed.
type: integer
next-token:
description: Used for pagination, when making another request provide this token with the next parameter.
type: string
required:
- applications
- current-round
type: object
description: (empty)
'400':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'404':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'500':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
tags:
- lookup
/v2/accounts/{account-id}/created-assets:
get:
description: Lookup an account's created asset parameters, optionally for a specific ID.
operationId: lookupAccountCreatedAssets
parameters:
- description: account string
in: path
name: account-id
required: true
schema:
type: string
- description: Asset ID
in: query
name: asset-id
schema:
type: integer
- description: Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
in: query
name: include-all
schema:
type: boolean
- description: Maximum number of results to return. There could be additional pages even if the limit is not reached.
in: query
name: limit
schema:
type: integer
- description: The next page of results. Use the next token provided by the previous results.
in: query
name: next
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
assets:
items:
$ref: '#/components/schemas/Asset'
type: array
current-round:
description: Round at which the results were computed.
type: integer
next-token:
description: Used for pagination, when making another request provide this token with the next parameter.
type: string
required:
- assets
- current-round
type: object
description: (empty)
'400':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'404':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'500':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
tags:
- lookup
/v2/accounts/{account-id}/transactions:
get:
description: Lookup account transactions. Transactions are returned newest to oldest.
operationId: lookupAccountTransactions
parameters:
- description: Maximum number of results to return. There could be additional pages even if the limit is not reached.
in: query
name: limit
schema:
type: integer
- description: The next page of results. Use the next token provided by the previous results.
in: query
name: next
schema:
type: string
- description: Specifies a prefix which must be contained in the note field.
in: query
name: note-prefix
schema:
type: string
x-algorand-format: base64
x-algorand-format: base64
- in: query
name: tx-type
schema:
enum:
- pay
- keyreg
- acfg
- axfer
- afrz
- appl
- stpf
- hb
type: string
- description: 'SigType filters just results using the specified type of signature:
* sig - Standard
* msig - MultiSig
* lsig - LogicSig'
in: query
name: sig-type
schema:
enum:
- sig
- msig
- lsig
type: string
- description: Lookup the specific transaction by ID.
in: query
name: txid
schema:
type: string
- description: Include results for the specified round.
in: query
name: round
schema:
type: integer
- description: Include results at or after the specified min-round.
in: query
name: min-round
schema:
type: integer
- description: Include results at or before the specified max-round.
in: query
name: max-round
schema:
type: integer
- description: Asset ID
in: query
name: asset-id
schema:
type: integer
- description: Include results before the given time. Must be an RFC 3339 formatted string.
in: query
name: before-time
schema:
format: date-time
type: string
x-algorand-format: RFC3339 String
x-algorand-format: RFC3339 String
- description: Include results after the given time. Must be an RFC 3339 formatted string.
in: query
name: after-time
schema:
format: date-time
type: string
x-algorand-format: RFC3339 String
x-algorand-format: RFC3339 String
- description: 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.
in: query
name: currency-greater-than
schema:
type: integer
- description: 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.
in: query
name: currency-less-than
schema:
type: integer
- description: account string
in: path
name: account-id
required: true
schema:
type: string
- description: Include results which include the rekey-to field.
in: query
name: rekey-to
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
properties:
current-round:
description: Round at which the results were computed.
type: integer
next-token:
description: Used for pagination, when making another request provide this token with the next parameter.
type: string
transactions:
items:
$ref: '#/components/schemas/Transaction'
type: array
required:
- current-round
- transactions
type: object
description: (empty)
'400':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'500':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
tags:
- lookup
/v2/applications/{application-id}:
get:
description: Lookup application.
operationId: lookupApplicationByID
parameters:
- in: path
name: application-id
required: true
schema:
type: integer
- description: Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
in: query
name: include-all
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
properties:
application:
$ref: '#/components/schemas/Application'
current-round:
description: Round at which the results were computed.
type: integer
required:
- current-round
type: object
description: (empty)
'404':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'500':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
tags:
- lookup
/v2/applications/{application-id}/box:
get:
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...'.
operationId: lookupApplicationBoxByIDAndName
parameters:
- in: path
name: application-id
required: true
schema:
type: integer
- description: 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...'.
in: query
name: name
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Box'
description: Box information
'400':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'404':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'500':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
summary: Get box information for a given application.
tags:
- lookup
/v2/applications/{application-id}/logs:
get:
description: Lookup application logs.
operationId: lookupApplicationLogsByID
parameters:
- in: path
name: application-id
required: true
schema:
type: integer
- description: Maximum number of results to return. There could be additional pages even if the limit is not reached.
in: query
name: limit
schema:
type: integer
- description: The next page of results. Use the next token provided by the previous results.
in: query
name: next
schema:
type: string
- description: Lookup the specific transaction by ID.
in: query
name: txid
schema:
type: string
- description: Include results at or after the specified min-round.
in: query
name: min-round
schema:
type: integer
- description: Include results at or before the specified max-round.
in: query
name: max-round
schema:
type: integer
- description: Only include transactions with this sender address.
in: query
name: sender-address
schema:
type: string
x-algorand-format: Address
x-algorand-format: Address
responses:
'200':
content:
application/json:
schema:
properties:
application-id:
description: \[appidx\] application index.
type: integer
current-round:
description: Round at which the results were computed.
type: integer
log-data:
items:
$ref: '#/components/schemas/ApplicationLogData'
type: array
next-token:
description: Used for pagination, when making another request provide this token with the next parameter.
type: string
required:
- application-id
- current-round
type: object
description: (empty)
tags:
- lookup
/v2/assets/{asset-id}:
get:
description: Lookup asset information.
operationId: lookupAssetByID
parameters:
- in: path
name: asset-id
required: true
schema:
type: integer
- description: Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
in: query
name: include-all
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
properties:
asset:
$ref: '#/components/schemas/Asset'
current-round:
description: Round at which the results were computed.
type: integer
required:
- asset
- current-round
type: object
description: (empty)
'400':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'404':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'500':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
tags:
- lookup
/v2/assets/{asset-id}/balances:
get:
description: 'Lookup the list of accounts who hold this asset '
operationId: lookupAssetBalances
parameters:
- description: Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
in: query
name: include-all
schema:
type: boolean
- description: Maximum number of results to return. There could be additional pages even if the limit is not reached.
in: query
name: limit
schema:
type: integer
- description: The next page of results. Use the next token provided by the previous results.
in: query
name: next
schema:
type: string
- description: 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.
in: query
name: currency-greater-than
schema:
type: integer
- description: 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.
in: query
name: currency-less-than
schema:
type: integer
- in: path
name: asset-id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
properties:
balances:
items:
$ref: '#/components/schemas/MiniAssetHolding'
type: array
current-round:
description: Round at which the results were computed.
type: integer
next-token:
description: Used for pagination, when making another request provide this token with the next parameter.
type: string
required:
- balances
- current-round
type: object
description: (empty)
'400':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
'500':
content:
application/json:
schema:
properties:
data:
properties: {}
type: object
message:
type: string
required:
- message
type: object
description: Response for errors
tags:
- lookup
/v2/assets/{asset-id}/transactions:
get:
description: Lookup transactions for an asset. Transactions are returned oldest to newest.
operationId: lookupAssetTransactions
parameters:
- description: Maximum number of results to return. There could be additional pages even if the limit is not reached.
in: query
name: limit
schema:
type: integer
- description: The next page of results. Use the next token provided by the previous results.
in: query
name: next
schema:
# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/algorand/refs/heads/main/openapi/algorand-lookup-api-openapi.yml