> 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-vault.md).

# use vault

Fetches on-chain vault state and off-chain snapshot data with automatic caching and background refetching.

```tsx
const { vault, isLoading, isError, error, refetch } = useVault('yoETH')
```

## Usage

```tsx
import { useVault } from '@yo-protocol/react'

function VaultInfo() {
  const { vault, isLoading, isError, error, refetch } = useVault('yoETH')

  if (isLoading) return <p>Loading vault...</p>
  if (isError) return <p>Error: {error?.message}</p>

  return (
    <div>
      <h2>{vault?.name}</h2>
      <p>Total Assets: {vault?.totalAssets.toString()}</p>
      <p>Exchange Rate: {vault?.exchangeRate.toString()}</p>
      <button onClick={() => refetch()}>Refresh</button>
    </div>
  )
}
```

## Parameters

| Parameter | Type                 | Required | Description                                            |
| --------- | -------------------- | -------- | ------------------------------------------------------ |
| `vault`   | `Address \| VaultId` | Yes      | Vault address or named ID (`'yoETH'`, `'yoUSD'`, etc.) |

## Return Value

| Field       | Type                      | Description                                                                         |
| ----------- | ------------------------- | ----------------------------------------------------------------------------------- |
| `vault`     | `VaultState \| undefined` | On-chain vault state including `name`, `totalAssets`, `exchangeRate`, `totalSupply` |
| `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                                                          |

## Caching

| Setting           | Value | Description                             |
| ----------------- | ----- | --------------------------------------- |
| `staleTime`       | 30s   | Data is considered fresh for 30 seconds |
| `refetchInterval` | 60s   | Background refetch every 60 seconds     |

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

After a successful `useDeposit` or `useRedeem` transaction, the `useVault` query is automatically invalidated so the UI reflects the latest state without a manual refetch.
{% 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.