---
title: "Get balances for a specific yield"
method: POST
path: "/v1/yields/{yieldId}/balances"
tags: ["Portfolio"]
---

# Get balances for a specific yield

`POST /v1/yields/{yieldId}/balances`

Retrieve all balances associated with a yield opportunity for a specific wallet address, including active, pending, claimable, and withdrawable balances. The network is automatically determined from the yield configuration.

## Path parameters

- `yieldId` string, required

## Request body

- YieldBalancesRequestDto
  - `address` string, required — User wallet address to check balances for
  - `arguments` GetBalancesArgumentsDto
    - `cAddressBech` string — Avalanche C-chain address
    - `pAddressBech` string — Avalanche P-chain address
    - `autoSweepDayOfMonth` number — Day of month when auto-sweep window starts (used by Solana auto-sweep balance actions)
    - `autoSweepTimezone` string — IANA timezone used to evaluate auto-sweep window day (e.g. Europe/London)

## Response `200`

Returns balance information including different balance types (active, entering, exiting, withdrawable, claimable, locked) with amounts and available actions

- YieldBalancesDto
  - `yieldId` string, required — Unique identifier of the yield
  - `balances` BalanceDto[], required — List of balances for this yield
    - `providerId` string, required — Provider ID
    - `collateral` TokenDto, required
      - `address` string — Token contract address
      - `symbol` string, required — Token symbol
      - `name` string, required — Token name
      - `decimals` number, required — Token decimals
      - `logoURI` string — Token logo URI
    - `accountValue` number, required — Total account value in collateral asset
    - `usedMargin` number, required — Margin used by positions in collateral asset
    - `availableBalance` number, required — Available balance for new positions in collateral asset
    - `unrealizedPnl` number, required — Total price PnL across all positions in collateral asset (excludes funding)
    - `unifiedAccountMode` boolean — Whether the account currently has Unified Account Mode enabled (collateral unified across venues). Only present for providers that support it (Hyperliquid).
  - `outputTokenBalance` BalanceDto
    - `providerId` string, required — Provider ID
    - `collateral` TokenDto, required
      - `address` string — Token contract address
      - `symbol` string, required — Token symbol
      - `name` string, required — Token name
      - `decimals` number, required — Token decimals
      - `logoURI` string — Token logo URI
    - `accountValue` number, required — Total account value in collateral asset
    - `usedMargin` number, required — Margin used by positions in collateral asset
    - `availableBalance` number, required — Available balance for new positions in collateral asset
    - `unrealizedPnl` number, required — Total price PnL across all positions in collateral asset (excludes funding)
    - `unifiedAccountMode` boolean — Whether the account currently has Unified Account Mode enabled (collateral unified across venues). Only present for providers that support it (Hyperliquid).
  - `rewardRate` RewardRateDto
    - `total` number, required — Estimated underlying integration reward rate across all sources. May include an additional campaign component when an active campaign applies to this project.
    - `rateType` string, required — Whether this reward rate is APR or APY
    - `components` RewardDto[], required — Breakdown of reward rates by source
      - `rate` number, required — Reward rate as a decimal (e.g. 0.04 = 4%)
      - `rateType` string, required — Whether this rate is APR or APY
      - `token` TokenDto, required
        - `address` string — Token contract address
        - `symbol` string, required — Token symbol
        - `name` string, required — Token name
        - `decimals` number, required — Token decimals
        - `logoURI` string — Token logo URI
      - `yieldSource` 'staking' | 'liquid_staking' | 'restaking' | 'protocol_incentive' | 'campaign_incentive' | 'points' | 'lending' | 'mev' | 'real_world_asset_yield' | 'vault', required — Structured source of yield (e.g. staking, protocol incentive)
      - `description` string — Optional human-readable description of this reward

## Other responses

- `400` — Invalid request parameters
- `401` — Invalid or missing API key
- `404` — Yield not found with the specified ID
- `429` — Rate limit exceeded
- `500` — Internal server error

---

[API](https://skmtc.net/yield/apis/yield-xyz-api.md) · [All operations](https://skmtc.net/yield/apis/yield-xyz-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yield/yield-xyz-api/versions/acfa80015ca5/schema)