Get clearinghouse state for a user

POST

https://hype.nownodes.io/info

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a user’s clearinghouse state, which includes margin summary (account value, total notional, margin used), cross‑margin information, maintenance margin used, withdrawable funds, and a list of open perpetual positions (one‑way positions).

Body

application/json

typestringrequired

Request type, must be "clearinghouseState"

userstringrequired

Ethereum address (hex)

Response

200OK

Successful response

Get clearinghouse state for a user

curl -X POST 'https://hype.nownodes.io/info' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "clearinghouseState",
    "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
  }'

const response = await fetch('https://hype.nownodes.io/info', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "type": "clearinghouseState",
      "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://hype.nownodes.io/info')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "type": "clearinghouseState",
    "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "type": "clearinghouseState",
  "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
}

response = requests.post('https://hype.nownodes.io/info', json=payload)
data = response.json()

const response = await fetch('https://hype.nownodes.io/info', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "type": "clearinghouseState",
      "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
    }),
});

const data = await response.json();

const endpoint = "https://hype.nownodes.io/info";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "type": "clearinghouseState",
    "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
  });
console.log(result);

const response = await fetch('https://hype.nownodes.io/info', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "type": "clearinghouseState",
      "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
    }),
});

const data = await response.json();

import requests

payload = {
  "type": "clearinghouseState",
  "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
}

response = requests.post('https://hype.nownodes.io/info', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://hype.nownodes.io/info')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "type": "clearinghouseState",
    "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{
  "type": "clearinghouseState",
  "user": "0x31ca8395cf837de08b24da3f660e77761dfb974b"
}

200

{
  "marginSummary": {
    "accountValue": "114084192.2652609944",
    "totalNtlPos": "17631813.6058540009",
    "totalRawUsd": "119249018.1330830008",
    "totalMarginUsed": "881590.680236"
  },
  "crossMarginSummary": {
    "accountValue": "114084192.2652609944",
    "totalNtlPos": "17631813.6058540009",
    "totalRawUsd": "119249018.1330830008",
    "totalMarginUsed": "881590.680236"
  },
  "crossMaintenanceMarginUsed": "176318.135981",
  "withdrawable": "112321010.9047169983",
  "assetPositions": [
    {
      "type": "oneWay",
      "position": {
        "coin": "BTC",
        "szi": "-38.89109",
        "leverage": {
          "type": "cross",
          "value": 20
        },
        "entryPx": "80010.3",
        "positionValue": "3143527.9136100002",
        "unrealizedPnl": "-31838.266546",
        "returnOnEquity": "-0.2046365169",
        "liquidationPx": "2980723.896114422",
        "marginUsed": "157176.39568",
        "maxLeverage": 50,
        "cumFunding": {
          "allTime": "170845.304582",
          "sinceOpen": "-17119.352039",
          "sinceChange": "0.0"
        }
      }
    },
    {
      "type": "oneWay",
      "position": {
        "coin": "ETH",
        "szi": "-924.6679",
        "leverage": {
          "type": "cross",
          "value": 20
        },
        "entryPx": "2326.53",
        "positionValue": "2115270.28804",
        "unrealizedPnl": "36004.429609",
        "returnOnEquity": "0.33472647",
        "liquidationPx": "124255.7935485447",
        "marginUsed": "105763.514402",
        "maxLeverage": 50,
        "cumFunding": {
          "allTime": "170219.631965",
          "sinceOpen": "-9589.750867",
          "sinceChange": "0.0"
        }
      }
    }
  ],
  "time": 1778589425367
}

Documentation

How to migrate to NOWNodes

Get clearinghouse state for a user

Authorizations

Body

Response