getCoins

suspend fun getCoins(owner: SuiAddress, coinType: String? = null, cursor: Int? = null, limit: Int): CoinPage

Retrieves information about coins held by a given SUI address, with optional filtering by coin type and paging parameters.

Return

A CoinPage object containing information about the coins.

Parameters

address

The SUI address for which to retrieve coin information.

coinType

The type of coins to retrieve. This is optional, and if null, defaults to 0x2::sui::SUI

cursor

The index of the first item to retrieve. If null, the first item will be retrieved.

limit

The maximum number of items to retrieve.

Throws

if an error occurs while retrieving the coin information.