yieldaggregator

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)

get/defi/v1/yieldaggregator/getbalance

Request

Base URL
https://svc.blockdaemon.com
URL
https://svc.blockdaemon.com/defi/v1/yieldaggregator/getbalance
Auth
API key in header X-API-Key

Query parameters

addressstring 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.

Example:0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402

tokenAddressstring

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

Example:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48

vaultNumberstring

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.

Example:1

yieldAggregatorId'5000' | '5001' | '5002' | '5003' | '5200' | '5201' | '5202' | '5203' | '5204' | '5100'

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

Example:5000

vaultAddressstring

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

Example:0xa258C4606Ca8206D8aA700cE2143D7db854D168c

marketAddressstring 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.

Example:0xcdd26eb5eb2ce0f203a84553853667ae69ca29ce

poolAddressstring

Pool's address.

Example:0xfad57d2039c21811c8f2b5d5b65308aa99d31559

Response

Successful response

statusinteger

msgstring

dataobject

Example response

{
  "status": 200,
  "msg": "success",
  "data": {
    "vaultBalance": "0",
    "poolBalance": "0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.