delegatorSummary

post

https://api.hyperliquid.xyzhttps://api.hyperliquid-testnet.xyz

/info

Request user's staking summary.

Body

application/json

Request user's staking summary.

typeundefined · enumRequired

Type of request.

Possible values:

userstring · min: 42 · max: 42Required

User address.

Pattern: ^0[xX][0-9a-fA-F]+$

Responses

200

User's staking summary.

application/json

User's staking summary.

delegatedstringRequired

Total amount of delegated tokens.

Pattern: ^[0-9]+(\.[0-9]+)?$

undelegatedstringRequired

Total amount of undelegated tokens.

Pattern: ^[0-9]+(\.[0-9]+)?$

totalPendingWithdrawalstringRequired

Total amount of tokens pending withdrawal.

Pattern: ^[0-9]+(\.[0-9]+)?$

nPendingWithdrawalsnumberRequired

Number of pending withdrawals.

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

TypeScript

import * as hl from "@nktkas/hyperliquid";

const transport = new hl.HttpTransport(); // or `WebSocketTransport`
const client = new hl.InfoClient({ transport });

const data = await client.delegatorSummary({ user: "0x..." });

{
  "delegated": "text",
  "undelegated": "text",
  "totalPendingWithdrawal": "text",
  "nPendingWithdrawals": 1
}