Skip to main content

​
Function Signature

Future<YieldXyzGetBalancesResponse> getBalances({
  required List<YieldXyzGetBalancesQuery> queries,
})

​
Description

Retrieve current balances across different yield positions for one or more wallet addresses.

​
Parameters

ParameterTypeRequiredDescription
queriesList<YieldXyzGetBalancesQuery>YesList of balance queries
YieldXyzGetBalancesQuery fields:
FieldTypeDescription
addressStringWallet address to check
networkStringBlockchain network
yieldIdString?Optional specific yield opportunity ID

​
Returns

YieldXyzGetBalancesResponse - An object containing:
PropertyTypeDescription
itemsList<YieldBalance?>List of yield balances by yield opportunity
errorsList<String?>?Any errors encountered during balance queries
metadataYieldXyzGetBalancesMetadata?Response metadata
errorString?Top-level error message, if any

​
Example

import 'package:portal_flutter/portal_flutter.dart';

final portal = Portal();

final response = await portal.yieldIntegrations.yieldxyz.getBalances(
  queries: [
    YieldXyzGetBalancesQuery(
      address: '0x1234...',
      network: 'ethereum',
    ),
  ],
);

for (final balance in response.items) {
  if (balance != null) {
    print('Balance: ${balance.amount}');
  }
}

​
Errors

CodeDescription
NOT_INITIALIZEDPortal was not initialized
YIELD_FAILEDFailed to get yield balances