Skip to content

SearchForAccountsData

SearchForAccountsData: object

Type declaration

applicationId?

optional applicationId: number

Application ID

assetId?

optional assetId: number

Asset ID

authAddr?

optional authAddr: string

Include accounts configured to use this spending key.

currencyGreaterThan?

optional currencyGreaterThan: number

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.

currencyLessThan?

optional currencyLessThan: number

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.

exclude?

optional exclude: ("all" | "assets" | "created-assets" | "apps-local-state" | "created-apps" | "none")[]

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.

includeAll?

optional includeAll: boolean

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

limit?

optional limit: number

Maximum number of results to return. There could be additional pages even if the limit is not reached.

next?

optional next: string

The next page of results. Use the next token provided by the previous results.

round?

optional round: number

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.

Defined in

types.gen.ts:1420