Hyperliquid HIP-3 icon

Hyperliquid HIP-3

Trade builder-deployed HIP-3 perpetual assets on Hyperliquid (e.g. xyz:XYZ100)

Actions33

Account → Get Margin Summary

AI-generated

Summary

Retrieve the margin summary for the authenticated user's account on a specified HIP-3 builder-deployed DEX.

Inputs

  • ⚠️ This node trades HIP-3 builder-deployed perpetuals only (e.g. xyz:XYZ100). Assets are automatically prefixed with the DEX name set in credentials. For standard Hyperliquid perpetuals use the Hyperliquid node instead. — Notice informing that this operation works only with HIP-3 builder-deployed perpetuals, and that asset symbols are auto-prefixed from credentials.

Output shape

a single JSON object containing the margin summary from the DEX clearinghouse state, including fields such as accountValue, totalRawUsd, and other margin-related metrics.

The response includes margin summary data scoped to the authenticated user's account for the DEX identified by credentials. The asset symbols and DEX are determined by the credentials configuration. This operation may throw errors if the DEX metadata or clearinghouse state cannot be fetched.

Examples

Example 1: Retrieve margin summary for current user on the specified HIP-3 DEX

No additional parameters are required beyond selecting the Account resource and Get Margin Summary operation. The node uses credentials to identify the user and DEX.

Links

Discussion