referral

post

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

/info

Request user referral.

Body

application/json

Request user referral.

typeundefined · enumRequired

Type of request.

Possible values:

userstring · min: 42 · max: 42Required

User address.

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

Responses

200

Referral details for a user.

application/json

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

HTTPcURLJavaScriptPython

POST /info HTTP/1.1
Host: api.hyperliquid.xyz
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "type": "referral",
  "user": "text"
}

{
  "referredBy": {
    "referrer": "text",
    "code": "text"
  },
  "cumVlm": "text",
  "unclaimedRewards": "text",
  "claimedRewards": "text",
  "builderRewards": "text",
  "referrerState": {
    "stage": "ready",
    "data": {
      "code": "text",
      "nReferrals": 1,
      "referralStates": [
        {
          "cumVlm": "text",
          "cumRewardedFeesSinceReferred": "text",
          "cumFeesRewardedToReferrer": "text",
          "timeJoined": 1,
          "user": "text",
          "tokenToState": [
            []
          ]
        }
      ]
    }
  },
  "rewardHistory": [
    {
      "earned": "text",
      "vlm": "text",
      "referralVlm": "text",
      "time": 1
    }
  ],
  "tokenToState": [
    []
  ]
}