View Source Hyperliquid.Api.Exchange.UserPortfolioMargin (hyperliquid v0.4.1)

Enable or disable portfolio margin mode for the calling user.

Portfolio margin allows cross-margining across perps positions using a portfolio risk model rather than per-position margin requirements.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint

Usage 

{:ok, result} = UserPortfolioMargin.request(true)   # enable
{:ok, result} = UserPortfolioMargin.request(false)  # disable

Summary

Functions

request(on, opts \\ [])

Enable or disable portfolio margin mode.

Functions

Link to this function

request(on, opts \\ [])

View Source

Enable or disable portfolio margin mode.

Parameters

  • on: true to enable portfolio margin, false to disable
  • opts: Optional parameters

Options

  • :private_key - Private key for signing (falls back to config)

Returns

  • {:ok, response} - Result
  • {:error, term()} - Error details