Skip to main content

GetBalanceParams

@iota/iota-sdk


@iota/iota-sdk / client / GetBalanceParams

Interface: GetBalanceParams

Defined in: sdk/typescript/src/client/types/params.ts:245

Return the total coin balance for one coin type, owned by the address owner.

Properties​

coinType?​

optional coinType?: string | null

Defined in: sdk/typescript/src/client/types/params.ts:252

optional type names for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC), default to 0x2::iota::IOTA if not specified.


owner​

owner: string

Defined in: sdk/typescript/src/client/types/params.ts:247

the owner's IOTA address


signal?​

optional signal?: AbortSignal

Defined in: sdk/typescript/src/client/types/params.ts:253