Indexer | algosdk

The Indexer provides a REST API interface of API calls to support searching the Algorand Blockchain.

The Indexer REST APIs retrieve the blockchain data from a PostgreSQL compatible database that must be populated.

This database is populated using the same indexer instance or a separate instance of the indexer which must connect to the algod process of a running Algorand node to read block data.

This node must also be an Archival node to make searching the entire blockchain possible.

Relevant Information

Learn more about Indexer

Run Indexer in Postman OAS3

Hierarchy

ServiceClient
- Indexer

Constructors

constructor

new Indexer(tokenOrBaseClient: string | CustomTokenHeader | BaseHTTPClient | IndexerTokenHeader, baseServer?: string, port?: string | number, headers?: Record<string, string>): Indexer

Overrides ServiceClient.constructor
- Defined in client/v2/indexer/indexer.ts:62
Create an IndexerClient from
- either a token, baseServer, port, and optional headers
- or a base client server for interoperability with external dApp wallets
Example
```
const token  = "";
const server = "http://localhost";
const port   = 8980;
const indexerClient = new algosdk.Indexer(token, server, port);
```
remarks
The above configuration is for a sandbox private network. For applications on production, you are encouraged to run your own node with indexer, or use an Algorand REST API provider with a dedicated API key.
Parameters
- tokenOrBaseClient: string | CustomTokenHeader | BaseHTTPClient | IndexerTokenHeader
  
  The API token for the Indexer API
- baseServer: string = 'http://127.0.0.1'
  
  REST endpoint
- port: string | number = 8080
  
  Port number if specifically configured by the server
- headers: Record<string, string> = {}
  
  Optional headers
Returns Indexer

GET Methods

lookupAccountAppLocalStates

lookupAccountAppLocalStates(account: string): LookupAccountAppLocalStates

- Defined in client/v2/indexer/indexer.ts:240
Returns application local state about the given account.
Example
```
const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
const accountAppLocalStates = await indexerClient.lookupAccountAppLocalStates(address).do();
```
Response data schema details
Parameters
- account: string
  
  The address of the account to look up.
Returns LookupAccountAppLocalStates

lookupAccountAssets

lookupAccountAssets(account: string): LookupAccountAssets

- Defined in client/v2/indexer/indexer.ts:206
Returns asset about the given account.
Example
```
const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
const accountAssets = await indexerClient.lookupAccountAssets(address).do();
```
Response data schema details
Parameters
- account: string
  
  The address of the account to look up.
Returns LookupAccountAssets

lookupAccountByID

lookupAccountByID(account: string): LookupAccountByID

- Defined in client/v2/indexer/indexer.ts:189
Returns information about the given account.
Example
```
const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
const accountInfo = await indexerClient.lookupAccountByID(address).do();
```
Response data schema details
Parameters
- account: string
  
  The address of the account to look up.
Returns LookupAccountByID

lookupAccountCreatedApplications

lookupAccountCreatedApplications(account: string): LookupAccountCreatedApplications

- Defined in client/v2/indexer/indexer.ts:257
Returns application information created by the given account.
Example
```
const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
const accountCreatedApps = await indexerClient.lookupAccountCreatedApplications(address).do();
```
Response data schema details
Parameters
- account: string
  
  The address of the account to look up.
Returns LookupAccountCreatedApplications

lookupAccountCreatedAssets

lookupAccountCreatedAssets(account: string): LookupAccountCreatedAssets

- Defined in client/v2/indexer/indexer.ts:223
Returns asset information created by the given account.
Example
```
const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
const accountCreatedAssets = await indexerClient.lookupAccountCreatedAssets(address).do();
```
Response data schema details
Parameters
- account: string
  
  The address of the account to look up.
Returns LookupAccountCreatedAssets

lookupAccountTransactions

lookupAccountTransactions(account: string): LookupAccountTransactions

- Defined in client/v2/indexer/indexer.ts:138
Returns transactions relating to the given account.
Example
```
const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
const accountTxns = await indexerClient.lookupAccountTransactions(address).do();
```
Response data schema details
Parameters
- account: string
  
  The address of the account.
Returns LookupAccountTransactions

lookupApplicationLogs

lookupApplicationLogs(appID: number): LookupApplicationLogs

- Defined in client/v2/indexer/indexer.ts:312
Returns log messages generated by the passed in application.
Example
```
const appId = 60553466;
const appLogs = await indexerClient.lookupApplicationLogs(appId).do();
```
Response data schema details
Parameters
- appID: number
  
  The ID of the application which generated the logs.
Returns LookupApplicationLogs

lookupApplications

lookupApplications(index: number): LookupApplications

- Defined in client/v2/indexer/indexer.ts:295
Returns information about the passed application.
Example
```
const appId = 60553466;
const appInfo = await indexerClient.lookupApplications(appId).do();
```
Response data schema details
Parameters
- index: number
  
  The ID of the application to look up.
Returns LookupApplications

lookupAssetBalances

lookupAssetBalances(index: number): LookupAssetBalances

- Defined in client/v2/indexer/indexer.ts:104
Returns the list of accounts who hold the given asset and their balance.
Example
```
const assetId = 163650;
const assetBalances = await indexerClient.lookupAssetBalances(assetId).do();
```
Response data schema details
Parameters
- index: number
  
  The asset ID to look up.
Returns LookupAssetBalances

lookupAssetByID

lookupAssetByID(index: number): LookupAssetByID

- Defined in client/v2/indexer/indexer.ts:278
Returns information about the passed asset.
Example
```
const assetId = 163650;
const assetInfo = await indexerClient.lookupAssetByID(assetId).do();
```
Response data schema details
Parameters
- index: number
  
  The ID of the asset ot look up.
Returns LookupAssetByID

lookupAssetTransactions

lookupAssetTransactions(index: number): LookupAssetTransactions

- Defined in client/v2/indexer/indexer.ts:121
Returns transactions relating to the given asset.
Example
```
const assetId = 163650;
const assetTxns = await indexerClient.lookupAssetTransactions(assetId).do();
```
Response data schema details
Parameters
- index: number
  
  The asset ID to look up.
Returns LookupAssetTransactions

lookupBlock

lookupBlock(round: number): LookupBlock

- Defined in client/v2/indexer/indexer.ts:155
Returns the block for the passed round.
Example
```
const targetBlock = 18309917;
const blockInfo = await indexerClient.lookupBlock(targetBlock).do();
```
Response data schema details
Parameters
- round: number
  
  The number of the round to look up.
Returns LookupBlock

lookupTransactionByID

lookupTransactionByID(txID: string): LookupTransactionByID

- Defined in client/v2/indexer/indexer.ts:172
Returns information about the given transaction.
Example
```
const txnId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
const txnInfo = await indexerClient.lookupTransactionByID(txnId).do();
```
Response data schema details
Parameters
- txID: string
  
  The ID of the transaction to look up.
Returns LookupTransactionByID

makeHealthCheck

makeHealthCheck(): MakeHealthCheck

- Defined in client/v2/indexer/indexer.ts:87
Returns the health object for the service. Returns 200 if healthy.
Example
```
const health = await indexerClient.makeHealthCheck().do();
```
Response data schema details
Returns MakeHealthCheck

searchAccounts

searchAccounts(): SearchAccounts

- Defined in client/v2/indexer/indexer.ts:327
Returns information about indexed accounts.
Example
```
const accounts = await indexerClient.searchAccounts().do();
```
Response data schema details
Returns SearchAccounts

searchForApplications

searchForApplications(): SearchForApplications

- Defined in client/v2/indexer/indexer.ts:372
Returns information about indexed applications.
Example
```
const apps = await indexerClient.searchForApplications().do();
```
Response data schema details
Returns SearchForApplications

searchForAssets

searchForAssets(): SearchForAssets

- Defined in client/v2/indexer/indexer.ts:357
Returns information about indexed assets.
Example
```
const assets = await indexerClient.searchForAssets().do();
```
Response data schema details
Returns SearchForAssets

searchForTransactions

searchForTransactions(): SearchForTransactions

- Defined in client/v2/indexer/indexer.ts:342
Returns information about indexed transactions.
Example
```
const txns = await indexerClient.searchForTransactions().do();
```
Response data schema details
Returns SearchForTransactions

Other Methods

getIntEncoding

getIntEncoding(): IntDecoding

Inherited from ServiceClient.getIntEncoding
- Defined in client/v2/serviceClient.ts:83
Get the default int decoding method for all JSON requests this client creates.

Returns IntDecoding

setIntEncoding

setIntEncoding(method: IntDecoding): void

Inherited from ServiceClient.setIntEncoding
- Defined in client/v2/serviceClient.ts:76
Set the default int decoding method for all JSON requests this client creates.

Parameters
- method: IntDecoding
  
  {"default" | "safe" | "mixed" | "bigint"} method The method to use when parsing the response for request. Must be one of "default", "safe", "mixed", or "bigint". See JSONRequest.setIntDecoding for more details about what each method does.
Returns void

Relevant Information

Hierarchy

Index

Constructors

Methods GET

Methods Other

Constructors

constructor

Example

Parameters

tokenOrBaseClient: string | CustomTokenHeader | BaseHTTPClient | IndexerTokenHeader

baseServer: string = 'http://127.0.0.1'

port: string | number = 8080

headers: Record<string, string> = {}

Returns Indexer

GET Methods

lookupAccountAppLocalStates

Example

Parameters

account: string

Returns LookupAccountAppLocalStates

lookupAccountAssets

Example

Parameters

account: string

Returns LookupAccountAssets

lookupAccountByID

Example

Parameters

account: string

Returns LookupAccountByID

lookupAccountCreatedApplications

Example

Parameters

account: string

Returns LookupAccountCreatedApplications

lookupAccountCreatedAssets

Example

Parameters

account: string

Returns LookupAccountCreatedAssets

lookupAccountTransactions

Example

Parameters

account: string

Returns LookupAccountTransactions

lookupApplicationLogs

Example

Parameters

appID: number

Returns LookupApplicationLogs

lookupApplications

Example

Parameters

index: number

Returns LookupApplications

lookupAssetBalances

Example

Parameters

index: number

Returns LookupAssetBalances

lookupAssetByID

Example

Parameters

index: number

Returns LookupAssetByID

lookupAssetTransactions

Example

Parameters

index: number

Returns LookupAssetTransactions

lookupBlock

Example

Parameters

round: number

Returns LookupBlock

lookupTransactionByID

Example

Parameters

txID: string