Get Balance

Retrieves a user’s current liquidity balance and position within yield-generating vaults or pools across supported protocols and blockchain networks. This endpoint returns a numeric value representing the total liquidity available for the given address, with detailed breakdowns of both vault and pool balances. Users can query their balance either by providing a direct vaultAddress or by supplying a tokenAddress along with a vaultNumber, in addition to required parameters such as the user’s public address and yieldAggregatorId. This comprehensive data is essential for developers and users seeking to monitor yield positions, manage liquidity, track earned yields, and integrate real-time yield data into DeFi portfolio management and performance analytics tools.

💡

Compute Unit Value: 25 (Fixed)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The public blockchain address of the user whose liquidity balance is being queried. This value specifies the owner of the tokens deposited in the yield aggregator.

string

The contract address of the token. Use this parameter when querying by token, in combination with vaultNumber, if the vaultAddress is not provided.

string

The identifier for the specific vault holding the token, used when multiple vaults exist for the same token. Provide this along with tokenAddress if not directly specifying vaultAddress.

string
enum

The unique ID to specify the yield aggregator for queries or transactions.

string

The address of the yield vault. Use this parameter to directly query a specific vault instead of using tokenAddress and vaultNumber.

string
required

The unique blockchain address that identifies the specific yield market or vault within the yield aggregator. This parameter directs the query to the appropriate liquidity pool where deposits are made.

string

Pool's address.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json