vaultDetails

post
/info

Request details of a vault.

Body

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 | nullableOptionalPattern: ^0[xX][0-9a-fA-F]+$
Responses
200

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

application/json
post
/info
POST /info HTTP/1.1
Host: api.hyperliquid.xyz
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "type": "vaultDetails",
  "vaultAddress": "text",
  "user": "text"
}
{
  "name": "text",
  "vaultAddress": "text",
  "leader": "text",
  "description": "text",
  "portfolio": [],
  "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": {
    "type": "normal"
  },
  "allowDeposits": true,
  "alwaysCloseOnWithdraw": true
}

Last updated