getUnifiedBalances() & getUnifiedBalance()
SET UP THE SDK BEFORE YOU START:
- You can find the SDK setup instructions in the Quickstart page.
- We also created a tutorial to make it easier to understand how devs need to initialize the Nexus SDK in their project.
Use these functions to fetch consolidated token balances across all supported chains in one call.
Note: Check out the API reference for a full list of supported tokens and chains.
Method signatures
Typescript
async getUnifiedBalances(): Promise<UserAsset[]>
async getUnifiedBalance(symbol: string): Promise<UserAsset | undefined>Parameters
symbol(string, required forgetUnifiedBalance): Token symbol, e.g.'USDC' | 'USDT' | 'ETH'.
getUnifiedBalances()
Fetches the unified balance of all tokens across all chains for a user.
Typescript
// No parameters required
await sdk.getUnifiedBalances(): Promise<UserAsset[]>getUnifiedBalance(symbol)
Fetches the unified balance of a specific token across all chains for a user.
Typescript
// Takes a token symbol parameter
await sdk.getUnifiedBalance(symbol: string): Promise<UserAsset | undefined>Example
Here are some minimal examples of how to use the functions to fetch the unified balance of a user:
Typescript
// Get all balances across chains
const allBalances = await sdk.getUnifiedBalances();
console.log('All balances:', allBalances);
// Get balance for specific token
const usdcBalance = await sdk.getUnifiedBalance('USDC');
console.log('USDC balance:', usdcBalance);Return Value
getUnifiedBalances(): ReturnsPromise<UserAsset[]>- Array ofUserAssetclass instancesgetUnifiedBalance(symbol): ReturnsPromise<UserAsset | undefined>- SingleUserAssetinstance or undefined
Typescript
class UserAsset {
value: UserAssetDatum; // The actual data
get balance(): string; // Getter for balance
}
// The underlying data structure for `UserAsset`
export type UserAssetDatum = {
abstracted?: boolean;
balance: string;
balanceInFiat: number;
breakdown: {
balance: string;
balanceInFiat: number;
chain: {
id: number;
logo: string;
name: string;
};
contractAddress: `0x${string}`;
decimals: number;
isNative?: boolean;
universe: Universe;
}[];
decimals: number;
icon?: string;
symbol: string;
};Last updated on