referral Info Endpoint Method

Please note that this method is only accessible through the official Hyperliquid public API. At the moment, Quicknode does not support this endpoint because it is not implemented in the open-source Hyperliquid node.

Parameters

type

string

REQUIRED

Loading...

user

string

REQUIRED

Loading...

Returns

referredBy

object

Loading...

referrer

string

Loading...

code

string

Loading...

cumVlm

string

Loading...

unclaimedRewards

string

Loading...

claimedRewards

string

Loading...

builderRewards

string

Loading...

referrerState

object

Loading...

stage

string

Loading...

data

object

Loading...

code

string

Loading...

referralStates

array

Loading...

cumVlm

string

Loading...

cumRewardedFeesSinceReferred

string

Loading...

cumFeesRewardedToReferrer

string

Loading...

timeJoined

integer

Loading...

user

string

Loading...

rewardHistory

array

Loading...

tokenToState

array

Loading...

tokenId

integer

Loading...

state

object

Loading...

cumVlm

string

Loading...

unclaimedRewards

string

Loading...

claimedRewards

string

Loading...

builderRewards

string

Loading...

Request

1
curl https://api.hyperliquid.xyz/info \
2
  -X POST \
3
  -H "Content-Type: application/json" \
4
  --data '{"type":"referral","user":"0x31ca8395cf837de08b24da3f660e77761dfb974b"}'

1
curl https://api.hyperliquid.xyz/info \
2
  -X POST \
3
  -H "Content-Type: application/json" \
4
  --data '{"type":"referral","user":"0x31ca8395cf837de08b24da3f660e77761dfb974b"}'

1
var myHeaders = new Headers();
2
myHeaders.append("Content-Type", "application/json");
3

4
var raw = JSON.stringify({
5
  "type": "referral",
6
  "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
7
});
8

9
var requestOptions = {
10
  method: 'POST',
11
  headers: myHeaders,
12
  body: raw,
13
  redirect: 'follow'
14
};
15

16
fetch("https://api.hyperliquid.xyz/info", requestOptions)
17
  .then(response => response.text())
18
  .then(result => console.log(result))
19
  .catch(error => console.log('error', error));
20

1
var myHeaders = new Headers();
2
myHeaders.append("Content-Type", "application/json");
3

4
var raw = JSON.stringify({
5
  "type": "referral",
6
  "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
7
});
8

9
var requestOptions = {
10
  method: 'POST',
11
  headers: myHeaders,
12
  body: raw,
13
  redirect: 'follow'
14
};
15

16
fetch("https://api.hyperliquid.xyz/info", requestOptions)
17
  .then(response => response.text())
18
  .then(result => console.log(result))
19
  .catch(error => console.log('error', error));
20

1
import requests
2
import json
3

4
url = "https://api.hyperliquid.xyz/info"
5

6
payload = json.dumps({
7
  "type": "referral",
8
  "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
9
})
10
headers = {
11
  'Content-Type': 'application/json'
12
}
13

14
response = requests.request("POST", url, headers=headers, data=payload)
15

16
print(response.text)
17

1
import requests
2
import json
3

4
url = "https://api.hyperliquid.xyz/info"
5

6
payload = json.dumps({
7
  "type": "referral",
8
  "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
9
})
10
headers = {
11
  'Content-Type': 'application/json'
12
}
13

14
response = requests.request("POST", url, headers=headers, data=payload)
15

16
print(response.text)
17

1
require "uri"
2
require "json"
3
require "net/http"
4

5
url = URI("https://api.hyperliquid.xyz/info")
6

7
https = Net::HTTP.new(url.host, url.port)
8
https.use_ssl = true
9

10
request = Net::HTTP::Post.new(url)
11
request["Content-Type"] = "application/json"
12
request.body = JSON.dump({
13
  "type": "referral",
14
  "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
15
})
16

17
response = https.request(request)
18
puts response.read_body
19

1
require "uri"
2
require "json"
3
require "net/http"
4

5
url = URI("https://api.hyperliquid.xyz/info")
6

7
https = Net::HTTP.new(url.host, url.port)
8
https.use_ssl = true
9

10
request = Net::HTTP::Post.new(url)
11
request["Content-Type"] = "application/json"
12
request.body = JSON.dump({
13
  "type": "referral",
14
  "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
15
})
16

17
response = https.request(request)
18
puts response.read_body
19

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free