Vault modify | Hyperliquid exchange

Modify a vault’s settings — whether it accepts deposits and whether it always closes positions on withdrawal. On Hyperliquid exchange.

POST /exchange

Modify vault settings

cURL

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
  }
}
'

import requests

url = "https://api.hyperliquid.xyz/exchange"

payload = {
    "action": {
        "type": "vaultModify",
        "vaultAddress": "0x1719884eb866cb12b2287399b15f7db5e7d775ea",
        "allowDeposits": True,
        "alwaysCloseOnWithdraw": False
    },
    "nonce": 1705234567890,
    "signature": {
        "r": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
        "s": "0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321",
        "v": 27
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    action: {
      type: 'vaultModify',
      vaultAddress: '0x1719884eb866cb12b2287399b15f7db5e7d775ea',
      allowDeposits: true,
      alwaysCloseOnWithdraw: false
    },
    nonce: 1705234567890,
    signature: {
      r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
      s: '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321',
      v: 27
    }
  })
};

fetch('https://api.hyperliquid.xyz/exchange', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperliquid.xyz/exchange",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'action' => [
        'type' => 'vaultModify',
        'vaultAddress' => '0x1719884eb866cb12b2287399b15f7db5e7d775ea',
        'allowDeposits' => true,
        'alwaysCloseOnWithdraw' => false
    ],
    'nonce' => 1705234567890,
    'signature' => [
        'r' => '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
        's' => '0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321',
        'v' => 27
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperliquid.xyz/exchange"

	payload := strings.NewReader("{\n  \"action\": {\n    \"type\": \"vaultModify\",\n    \"vaultAddress\": \"0x1719884eb866cb12b2287399b15f7db5e7d775ea\",\n    \"allowDeposits\": true,\n    \"alwaysCloseOnWithdraw\": false\n  },\n  \"nonce\": 1705234567890,\n  \"signature\": {\n    \"r\": \"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef\",\n    \"s\": \"0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321\",\n    \"v\": 27\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperliquid.xyz/exchange")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": {\n    \"type\": \"vaultModify\",\n    \"vaultAddress\": \"0x1719884eb866cb12b2287399b15f7db5e7d775ea\",\n    \"allowDeposits\": true,\n    \"alwaysCloseOnWithdraw\": false\n  },\n  \"nonce\": 1705234567890,\n  \"signature\": {\n    \"r\": \"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef\",\n    \"s\": \"0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321\",\n    \"v\": 27\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperliquid.xyz/exchange")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": {\n    \"type\": \"vaultModify\",\n    \"vaultAddress\": \"0x1719884eb866cb12b2287399b15f7db5e7d775ea\",\n    \"allowDeposits\": true,\n    \"alwaysCloseOnWithdraw\": false\n  },\n  \"nonce\": 1705234567890,\n  \"signature\": {\n    \"r\": \"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef\",\n    \"s\": \"0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321\",\n    \"v\": 27\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "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 today

Start 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

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": {...}
  }'

# Note: the official hyperliquid-python-sdk does not expose a vaultModify helper
# yet, so build and post the signed action directly.
from hyperliquid.exchange import Exchange
from hyperliquid.utils import constants
from hyperliquid.utils.signing import sign_l1_action, get_timestamp_ms
import eth_account

# Public Hyperliquid mainnet endpoint
wallet = eth_account.Account.from_key("0x...")  # your private key
exchange = Exchange(wallet, constants.MAINNET_API_URL)

timestamp = get_timestamp_ms()
action = {
    "type": "vaultModify",
    "vaultAddress": "0x1719884eb866cb12b2287399b15f7db5e7d775ea",
    "allowDeposits": True,
    "alwaysCloseOnWithdraw": False,
}
signature = sign_l1_action(
    wallet,
    action,
    None,  # vault_address
    timestamp,
    None,  # expires_after
    exchange.base_url == constants.MAINNET_API_URL,
)
result = exchange._post_action(action, signature, timestamp)
print(result)

import { ExchangeClient, HttpTransport } from "@nktkas/hyperliquid";
import { privateKeyToAccount } from "viem/accounts";

// Public Hyperliquid mainnet endpoint (default transport)
const wallet = privateKeyToAccount("0x..."); // viem or ethers account
const transport = new HttpTransport();
const exchange = new ExchangeClient({ transport, wallet });

const result = await exchange.vaultModify({
  vaultAddress: "0x1719884eb866cb12b2287399b15f7db5e7d775ea",
  allowDeposits: true,
  alwaysCloseOnWithdraw: false,
});

console.log(result);

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

Show child attributes

nonce · integer · required

Current timestamp in milliseconds

signature · object · required

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

Show child attributes

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

Show child attributes