User portfolio margin | Hyperliquid exchange

Enable or disable portfolio margin for a Hyperliquid account. On Hyperliquid exchange.

POST /exchange

Enable or disable portfolio margin

cURL

curl --request POST \
  --url https://api.hyperliquid.xyz/exchange \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": {
    "type": "userPortfolioMargin",
    "signatureChainId": "0x66eee",
    "hyperliquidChain": "Mainnet",
    "user": "0x1442ad477ded1b0028b57621aa7b6f7eadb8f568",
    "enabled": true,
    "nonce": 1705234567890
  },
  "nonce": 1705234567890,
  "signature": {
    "r": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "s": "0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321",
    "v": 27
  }
}
'

import requests

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

payload = {
    "action": {
        "type": "userPortfolioMargin",
        "signatureChainId": "0x66eee",
        "hyperliquidChain": "Mainnet",
        "user": "0x1442ad477ded1b0028b57621aa7b6f7eadb8f568",
        "enabled": True,
        "nonce": 1705234567890
    },
    "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: 'userPortfolioMargin',
      signatureChainId: '0x66eee',
      hyperliquidChain: 'Mainnet',
      user: '0x1442ad477ded1b0028b57621aa7b6f7eadb8f568',
      enabled: true,
      nonce: 1705234567890
    },
    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' => 'userPortfolioMargin',
        'signatureChainId' => '0x66eee',
        'hyperliquidChain' => 'Mainnet',
        'user' => '0x1442ad477ded1b0028b57621aa7b6f7eadb8f568',
        'enabled' => true,
        'nonce' => 1705234567890
    ],
    '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\": \"userPortfolioMargin\",\n    \"signatureChainId\": \"0x66eee\",\n    \"hyperliquidChain\": \"Mainnet\",\n    \"user\": \"0x1442ad477ded1b0028b57621aa7b6f7eadb8f568\",\n    \"enabled\": true,\n    \"nonce\": 1705234567890\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\": \"userPortfolioMargin\",\n    \"signatureChainId\": \"0x66eee\",\n    \"hyperliquidChain\": \"Mainnet\",\n    \"user\": \"0x1442ad477ded1b0028b57621aa7b6f7eadb8f568\",\n    \"enabled\": true,\n    \"nonce\": 1705234567890\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\": \"userPortfolioMargin\",\n    \"signatureChainId\": \"0x66eee\",\n    \"hyperliquidChain\": \"Mainnet\",\n    \"user\": \"0x1442ad477ded1b0028b57621aa7b6f7eadb8f568\",\n    \"enabled\": true,\n    \"nonce\": 1705234567890\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 userPortfolioMargin action enables or disables portfolio margin for an account. This is a user-signed EIP-712 action.

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 portfolio-margin action:
  • type (string) — Must be "userPortfolioMargin".
  • signatureChainId (string) — Chain ID in hex used for EIP-712 signing.
  • hyperliquidChain (string) — "Mainnet" or "Testnet".
  • user (string) — The user address.
  • enabled (boolean) — true to enable portfolio margin, false to disable it.
  • nonce (number) — Timestamp in milliseconds, equal to the envelope nonce.
• nonce (number, required) — Current timestamp in milliseconds.
• signature (object, required) — EIP-712 signature of the action.

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": "userPortfolioMargin",
      "signatureChainId": "0x66eee",
      "hyperliquidChain": "Mainnet",
      "user": "0x0000000000000000000000000000000000000000",
      "enabled": true,
      "nonce": 1234567890123
    },
    "nonce": 1234567890123,
    "signature": {...}
  }'

# Note: the official hyperliquid-python-sdk does not expose a userPortfolioMargin
# helper yet. This is a user-signed (EIP-712) action, so supply its typed-data
# fields and primary type when signing.
from hyperliquid.exchange import Exchange
from hyperliquid.utils import constants
from hyperliquid.utils.signing import sign_user_signed_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": "userPortfolioMargin",
    "signatureChainId": "0x66eee",
    "hyperliquidChain": "Mainnet",
    "user": "0x0000000000000000000000000000000000000000",
    "enabled": True,
    "nonce": timestamp,
}
payload_types = [
    {"name": "hyperliquidChain", "type": "string"},
    {"name": "user", "type": "address"},
    {"name": "enabled", "type": "bool"},
    {"name": "nonce", "type": "uint64"},
]
signature = sign_user_signed_action(
    wallet,
    action,
    payload_types,
    "HyperliquidTransaction:UserPortfolioMargin",
    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.userPortfolioMargin({
  user: "0x0000000000000000000000000000000000000000",
  enabled: true,
});

console.log(result);

Response example

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

Use cases

• Enable portfolio margin — Margin across the whole portfolio rather than per-position
• Toggle margin mode — Switch portfolio margin on or off
• Capital efficiency — Optimize margin usage for diversified portfolios

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

Response

200 - application/json

User portfolio margin result

status · string

Request status

response · object

Show child attributes