batchClearinghouseStates

curl --request POST \
  --url 'https://api.uniblock.dev/uni/v1/hyperliquid/info#61' \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "type": "batchClearinghouseStates",
  "users": [
    "0x000000000000000000000000000000000000dEaD",
    "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
  ]
}
'

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'batchClearinghouseStates',
    users: [
      '0x000000000000000000000000000000000000dEaD',
      '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
    ]
  })
};

fetch('https://api.uniblock.dev/uni/v1/hyperliquid/info#61', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.uniblock.dev/uni/v1/hyperliquid/info#61"

payload = {
    "type": "batchClearinghouseStates",
    "users": ["0x000000000000000000000000000000000000dEaD", "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

[
  {
    "user": "0x000000000000000000000000000000000000dEaD",
    "result": {
      "marginSummary": {
        "accountValue": "0.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "0.0",
        "totalMarginUsed": "0.0"
      },
      "crossMarginSummary": {
        "accountValue": "0.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "0.0",
        "totalMarginUsed": "0.0"
      },
      "crossMaintenanceMarginUsed": "0.0",
      "withdrawable": "0.0",
      "assetPositions": [],
      "time": 1783719613736
    },
    "error": null
  },
  {
    "user": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "result": {
      "marginSummary": {
        "accountValue": "2.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "2.0",
        "totalMarginUsed": "0.0"
      },
      "crossMarginSummary": {
        "accountValue": "2.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "2.0",
        "totalMarginUsed": "0.0"
      },
      "crossMaintenanceMarginUsed": "0.0",
      "withdrawable": "2.0",
      "assetPositions": [],
      "time": 1783719613536
    },
    "error": null
  }
]

POST

hyperliquid

info#61

batchClearinghouseStates

curl --request POST \
  --url 'https://api.uniblock.dev/uni/v1/hyperliquid/info#61' \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "type": "batchClearinghouseStates",
  "users": [
    "0x000000000000000000000000000000000000dEaD",
    "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
  ]
}
'

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'batchClearinghouseStates',
    users: [
      '0x000000000000000000000000000000000000dEaD',
      '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
    ]
  })
};

fetch('https://api.uniblock.dev/uni/v1/hyperliquid/info#61', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.uniblock.dev/uni/v1/hyperliquid/info#61"

payload = {
    "type": "batchClearinghouseStates",
    "users": ["0x000000000000000000000000000000000000dEaD", "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

[
  {
    "user": "0x000000000000000000000000000000000000dEaD",
    "result": {
      "marginSummary": {
        "accountValue": "0.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "0.0",
        "totalMarginUsed": "0.0"
      },
      "crossMarginSummary": {
        "accountValue": "0.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "0.0",
        "totalMarginUsed": "0.0"
      },
      "crossMaintenanceMarginUsed": "0.0",
      "withdrawable": "0.0",
      "assetPositions": [],
      "time": 1783719613736
    },
    "error": null
  },
  {
    "user": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "result": {
      "marginSummary": {
        "accountValue": "2.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "2.0",
        "totalMarginUsed": "0.0"
      },
      "crossMarginSummary": {
        "accountValue": "2.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "2.0",
        "totalMarginUsed": "0.0"
      },
      "crossMaintenanceMarginUsed": "0.0",
      "withdrawable": "2.0",
      "assetPositions": [],
      "time": 1783719613536
    },
    "error": null
  }
]

Authorizations

X-API-KEY

string

header

required

API key to access the API (Optional)

Query Parameters

chainId

enum<number>

default:999

required

Unique identifier for a blockchain network.

Available options:

999,

998

Example:

999

provider

enum<string>

Specify which provider to use. The project's provider priority list is used by default if no providers are selected. (Priority list can be managed on Uniblock's dashboard)

Available options:

Alchemy,

Dwellir,

Chainstack,

Covalent

Body

application/json

type

enum<string>

default:batchClearinghouseStates

required

Available options:

batchClearinghouseStates

Example:

"batchClearinghouseStates"

users

string[]

required

The account addresses to read, in order. Uniblock caps the list at 50 users; a longer list is rejected with a 400 before routing.

Required array length: 1 - 50 elements

Example:

[
  "0x000000000000000000000000000000000000dEaD",
  "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
]

Response

200 - application/json

Successful response.

user

string

required

The account address this slot reports on.

Example:

"0x000000000000000000000000000000000000dEaD"

result

object | null

required

This user's perpetuals clearinghouse state, or null if this user failed.

error

string | null

required

Isolated per-user failure message; null when this user succeeded.

Example:

[
  {
    "user": "0x000000000000000000000000000000000000dEaD",
    "result": {
      "marginSummary": {
        "accountValue": "0.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "0.0",
        "totalMarginUsed": "0.0"
      },
      "crossMarginSummary": {
        "accountValue": "0.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "0.0",
        "totalMarginUsed": "0.0"
      },
      "crossMaintenanceMarginUsed": "0.0",
      "withdrawable": "0.0",
      "assetPositions": [],
      "time": 1783719613736
    },
    "error": null
  },
  {
    "user": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "result": {
      "marginSummary": {
        "accountValue": "2.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "2.0",
        "totalMarginUsed": "0.0"
      },
      "crossMarginSummary": {
        "accountValue": "2.0",
        "totalNtlPos": "0.0",
        "totalRawUsd": "2.0",
        "totalMarginUsed": "0.0"
      },
      "crossMaintenanceMarginUsed": "0.0",
      "withdrawable": "2.0",
      "assetPositions": [],
      "time": 1783719613536
    },
    "error": null
  }
]