Skip to main content
POST
/
exchange
Modify vault settings
curl --request POST \
  --url https://api.hyperliquid.xyz/exchange \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": {
    "type": "vaultModify",
    "vaultAddress": "0x1719884eb866cb12b2287399b15f7db5e7d775ea",
    "allowDeposits": true,
    "alwaysCloseOnWithdraw": false
  },
  "nonce": 1705234567890,
  "signature": {
    "r": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "s": "0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321",
    "v": 27
  }
}
'
{
  "status": "ok",
  "response": {
    "type": "default"
  }
}
You can only use this endpoint on the official Hyperliquid public API. It is not available through Chainstack, as the open-source node implementation does not support it yet. See Hyperliquid methods for the full availability breakdown.
This endpoint requires signature authentication. See our comprehensive Authentication via Signatures guide for implementation details.
The vaultModify action updates a vault’s settings — whether it accepts deposits from followers and whether it always closes positions on withdrawal.
Get your own node endpoint todayStart for free and get your app to production levels immediately. No credit card required.You can sign up with your GitHub, X, Google, or Microsoft account.

Parameters

Required parameters

  • action (object, required) — The vault-modify action:
    • type (string) — Must be "vaultModify".
    • vaultAddress (string) — The vault address to modify.
    • allowDeposits (boolean or null) — Allow deposits from followers; null leaves it unchanged.
    • alwaysCloseOnWithdraw (boolean or null) — Always close positions on withdrawal; null leaves it unchanged.
  • nonce (number, required) — Current timestamp in milliseconds.
  • signature (object, required) — EIP-712 signature of the action.

Optional parameters

  • expiresAfter (number, optional) — Timestamp in milliseconds after which the request is rejected.

Returns

Returns an object with the action status:
  • status"ok" if the request was processed.
  • response — Contains operation details, with type "default".

Example request

curl -X POST https://api.hyperliquid.xyz/exchange \
  -H "Content-Type: application/json" \
  -d '{
    "action": {
      "type": "vaultModify",
      "vaultAddress": "0x1719884eb866cb12b2287399b15f7db5e7d775ea",
      "allowDeposits": true,
      "alwaysCloseOnWithdraw": false
    },
    "nonce": 1234567890123,
    "signature": {...}
  }'

Response example

{
  "status": "ok",
  "response": {
    "type": "default"
  }
}

Use cases

  • Open or close to deposits — Control whether followers can deposit
  • Set withdrawal behavior — Toggle always-close-on-withdraw
  • Vault administration — Adjust vault policy as a vault leader

Body

application/json
action
object
required
nonce
integer
required

Current timestamp in milliseconds

signature
object
required

EIP-712 signature of the action with r, s, v components

expiresAfter
integer

Timestamp in milliseconds after which the request is rejected (optional)

Response

200 - application/json

Vault modify result

status
string

Request status

response
object
Last modified on June 24, 2026