> ## Documentation Index
> Fetch the complete documentation index at: https://chainstack-docs-polygon-erigon-trace-deprecation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Vault modify | Hyperliquid exchange

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

<Info>
  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](/docs/hyperliquid-methods) for the full availability breakdown.
</Info>

<Note>
  This endpoint requires signature authentication. See our comprehensive [Authentication via Signatures guide](/docs/hyperliquid-authentication-guide) for implementation details.
</Note>

The `vaultModify` action updates a vault's settings — whether it accepts deposits from followers and whether it always closes positions on withdrawal.

## 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

<CodeGroup>
  ```shell cURL theme={null}
  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": {...}
    }'
  ```

  ```python Python (hyperliquid-python-sdk) theme={null}
  # 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)
  ```

  ```typescript TypeScript (@nktkas/hyperliquid) theme={null}
  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);
  ```
</CodeGroup>

## Response example

```json theme={null}
{
  "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


## OpenAPI

````yaml openapi/hyperliquid_node_api/hypercore_exchange/exchange_vault_modify.json post /exchange
openapi: 3.0.0
info:
  title: Hyperliquid Exchange API
  version: 1.0.0
  description: >-
    API for trading operations on Hyperliquid exchange requiring authentication.
    ⚠️ WARNING: These endpoints require EIP-712 signatures for authentication.
    The example values provided will NOT work without proper cryptographic
    signing. You must implement EIP-712 signing to use these endpoints
    successfully.
servers:
  - url: https://api.hyperliquid.xyz
security: []
paths:
  /exchange:
    post:
      tags:
        - hyperliquid exchange
      summary: Modify vault settings
      operationId: vaultModify
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: object
                  properties:
                    type:
                      type: string
                      default: vaultModify
                      enum:
                        - vaultModify
                      description: Action type
                    vaultAddress:
                      type: string
                      description: Vault address to modify
                    allowDeposits:
                      type: boolean
                      nullable: true
                      description: Allow deposits from followers (null to leave unchanged)
                    alwaysCloseOnWithdraw:
                      type: boolean
                      nullable: true
                      description: >-
                        Always close positions on withdrawal (null to leave
                        unchanged)
                  required:
                    - type
                    - vaultAddress
                nonce:
                  type: integer
                  description: Current timestamp in milliseconds
                signature:
                  type: object
                  description: EIP-712 signature of the action with r, s, v components
                  properties:
                    r:
                      type: string
                      example: >-
                        0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
                    s:
                      type: string
                      example: >-
                        0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321
                    v:
                      type: integer
                      example: 27
                  required:
                    - r
                    - s
                    - v
                expiresAfter:
                  type: integer
                  description: >-
                    Timestamp in milliseconds after which the request is
                    rejected (optional)
              required:
                - action
                - nonce
                - signature
            example:
              action:
                type: vaultModify
                vaultAddress: '0x1719884eb866cb12b2287399b15f7db5e7d775ea'
                allowDeposits: true
                alwaysCloseOnWithdraw: false
              nonce: 1705234567890
              signature:
                r: >-
                  0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
                s: >-
                  0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321
                v: 27
      responses:
        '200':
          description: Vault modify result
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Request status
                  response:
                    type: object
                    properties:
                      type:
                        type: string
                        default: default
                example:
                  status: ok
                  response:
                    type: default

````