Skip to main content

GetCoinsParams

@iota/iota-sdk


@iota/iota-sdk / client / GetCoinsParams

Interface: GetCoinsParams

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

Return all Coin<coin_type> objects owned by an address.

Properties

coinType?

optional coinType?: string | null

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

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


cursor?

optional cursor?: string | null

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

optional paging cursor


limit?

optional limit?: number | null

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

maximum number of items per page


owner

owner: string

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

the owner's IOTA address


signal?

optional signal?: AbortSignal

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