hl_batchClearinghouseStates JSON-RPC Method

This method efficiently retrieves clearinghouse states for up to 1000 users in a single request. The response includes both successful states and any failed wallet addresses. Use the optional dex parameter with value "ALL_DEXES" to retrieve data across all DEXes (native, xyz, flx, vntl, hyna, km, abcd, cash, para).

Parameters

users

array

REQUIRED

Loading...

dex

string

Loading...

Returns

result

object

Loading...

successful_states

array

Loading...

address

string

Loading...

data

object

Loading...

marginSummary

object

Loading...

accountValue

string

Loading...

totalMarginUsed

string

Loading...

totalNtlPos

string

Loading...

totalRawUsd

string

Loading...

withdrawable

string

Loading...

crossMarginSummary

object

Loading...

assetPositions

array

Loading...

position

object

Loading...

coin

string

Loading...

entryPx

string

Loading...

leverage

object

Loading...

liquidationPx

string

Loading...

marginUsed

string

Loading...

unrealizedPnl

string

Loading...

time

integer

Loading...

failed_wallets

array

Loading...

address

string

Loading...

Request

1
curl https://docs-demo.hype-mainnet.quiknode.pro/evm \
2
  -X POST \
3
  -H "Content-Type: application/json" \
4
  --data '{
5
    "jsonrpc": "2.0",
6
    "method": "hl_batchClearinghouseStates",
7
    "params": {
8
      "users": [
9
        "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
10
        "0x00000000002f3d928030df28cb15b27b56888b9b",
11
        "0x0000000000bdc2fd416def2d8688069052eb0f87",
12
        "0x0000000afcd4de376f2bf0094cdd01712f125995",
13
        "0x0000001d3e9a2e0c9e998ca01a5d54130baca8f3"
14
      ],
15
      "dex": "ALL_DEXES"
16
    },
17
    "id": 1
18
  }'
19

1
curl https://docs-demo.hype-mainnet.quiknode.pro/evm \
2
  -X POST \
3
  -H "Content-Type: application/json" \
4
  --data '{
5
    "jsonrpc": "2.0",
6
    "method": "hl_batchClearinghouseStates",
7
    "params": {
8
      "users": [
9
        "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
10
        "0x00000000002f3d928030df28cb15b27b56888b9b",
11
        "0x0000000000bdc2fd416def2d8688069052eb0f87",
12
        "0x0000000afcd4de376f2bf0094cdd01712f125995",
13
        "0x0000001d3e9a2e0c9e998ca01a5d54130baca8f3"
14
      ],
15
      "dex": "ALL_DEXES"
16
    },
17
    "id": 1
18
  }'
19

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

4
var raw = JSON.stringify({
5
  "jsonrpc": "2.0",
6
  "method": "hl_batchClearinghouseStates",
7
  "params": {
8
    "users": [
9
      "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
10
      "0x00000000002f3d928030df28cb15b27b56888b9b",
11
      "0x0000000000bdc2fd416def2d8688069052eb0f87",
12
      "0x0000000afcd4de376f2bf0094cdd01712f125995",
13
      "0x0000001d3e9a2e0c9e998ca01a5d54130baca8f3"
14
    ],
15
    "dex": "ALL_DEXES"
16
  },
17
  "id": 1
18
});
19

20
var requestOptions = {
21
  method: 'POST',
22
  headers: myHeaders,
23
  body: raw,
24
  redirect: 'follow'
25
};
26

27
fetch("https://docs-demo.hype-mainnet.quiknode.pro/evm", requestOptions)
28
  .then(response => response.text())
29
  .then(result => console.log(result))
30
  .catch(error => console.log('error', error));
31

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

4
var raw = JSON.stringify({
5
  "jsonrpc": "2.0",
6
  "method": "hl_batchClearinghouseStates",
7
  "params": {
8
    "users": [
9
      "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
10
      "0x00000000002f3d928030df28cb15b27b56888b9b",
11
      "0x0000000000bdc2fd416def2d8688069052eb0f87",
12
      "0x0000000afcd4de376f2bf0094cdd01712f125995",
13
      "0x0000001d3e9a2e0c9e998ca01a5d54130baca8f3"
14
    ],
15
    "dex": "ALL_DEXES"
16
  },
17
  "id": 1
18
});
19

20
var requestOptions = {
21
  method: 'POST',
22
  headers: myHeaders,
23
  body: raw,
24
  redirect: 'follow'
25
};
26

27
fetch("https://docs-demo.hype-mainnet.quiknode.pro/evm", requestOptions)
28
  .then(response => response.text())
29
  .then(result => console.log(result))
30
  .catch(error => console.log('error', error));
31

1
import requests
2
import json
3

4
url = "https://docs-demo.hype-mainnet.quiknode.pro/evm"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "hl_batchClearinghouseStates",
9
  "params": {
10
    "users": [
11
      "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
12
      "0x00000000002f3d928030df28cb15b27b56888b9b",
13
      "0x0000000000bdc2fd416def2d8688069052eb0f87",
14
      "0x0000000afcd4de376f2bf0094cdd01712f125995",
15
      "0x0000001d3e9a2e0c9e998ca01a5d54130baca8f3"
16
    ],
17
    "dex": "ALL_DEXES"
18
  },
19
  "id": 1
20
})
21

22
headers = {
23
  'Content-Type': 'application/json'
24
}
25

26
response = requests.request("POST", url, headers=headers, data=payload)
27

28
print(response.text)
29

1
import requests
2
import json
3

4
url = "https://docs-demo.hype-mainnet.quiknode.pro/evm"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "hl_batchClearinghouseStates",
9
  "params": {
10
    "users": [
11
      "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
12
      "0x00000000002f3d928030df28cb15b27b56888b9b",
13
      "0x0000000000bdc2fd416def2d8688069052eb0f87",
14
      "0x0000000afcd4de376f2bf0094cdd01712f125995",
15
      "0x0000001d3e9a2e0c9e998ca01a5d54130baca8f3"
16
    ],
17
    "dex": "ALL_DEXES"
18
  },
19
  "id": 1
20
})
21

22
headers = {
23
  'Content-Type': 'application/json'
24
}
25

26
response = requests.request("POST", url, headers=headers, data=payload)
27

28
print(response.text)
29

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

5
url = URI("https://docs-demo.hype-mainnet.quiknode.pro/evm")
6

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

10
request = Net::HTTP::Post.new(url)
11
request["Content-Type"] = "application/json"
12
request.body = JSON.dump({
13
  "jsonrpc": "2.0",
14
  "method": "hl_batchClearinghouseStates",
15
  "params": {
16
    "users": [
17
      "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
18
      "0x00000000002f3d928030df28cb15b27b56888b9b",
19
      "0x0000000000bdc2fd416def2d8688069052eb0f87",
20
      "0x0000000afcd4de376f2bf0094cdd01712f125995",
21
      "0x0000001d3e9a2e0c9e998ca01a5d54130baca8f3"
22
    ],
23
    "dex": "ALL_DEXES"
24
  },
25
  "id": 1
26
})
27

28
response = http.request(request)
29
puts response.read_body
30

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

5
url = URI("https://docs-demo.hype-mainnet.quiknode.pro/evm")
6

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

10
request = Net::HTTP::Post.new(url)
11
request["Content-Type"] = "application/json"
12
request.body = JSON.dump({
13
  "jsonrpc": "2.0",
14
  "method": "hl_batchClearinghouseStates",
15
  "params": {
16
    "users": [
17
      "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
18
      "0x00000000002f3d928030df28cb15b27b56888b9b",
19
      "0x0000000000bdc2fd416def2d8688069052eb0f87",
20
      "0x0000000afcd4de376f2bf0094cdd01712f125995",
21
      "0x0000001d3e9a2e0c9e998ca01a5d54130baca8f3"
22
    ],
23
    "dex": "ALL_DEXES"
24
  },
25
  "id": 1
26
})
27

28
response = http.request(request)
29
puts response.read_body
30

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free