hl_portfolioState JSON-RPC Method

This method consolidates data from the clearinghouseState, spotClearinghouseState, and userAbstraction endpoints into a single request, providing complete portfolio information for a user. 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

user

string

REQUIRED

Loading...

dex

string

Loading...

Returns

result

object

Loading...

clearinghouseState

object

Loading...

dexName (when using ALL_DEXES)

object

Loading...

marginSummary

object

Loading...

accountValue

string

Loading...

totalNtlPos

string

Loading...

totalRawUsd

string

Loading...

totalMarginUsed

string

Loading...

crossMarginSummary

object

Loading...

accountValue

string

Loading...

totalNtlPos

string

Loading...

totalRawUsd

string

Loading...

totalMarginUsed

string

Loading...

crossMaintenanceMarginUsed

string

Loading...

withdrawable

string

Loading...

assetPositions

array

Loading...

assetPosition

object

Loading...

type

string

Loading...

position

object

Loading...

coin

string

Loading...

szi

string

Loading...

leverage

object

Loading...

type

string

Loading...

value

integer

Loading...

entryPx

string

Loading...

positionValue

string

Loading...

unrealizedPnl

string

Loading...

returnOnEquity

string

Loading...

liquidationPx

string

Loading...

marginUsed

string

Loading...

maxLeverage

integer

Loading...

cumFunding

object

Loading...

allTime

string

Loading...

sinceOpen

string

Loading...

sinceChange

string

Loading...

time

integer

Loading...

spotClearinghouseState

object

Loading...

balances

array

Loading...

balance

object

Loading...

coin

string

Loading...

token

integer

Loading...

total

string

Loading...

hold

string

Loading...

entryNtl

string

Loading...

tokenToAvailableAfterMaintenance

array

Loading...

tuple

array

Loading...

tokenId

integer

Loading...

availableAmount

string

Loading...

userAbstraction

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_portfolioState",
7
    "params": {
8
      "user": "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
9
      "dex": "ALL_DEXES"
10
    },
11
    "id": 1
12
  }'
13

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_portfolioState",
7
    "params": {
8
      "user": "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
9
      "dex": "ALL_DEXES"
10
    },
11
    "id": 1
12
  }'
13

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_portfolioState",
7
  "params": {
8
    "user": "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
9
    "dex": "ALL_DEXES"
10
  },
11
  "id": 1
12
});
13

14
var requestOptions = {
15
  method: 'POST',
16
  headers: myHeaders,
17
  body: raw,
18
  redirect: 'follow'
19
};
20

21
fetch("https://docs-demo.hype-mainnet.quiknode.pro/evm", requestOptions)
22
  .then(response => response.text())
23
  .then(result => console.log(result))
24
  .catch(error => console.log('error', error));
25

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_portfolioState",
7
  "params": {
8
    "user": "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
9
    "dex": "ALL_DEXES"
10
  },
11
  "id": 1
12
});
13

14
var requestOptions = {
15
  method: 'POST',
16
  headers: myHeaders,
17
  body: raw,
18
  redirect: 'follow'
19
};
20

21
fetch("https://docs-demo.hype-mainnet.quiknode.pro/evm", requestOptions)
22
  .then(response => response.text())
23
  .then(result => console.log(result))
24
  .catch(error => console.log('error', error));
25

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_portfolioState",
9
  "params": {
10
    "user": "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
11
    "dex": "ALL_DEXES"
12
  },
13
  "id": 1
14
})
15

16
headers = {
17
  'Content-Type': 'application/json'
18
}
19

20
response = requests.request("POST", url, headers=headers, data=payload)
21

22
print(response.text)
23

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_portfolioState",
9
  "params": {
10
    "user": "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
11
    "dex": "ALL_DEXES"
12
  },
13
  "id": 1
14
})
15

16
headers = {
17
  'Content-Type': 'application/json'
18
}
19

20
response = requests.request("POST", url, headers=headers, data=payload)
21

22
print(response.text)
23

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_portfolioState",
15
  "params": {
16
    "user": "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
17
    "dex": "ALL_DEXES"
18
  },
19
  "id": 1
20
})
21

22
response = http.request(request)
23
puts response.read_body
24

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_portfolioState",
15
  "params": {
16
    "user": "0x0000000000004f3d8aaf9175fd824cb00ad4bf80",
17
    "dex": "ALL_DEXES"
18
  },
19
  "id": 1
20
})
21

22
response = http.request(request)
23
puts response.read_body
24

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free