> ## Documentation Index
> Fetch the complete documentation index at: https://goldrush.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# vaultDetails | Hyperliquid Info API

> Hyperliquid vaultDetails: fetch detailed information for a specific vault.

> [card] Credit Cost
>
> 1 per call

> [card] Processing
>
> Realtime

The Hyperliquid info endpoint with `type: "vaultDetails"` is used to fetch detailed information for a specific vault.

> [!TIP]
>
> Estimate your monthly cost for this API using the [Pricing Calculator](https://goldrush.dev/docs/pricing-calculator.md?endpoint=%2Fapi-reference%2Fhyperliquid-info%2Fvault-details).

> [!NOTE]
>
> * Wire-equal to `POST api.hyperliquid.xyz/info` with `{"type": "vaultDetails", "vaultAddress": "..."}`.
> * `vaultAddress` is required; the optional `user` field populates `followerState` with that wallet's position in the vault.
> * `portfolio` is an array of `[period, series]` pairs bucketed by `day`, `week`, `month`, `allTime`, and their `perp*` variants.
> * Aggregate stats (`apr`, `leaderFraction`, `leaderCommission`, `maxDistributable`, `maxWithdrawable`) are JSON numbers, while position, equity, and history values are decimal strings.
> * For a lightweight list across all vaults, use [vaultSummaries](https://goldrush.dev/docs/api-reference/hyperliquid-info/vault-summaries.md).

Returns the full detail for a single vault: identity (name, address, leader, description), time-bucketed performance history (portfolio), headline stats (apr, distributable and withdrawable amounts), the follower roster, and the vault's relationship to any parent or child vaults.

## Endpoint

```
POST https://hypercore.goldrushdata.com/info
Authorization: Bearer <GOLDRUSH_API_KEY>
Content-Type: application/json
```

## Request

**type** `string` *required* (default: vaultDetails)

Always `"vaultDetails"`.

**vaultAddress** `string` *required*

The vault contract address (lowercase 0x-prefixed hex).

**user** `string`

Optional wallet address (lowercase 0x-prefixed hex). When supplied, `followerState` is populated with that wallet's position in the vault.

### Example

```bash cURL theme={null}
curl -X POST https://hypercore.goldrushdata.com/info \
  -H "Authorization: Bearer $GOLDRUSH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "vaultDetails",
    "vaultAddress": "0xdfc24b077bc1425ad1dea75bcb6f8158e10df303"
  }'
```

```typescript TypeScript theme={null}
const response = await fetch("https://hypercore.goldrushdata.com/info", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.GOLDRUSH_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    type: "vaultDetails",
    vaultAddress: "0xdfc24b077bc1425ad1dea75bcb6f8158e10df303",
  }),
});

const vault = await response.json();
```

```python Python theme={null}
import os, requests

response = requests.post(
    "https://hypercore.goldrushdata.com/info",
    headers={"Authorization": f"Bearer {os.environ['GOLDRUSH_API_KEY']}"},
    json={
        "type": "vaultDetails",
        "vaultAddress": "0xdfc24b077bc1425ad1dea75bcb6f8158e10df303",
    },
)

vault = response.json()
```

## Response

A single object describing the vault.

```json theme={null}
{
  "name": "Hyperliquidity Provider (HLP)",
  "vaultAddress": "0xdfc24b077bc1425ad1dea75bcb6f8158e10df303",
  "leader": "0x677d831aef5328190852e24f13c46cac05f984e7",
  "description": "This community-owned vault provides liquidity to Hyperliquid through multiple market making strategies, performs liquidations, and accrues platform fees.",
  "portfolio": [
    [
      "day",
      {
        "accountValueHistory": [[1784713601558, "248732255.46"]],
        "pnlHistory": [[1784713601558, "0.0"]],
        "vlm": "0.0"
      }
    ],
    ["week", { "accountValueHistory": [], "pnlHistory": [], "vlm": "0.0" }],
    ["allTime", { "accountValueHistory": [], "pnlHistory": [], "vlm": "0.0" }]
  ],
  "apr": 0.36387129259090006,
  "followerState": null,
  "leaderFraction": 0.0007904828725729887,
  "leaderCommission": 0,
  "followers": [
    {
      "user": "0x005844b2ffb2e122cf4244be7dbcb4f84924907c",
      "vaultEquity": "714491.71026243",
      "pnl": "3203.43026143",
      "allTimePnl": "79843.74476743",
      "daysFollowing": 388,
      "vaultEntryTime": 1700926145201,
      "lockupUntil": 1734824439201
    }
  ],
  "maxDistributable": 94856870.164485,
  "maxWithdrawable": 742557.680863,
  "isClosed": false,
  "relationship": {
    "type": "parent",
    "data": {
      "childAddresses": [
        "0x010461c14e146ac35fe42271bdc1134ee31c703a",
        "0x2e3d94f0562703b25c83308a05046ddaf9a8dd14"
      ]
    }
  },
  "allowDeposits": true,
  "alwaysCloseOnWithdraw": false
}
```

### Field descriptions

> [!NOTE]
>
> Position, equity, and history values (`portfolio` account-value/PnL samples, `vlm`, and follower `vaultEquity`/`pnl`/`allTimePnl`) are returned as **decimal strings**. The aggregate stats `apr`, `leaderFraction`, `leaderCommission`, `maxDistributable`, and `maxWithdrawable` are returned as JSON **numbers**.

**name** `string`

Vault name.

**vaultAddress** `string`

Vault contract address (0x-prefixed hex).

**leader** `string`

Vault leader (manager) address.

**description** `string`

Free-text description of the vault's strategy.

**portfolio** `array\<[string, object]\>`

Time-bucketed performance history. Each element is a `[period, series]` pair, where `period` is one of `day`, `week`, `month`, `allTime`, `perpDay`, `perpWeek`, `perpMonth`, or `perpAllTime`, and `series` holds the account-value and PnL time series for that period.

**series properties**

**accountValueHistory** `array\<[int, string]\>`

`[timestampMs, accountValue]` samples. Account value is a decimal string.

**pnlHistory** `array\<[int, string]\>`

`[timestampMs, pnl]` samples. PnL is a decimal string.

**vlm** `string`

Traded volume over the period, as a decimal string.

**apr** `number`

Annualized return as a raw fraction (e.g. `0.3639` = 36.39%).

**followerState** `object | null`

The requesting `user`'s follower state in this vault when the optional `user` field is supplied; `null` otherwise.

**leaderFraction** `number`

Fraction of the vault's equity held by the leader.

**leaderCommission** `number`

Leader's commission rate (fraction of follower profits).

**followers** `array\<object\>`

Per-follower positions in the vault.

**properties**

**user** `string`

Follower wallet address (0x-prefixed hex).

**vaultEquity** `string`

Follower's current equity in the vault, in USD (decimal string).

**pnl** `string`

Follower's current-period PnL (decimal string).

**allTimePnl** `string`

Follower's all-time PnL in the vault (decimal string).

**daysFollowing** `int`

Number of days the follower has been in the vault.

**vaultEntryTime** `int`

Unix timestamp (ms) at which the follower entered the vault.

**lockupUntil** `int`

Unix timestamp (ms) until which the follower's equity is locked.

**maxDistributable** `number`

Maximum amount currently distributable from the vault, in USD.

**maxWithdrawable** `number`

Maximum amount the leader can currently withdraw, in USD.

**isClosed** `boolean`

Whether the vault is closed.

**relationship** `object`

Relationship metadata for the vault.

**properties**

**type** `string`

Relationship type - `"normal"` for a standalone vault, or `"parent"` / `"child"` for linked vaults.

**data** `object`

Present for parent/child relationships. For a `parent`, contains `childAddresses` (an array of child vault addresses); for a `child`, identifies the parent vault.

**allowDeposits** `boolean`

Whether the vault currently accepts new deposits.

**alwaysCloseOnWithdraw** `boolean`

Whether a withdrawal always fully closes the follower's position.

## Related endpoints

> [card] [vaultSummaries](https://goldrush.dev/docs/api-reference/hyperliquid-info/vault-summaries.md)
>
> list summary information for every vault on the platform.

> [card] [userVaultEquities](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-vault-equities.md)
>
> fetch a user's locked vault equity positions across all vaults they have deposited into.

> [card] [leadingVaults](https://goldrush.dev/docs/api-reference/hyperliquid-info/leading-vaults.md)
>
> list the vaults a user leads.

See all Hyperliquid endpoints: [Overview hub](https://goldrush.dev/docs/goldrush-hyperliquid/overview.md) · [Info API reference](https://goldrush.dev/docs/goldrush-hyperliquid/info-api/overview.md)

*Last reviewed: 2026-08-17*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.