> For the complete documentation index, see [llms.txt](https://docs.yo.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yo.xyz/integrations/integration-guides/sdk/react/hooks/use-user-balance.md).

# use user balance

Fetches a connected user's position in a vault — shares and equivalent asset value.

```tsx
const { position, isLoading, refetch } = useUserBalance('yoETH', address)
```

## Usage

```tsx
import { useUserBalance } from '@yo-protocol/react'
import { useAccount } from 'wagmi'
import { formatEther } from 'viem'

function UserPosition() {
  const { address } = useAccount()
  const { position, isLoading } = useUserBalance('yoETH', address)

  if (!address) return <p>Connect wallet to view position</p>
  if (isLoading) return <p>Loading position...</p>

  return (
    <dl>
      <dt>Shares</dt>
      <dd>{formatEther(position?.shares ?? 0n)}</dd>
      <dt>Assets</dt>
      <dd>{formatEther(position?.assets ?? 0n)}</dd>
    </dl>
  )
}
```

## Parameters

| Parameter | Type                   | Required | Description                                       |
| --------- | ---------------------- | -------- | ------------------------------------------------- |
| `vault`   | `Address \| VaultId`   | Yes      | Vault address or named ID                         |
| `account` | `Address \| undefined` | No       | User address. Query is disabled when `undefined`. |

## Return Value

| Field       | Type                             | Description                                   |
| ----------- | -------------------------------- | --------------------------------------------- |
| `position`  | `UserVaultPosition \| undefined` | Full user position                            |
| `isLoading` | `boolean`                        | `true` while the initial fetch is in progress |
| `isError`   | `boolean`                        | `true` if the query failed                    |
| `error`     | `Error \| null`                  | Error object if the query failed              |
| `refetch`   | `() => void`                     | Manually trigger a refetch                    |

### UserVaultPosition shape

| Property | Type     | Description                                     |
| -------- | -------- | ----------------------------------------------- |
| `shares` | `bigint` | Vault share balance                             |
| `assets` | `bigint` | Equivalent asset value at current exchange rate |

## Caching

| Setting           | Value | Description                                      |
| ----------------- | ----- | ------------------------------------------------ |
| `staleTime`       | 15s   | Position data is considered fresh for 15 seconds |
| `refetchInterval` | 30s   | Background refetch every 30 seconds              |

{% hint style="info" %}
**Automatic invalidation**

Queries are automatically invalidated after a successful `useDeposit`, `useRedeem`, or `useApprove` transaction.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.yo.xyz/integrations/integration-guides/sdk/react/hooks/use-user-balance.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.