vaultDetails

post

https://api.hyperliquid.xyzhttps://api.hyperliquid-testnet.xyz

/info

Request details of a vault.

Body

application/json

Request details of a vault.

typeundefined · enumRequired

Type of request.

Possible values:

vaultAddressstring · min: 42 · max: 42Required

Vault address.

Pattern: ^0[xX][0-9a-fA-F]+$

userany ofOptional

User address.

string · min: 42 · max: 42 · nullableOptional

User address.

Pattern: ^0[xX][0-9a-fA-F]+$

Responses

200

Details of a vault or null if the vault does not exist.

application/json

Details of a vault or null if the vault does not exist.

namestringRequired

Vault name.

vaultAddressstringRequired

Vault address.

Pattern: ^0x[a-fA-F0-9]{40}$

leaderstringRequired

Leader address.

Pattern: ^0x[a-fA-F0-9]{40}$

descriptionstringRequired

Vault description.

aprnumberRequired

Annual percentage rate.

followerStateany ofRequired

Current user follower state.

leaderFractionnumberRequired

Ownership percentage held by leader.

leaderCommissionnumberRequired

Leader commission percentage.

maxDistributablenumberRequired

Maximum distributable amount.

maxWithdrawablenumberRequired

Maximum withdrawable amount.

isClosedbooleanRequired

Vault closure status.

allowDepositsbooleanRequired

Deposit permission status.

alwaysCloseOnWithdrawbooleanRequired

Position closure policy on withdrawal.

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

TypeScript

import * as hl from "@nktkas/hyperliquid";

const transport = new hl.HttpTransport(); // or `WebSocketTransport`
const client = new hl.InfoClient({ transport });

const data = await client.vaultDetails({ vaultAddress: "0x..." });

{
  "name": "text",
  "vaultAddress": "text",
  "leader": "text",
  "description": "text",
  "portfolio": null,
  "apr": 1,
  "followerState": {
    "user": "text",
    "vaultEquity": "text",
    "pnl": "text",
    "allTimePnl": "text",
    "daysFollowing": 1,
    "vaultEntryTime": 1,
    "lockupUntil": 1
  },
  "leaderFraction": 1,
  "leaderCommission": 1,
  "followers": [
    {
      "user": "text",
      "vaultEquity": "text",
      "pnl": "text",
      "allTimePnl": "text",
      "daysFollowing": 1,
      "vaultEntryTime": 1,
      "lockupUntil": 1
    }
  ],
  "maxDistributable": 1,
  "maxWithdrawable": 1,
  "isClosed": true,
  "relationship": null,
  "allowDeposits": true,
  "alwaysCloseOnWithdraw": true
}