batchClearinghouseStates 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...

users

array

REQUIRED

Loading...

dex

string

Loading...

Returns

array

array

Loading...

assetPositions

array

Loading...

type

string

Loading...

position

object

Loading...

coin

string

Loading...

szi

string

Loading...

entryPx

string

Loading...

positionValue

string

Loading...

unrealizedPnl

string

Loading...

returnOnEquity

string

Loading...

marginUsed

string

Loading...

liquidationPx

string

Loading...

maxLeverage

integer

Loading...

leverage

object

Loading...

type

string

Loading...

value

integer

Loading...

rawUsd

string

Loading...

cumFunding

object

Loading...

allTime

string

Loading...

sinceOpen

string

Loading...

sinceChange

string

Loading...

crossMaintenanceMarginUsed

string

Loading...

crossMarginSummary

object

Loading...

accountValue

string

Loading...

totalMarginUsed

string

Loading...

totalNtlPos

string

Loading...

totalRawUsd

string

Loading...

marginSummary

object

Loading...

accountValue

string

Loading...

totalMarginUsed

string

Loading...

totalNtlPos

string

Loading...

totalRawUsd

string

Loading...

withdrawable

string

Loading...

time

integer

Loading...

Request

1
curl https://api.hyperliquid.xyz/info \
2
  -X POST \
3
  -H "Content-Type: application/json" \
4
  --data '{"type":"batchClearinghouseStates","users":["0x31ca8395cf837de08b24da3f660e77761dfb974b","0x0d1d9635d0640821d15e323ac8adecca1427453c"]}'
5

1
curl https://api.hyperliquid.xyz/info \
2
  -X POST \
3
  -H "Content-Type: application/json" \
4
  --data '{"type":"batchClearinghouseStates","users":["0x31ca8395cf837de08b24da3f660e77761dfb974b","0x0d1d9635d0640821d15e323ac8adecca1427453c"]}'
5

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

4
var raw = JSON.stringify({
5
  "type": "batchClearinghouseStates",
6
  "users": ["0x31ca8395cf837de08b24da3f660e77761dfb974b", "0x0d1d9635d0640821d15e323ac8adecca1427453c"]
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": "batchClearinghouseStates",
6
  "users": ["0x31ca8395cf837de08b24da3f660e77761dfb974b", "0x0d1d9635d0640821d15e323ac8adecca1427453c"]
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": "batchClearinghouseStates",
8
  "users": ["0x31ca8395cf837de08b24da3f660e77761dfb974b", "0x0d1d9635d0640821d15e323ac8adecca1427453c"]
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": "batchClearinghouseStates",
8
  "users": ["0x31ca8395cf837de08b24da3f660e77761dfb974b", "0x0d1d9635d0640821d15e323ac8adecca1427453c"]
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": "batchClearinghouseStates",
14
  "users": ["0x31ca8395cf837de08b24da3f660e77761dfb974b", "0x0d1d9635d0640821d15e323ac8adecca1427453c"]
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": "batchClearinghouseStates",
14
  "users": ["0x31ca8395cf837de08b24da3f660e77761dfb974b", "0x0d1d9635d0640821d15e323ac8adecca1427453c"]
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