IndexerClient
Defined in: packages/indexer_client/src/client.ts:5
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new IndexerClient(
config):IndexerClient
Defined in: packages/indexer_client/src/client.ts:6
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”IndexerClient
Overrides
Section titled “Overrides”Properties
Section titled “Properties”httpRequest
Section titled “httpRequest”
readonlyhttpRequest:BaseHttpRequest
Defined in: packages/indexer_client/src/apis/api-service.ts:44
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”healthCheck()
Section titled “healthCheck()”healthCheck():
Promise<HealthCheck>
Defined in: packages/indexer_client/src/apis/api-service.ts:50
Returns
Section titled “Returns”Promise<HealthCheck>
Inherited from
Section titled “Inherited from”lookupAccountAppLocalStates()
Section titled “lookupAccountAppLocalStates()”lookupAccountAppLocalStates(
account,params?):Promise<ApplicationLocalStatesResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:70
Lookup an account’s asset holdings, optionally for a specific ID.
Parameters
Section titled “Parameters”account
Section titled “account”params?
Section titled “params?”applicationId?
Section titled “applicationId?”number | bigint
includeAll?
Section titled “includeAll?”boolean
limit?
Section titled “limit?”number
string
Returns
Section titled “Returns”Promise<ApplicationLocalStatesResponse>
Inherited from
Section titled “Inherited from”IndexerApi.lookupAccountAppLocalStates
lookupAccountAssets()
Section titled “lookupAccountAssets()”lookupAccountAssets(
account,params?):Promise<AssetHoldingsResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:93
Lookup an account’s asset holdings, optionally for a specific ID.
Parameters
Section titled “Parameters”account
Section titled “account”params?
Section titled “params?”assetId?
Section titled “assetId?”number | bigint
includeAll?
Section titled “includeAll?”boolean
limit?
Section titled “limit?”number
string
Returns
Section titled “Returns”Promise<AssetHoldingsResponse>
Inherited from
Section titled “Inherited from”IndexerApi.lookupAccountAssets
lookupAccountById()
Section titled “lookupAccountById()”lookupAccountById(
account,params?):Promise<AccountResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:116
Lookup account information.
Parameters
Section titled “Parameters”account
Section titled “account”params?
Section titled “params?”exclude?
Section titled “exclude?”"all" | "apps-local-state" | "assets" | "created-apps" | "created-assets" | "none"[]
includeAll?
Section titled “includeAll?”boolean
round?
Section titled “round?”number | bigint
Returns
Section titled “Returns”Promise<AccountResponse>
Inherited from
Section titled “Inherited from”lookupAccountCreatedApplications()
Section titled “lookupAccountCreatedApplications()”lookupAccountCreatedApplications(
account,params?):Promise<ApplicationsResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:143
Lookup an account’s created application parameters, optionally for a specific ID.
Parameters
Section titled “Parameters”account
Section titled “account”params?
Section titled “params?”applicationId?
Section titled “applicationId?”number | bigint
includeAll?
Section titled “includeAll?”boolean
limit?
Section titled “limit?”number
string
Returns
Section titled “Returns”Promise<ApplicationsResponse>
Inherited from
Section titled “Inherited from”IndexerApi.lookupAccountCreatedApplications
lookupAccountCreatedAssets()
Section titled “lookupAccountCreatedAssets()”lookupAccountCreatedAssets(
account,params?):Promise<AssetsResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:166
Lookup an account’s created asset parameters, optionally for a specific ID.
Parameters
Section titled “Parameters”account
Section titled “account”params?
Section titled “params?”assetId?
Section titled “assetId?”number | bigint
includeAll?
Section titled “includeAll?”boolean
limit?
Section titled “limit?”number
string
Returns
Section titled “Returns”Promise<AssetsResponse>
Inherited from
Section titled “Inherited from”IndexerApi.lookupAccountCreatedAssets
lookupAccountTransactions()
Section titled “lookupAccountTransactions()”lookupAccountTransactions(
account,params?):Promise<TransactionsResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:189
Lookup account transactions. Transactions are returned newest to oldest.
Parameters
Section titled “Parameters”account
Section titled “account”params?
Section titled “params?”afterTime?
Section titled “afterTime?”string
assetId?
Section titled “assetId?”number | bigint
beforeTime?
Section titled “beforeTime?”string
currencyGreaterThan?
Section titled “currencyGreaterThan?”number | bigint
currencyLessThan?
Section titled “currencyLessThan?”number | bigint
limit?
Section titled “limit?”number
maxRound?
Section titled “maxRound?”number | bigint
minRound?
Section titled “minRound?”number | bigint
string
notePrefix?
Section titled “notePrefix?”string
rekeyTo?
Section titled “rekeyTo?”boolean
round?
Section titled “round?”number | bigint
sigType?
Section titled “sigType?”"sig" | "msig" | "lsig"
string
txType?
Section titled “txType?”"pay" | "keyreg" | "acfg" | "axfer" | "afrz" | "appl" | "stpf" | "hb"
Returns
Section titled “Returns”Promise<TransactionsResponse>
Inherited from
Section titled “Inherited from”IndexerApi.lookupAccountTransactions
lookupApplicationBoxByIdAndName()
Section titled “lookupApplicationBoxByIdAndName()”lookupApplicationBoxByIdAndName(
applicationId,boxName):Promise<Box>
Defined in: packages/indexer_client/src/apis/api-service.ts:709
Given an application ID and box name, it returns the round, box name, and value.
Parameters
Section titled “Parameters”applicationId
Section titled “applicationId”number | bigint
boxName
Section titled “boxName”Uint8Array
Returns
Section titled “Returns”Promise<Box>
Inherited from
Section titled “Inherited from”IndexerApi.lookupApplicationBoxByIdAndName
lookupApplicationById()
Section titled “lookupApplicationById()”lookupApplicationById(
applicationId,params?):Promise<ApplicationResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:264
Lookup application.
Parameters
Section titled “Parameters”applicationId
Section titled “applicationId”number | bigint
params?
Section titled “params?”includeAll?
Section titled “includeAll?”boolean
Returns
Section titled “Returns”Promise<ApplicationResponse>
Inherited from
Section titled “Inherited from”IndexerApi.lookupApplicationById
lookupApplicationLogsById()
Section titled “lookupApplicationLogsById()”lookupApplicationLogsById(
applicationId,params?):Promise<ApplicationLogsResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:284
Lookup application logs.
Parameters
Section titled “Parameters”applicationId
Section titled “applicationId”number | bigint
params?
Section titled “params?”limit?
Section titled “limit?”number
maxRound?
Section titled “maxRound?”number | bigint
minRound?
Section titled “minRound?”number | bigint
string
senderAddress?
Section titled “senderAddress?”string
Returns
Section titled “Returns”Promise<ApplicationLogsResponse>
Inherited from
Section titled “Inherited from”IndexerApi.lookupApplicationLogsById
lookupAssetBalances()
Section titled “lookupAssetBalances()”lookupAssetBalances(
assetId,params?):Promise<AssetBalancesResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:321
Lookup the list of accounts who hold this asset
Parameters
Section titled “Parameters”assetId
Section titled “assetId”number | bigint
params?
Section titled “params?”currencyGreaterThan?
Section titled “currencyGreaterThan?”number | bigint
currencyLessThan?
Section titled “currencyLessThan?”number | bigint
includeAll?
Section titled “includeAll?”boolean
limit?
Section titled “limit?”number
string
Returns
Section titled “Returns”Promise<AssetBalancesResponse>
Inherited from
Section titled “Inherited from”IndexerApi.lookupAssetBalances
lookupAssetById()
Section titled “lookupAssetById()”lookupAssetById(
assetId,params?):Promise<AssetResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:356
Lookup asset information.
Parameters
Section titled “Parameters”assetId
Section titled “assetId”number | bigint
params?
Section titled “params?”includeAll?
Section titled “includeAll?”boolean
Returns
Section titled “Returns”Promise<AssetResponse>
Inherited from
Section titled “Inherited from”lookupAssetTransactions()
Section titled “lookupAssetTransactions()”lookupAssetTransactions(
assetId,params?):Promise<TransactionsResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:376
Lookup transactions for an asset. Transactions are returned oldest to newest.
Parameters
Section titled “Parameters”assetId
Section titled “assetId”number | bigint
params?
Section titled “params?”address?
Section titled “address?”addressRole?
Section titled “addressRole?”"receiver" | "sender" | "freeze-target"
afterTime?
Section titled “afterTime?”string
beforeTime?
Section titled “beforeTime?”string
currencyGreaterThan?
Section titled “currencyGreaterThan?”number | bigint
currencyLessThan?
Section titled “currencyLessThan?”number | bigint
excludeCloseTo?
Section titled “excludeCloseTo?”boolean
limit?
Section titled “limit?”number
maxRound?
Section titled “maxRound?”number | bigint
minRound?
Section titled “minRound?”number | bigint
string
notePrefix?
Section titled “notePrefix?”string
rekeyTo?
Section titled “rekeyTo?”boolean
round?
Section titled “round?”number | bigint
sigType?
Section titled “sigType?”"sig" | "msig" | "lsig"
string
txType?
Section titled “txType?”"pay" | "keyreg" | "acfg" | "axfer" | "afrz" | "appl" | "stpf" | "hb"
Returns
Section titled “Returns”Promise<TransactionsResponse>
Inherited from
Section titled “Inherited from”IndexerApi.lookupAssetTransactions
lookupBlock()
Section titled “lookupBlock()”lookupBlock(
roundNumber,params?):Promise<Block>
Defined in: packages/indexer_client/src/apis/api-service.ts:435
Lookup block.
Parameters
Section titled “Parameters”roundNumber
Section titled “roundNumber”number | bigint
params?
Section titled “params?”headerOnly?
Section titled “headerOnly?”boolean
Returns
Section titled “Returns”Promise<Block>
Inherited from
Section titled “Inherited from”lookupTransactionById()
Section titled “lookupTransactionById()”lookupTransactionById(
txId):Promise<TransactionResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:455
Lookup a single transaction.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<TransactionResponse>
Inherited from
Section titled “Inherited from”IndexerApi.lookupTransactionById
searchForAccounts()
Section titled “searchForAccounts()”searchForAccounts(
params?):Promise<AccountsResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:475
Search for accounts.
Parameters
Section titled “Parameters”params?
Section titled “params?”applicationId?
Section titled “applicationId?”number | bigint
assetId?
Section titled “assetId?”number | bigint
authAddr?
Section titled “authAddr?”currencyGreaterThan?
Section titled “currencyGreaterThan?”number | bigint
currencyLessThan?
Section titled “currencyLessThan?”number | bigint
exclude?
Section titled “exclude?”"all" | "apps-local-state" | "assets" | "created-apps" | "created-assets" | "none"[]
includeAll?
Section titled “includeAll?”boolean
limit?
Section titled “limit?”number
string
onlineOnly?
Section titled “onlineOnly?”boolean
round?
Section titled “round?”number | bigint
Returns
Section titled “Returns”Promise<AccountsResponse>
Inherited from
Section titled “Inherited from”searchForApplicationBoxes()
Section titled “searchForApplicationBoxes()”searchForApplicationBoxes(
applicationId,params?):Promise<BoxesResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:519
Given an application ID, returns the box names of that application sorted lexicographically.
Parameters
Section titled “Parameters”applicationId
Section titled “applicationId”number | bigint
params?
Section titled “params?”limit?
Section titled “limit?”number
string
Returns
Section titled “Returns”Promise<BoxesResponse>
Inherited from
Section titled “Inherited from”IndexerApi.searchForApplicationBoxes
searchForApplications()
Section titled “searchForApplications()”searchForApplications(
params?):Promise<ApplicationsResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:539
Search for applications
Parameters
Section titled “Parameters”params?
Section titled “params?”applicationId?
Section titled “applicationId?”number | bigint
creator?
Section titled “creator?”string
includeAll?
Section titled “includeAll?”boolean
limit?
Section titled “limit?”number
string
Returns
Section titled “Returns”Promise<ApplicationsResponse>
Inherited from
Section titled “Inherited from”IndexerApi.searchForApplications
searchForAssets()
Section titled “searchForAssets()”searchForAssets(
params?):Promise<AssetsResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:571
Search for assets.
Parameters
Section titled “Parameters”params?
Section titled “params?”assetId?
Section titled “assetId?”number | bigint
creator?
Section titled “creator?”string
includeAll?
Section titled “includeAll?”boolean
limit?
Section titled “limit?”number
string
string
string
Returns
Section titled “Returns”Promise<AssetsResponse>
Inherited from
Section titled “Inherited from”searchForBlockHeaders()
Section titled “searchForBlockHeaders()”searchForBlockHeaders(
params?):Promise<BlockHeadersResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:607
Search for block headers. Block headers are returned in ascending round order. Transactions are not included in the output.
Parameters
Section titled “Parameters”params?
Section titled “params?”absent?
Section titled “absent?”afterTime?
Section titled “afterTime?”string
beforeTime?
Section titled “beforeTime?”string
expired?
Section titled “expired?”limit?
Section titled “limit?”number
maxRound?
Section titled “maxRound?”number | bigint
minRound?
Section titled “minRound?”number | bigint
string
proposers?
Section titled “proposers?”Returns
Section titled “Returns”Promise<BlockHeadersResponse>
Inherited from
Section titled “Inherited from”IndexerApi.searchForBlockHeaders
searchForTransactions()
Section titled “searchForTransactions()”searchForTransactions(
params?):Promise<TransactionsResponse>
Defined in: packages/indexer_client/src/apis/api-service.ts:647
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
Section titled “Parameters”params?
Section titled “params?”address?
Section titled “address?”addressRole?
Section titled “addressRole?”"receiver" | "sender" | "freeze-target"
afterTime?
Section titled “afterTime?”string
applicationId?
Section titled “applicationId?”number | bigint
assetId?
Section titled “assetId?”number | bigint
beforeTime?
Section titled “beforeTime?”string
currencyGreaterThan?
Section titled “currencyGreaterThan?”number | bigint
currencyLessThan?
Section titled “currencyLessThan?”number | bigint
excludeCloseTo?
Section titled “excludeCloseTo?”boolean
groupId?
Section titled “groupId?”string
limit?
Section titled “limit?”number
maxRound?
Section titled “maxRound?”number | bigint
minRound?
Section titled “minRound?”number | bigint
string
notePrefix?
Section titled “notePrefix?”string
rekeyTo?
Section titled “rekeyTo?”boolean
round?
Section titled “round?”number | bigint
sigType?
Section titled “sigType?”"sig" | "msig" | "lsig"
string
txType?
Section titled “txType?”"pay" | "keyreg" | "acfg" | "axfer" | "afrz" | "appl" | "stpf" | "hb"
Returns
Section titled “Returns”Promise<TransactionsResponse>