Diese Seite ist eine Community-Übersetzung und dient nur zur Orientierung; maßgeblich ist die englische Originalversion.
Englisches Original ↗

Info-Endpunkt

Der Info-Endpunkt dient zum Abrufen von Informationen über die Börse und bestimmte Nutzer. Die verschiedenen Anfrage-Bodies führen zu unterschiedlichen, jeweils zugehörigen Schemata der Antwort-Bodies.

Paginierung

Antworten, die einen Zeitraum annehmen, geben nur 500 Elemente bzw. einzelne Datenblöcke zurück. Um größere Zeiträume abzufragen, verwenden Sie den zuletzt zurückgegebenen Zeitstempel als nächstes startTime für die Paginierung.

Perpetuals gegenüber Spot

Die Endpunkte in diesem Abschnitt sowie die WebSocket-Subscriptions funktionieren sowohl für Perpetuals als auch für Spot. Bei Perpetuals ist coin der Name, der in der meta-Antwort zurückgegeben wird. Für Spot sollte coin für PURR PURR/USDC sein und für alle anderen Spot-Token @{index}, z. B. @1, wobei index der Index des Spot-Paares im Feld universe der spotMeta-Antwort ist. Beispielsweise ist der Spot-Index für HYPE im Mainnet @107, da der Token-Index von HYPE 150 beträgt und das Spot-Paar @107 die Token [150, 0] hat. Beachten Sie, dass manche Assets in Nutzeroberflächen neu zugeordnet werden können. Beispielsweise entspricht BTC/USDC auf app.hyperliquid.xyz UBTC/USDC im Mainnet von HyperCore. Der L1-Name auf der Token-Details-Seite kann verwendet werden, um Neuzuordnungen zu erkennen.

Nutzeradresse

Um die Kontodaten eines Master- oder Subkontos abzufragen, müssen Sie die tatsächliche Adresse dieses Kontos angeben. Ein häufiger Fehler ist die Verwendung der Adresse einer Agent-Wallet, was zu einem leeren Ergebnis führt.

Mids für alle Coins abrufen

POST https://api.hyperliquid.xyz/info

Beachten Sie, dass bei leerem Orderbuch der letzte Handelspreis als Fallback verwendet wird

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "allMids"
dex String Name des Perp-DEX. Standardmäßig der leere String, der den ersten Perp-DEX bezeichnet. Spot-Mids sind nur beim ersten Perp-DEX enthalten..

{% tabs %}

{
    "APE": "4.33245",
    "ARB": "1.21695"
}

{% endtab %}

Offene Orders eines Nutzers abrufen

POST https://api.hyperliquid.xyz/info

Offene Orders eines Nutzers anzeigen

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "openOrders"
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.
dex String Name des Perp-DEX. Standardmäßig der leere String, der den ersten Perp-DEX bezeichnet. Offene Spot-Orders sind nur beim ersten Perp-DEX enthalten.

{% tabs %}

[
    {
        "coin": "BTC",
        "limitPx": "29792.0",
        "oid": 91490942,
        "side": "A",
        "sz": "0.0",
        "timestamp": 1681247412573
    }
]

{% endtab %}

Offene Orders eines Nutzers mit zusätzlichen Frontend-Informationen abrufen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "frontendOpenOrders"
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.
dex String Name des Perp-DEX. Standardmäßig der leere String, der den ersten Perp-DEX bezeichnet. Offene Spot-Orders sind nur beim ersten Perp-DEX enthalten.

{% tabs %}

[
    {
        "coin": "BTC",
        "isPositionTpsl": false,
        "isTrigger": false,
        "limitPx": "29792.0",
        "oid": 91490942,
        "orderType": "Limit",
        "origSz": "5.0",
        "reduceOnly": false,
        "side": "A",
        "sz": "5.0",
        "timestamp": 1681247412573,
        "triggerCondition": "N/A",
        "triggerPx": "0.0",
    }
]

{% endtab %}

Fills eines Nutzers abrufen

POST https://api.hyperliquid.xyz/info

Gibt höchstens die 2000 jüngsten Fills zurück

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "userFills"
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.
aggregateByTime bool Bei true werden Teilausführungen zusammengefasst, wenn eine kreuzende Order durch mehrere verschiedene ruhende Orders ausgeführt wird. Ruhende Orders, die durch mehrere kreuzende Orders ausgeführt werden, werden nur aggregiert, wenn sie im selben Block liegen.

{% tabs %}

[
    // Perp fill (first perp dex)
    {
        "closedPnl": "0.0",
        "coin": "AVAX",
        "crossed": false,
        "dir": "Open Long",
        "hash": "0xa166e3fa63c25663024b03f2e0da011a00307e4017465df020210d3d432e7cb8",
        "oid": 90542681,
        "px": "18.435",
        "side": "B",
        "startPosition": "26.86",
        "sz": "93.53",
        "time": 1681222254710,
        "fee": "0.01", // the total fee, inclusive of builderFee below
        "feeToken": "USDC",
        "builderFee": "0.01", // this is optional and will not be present if 0
        "tid": 118906512037719
    },
    // Perp Fill (HIP-3)
    {
        "coin": "xyz:XYZ100", // For HIP-3, the asset has the dex name as a prefix
        "px": "25372.0",
        "sz": "0.0353",
        "side": "B",
        "time": 1767651180109,
        "startPosition": "0.7045",
        "dir": "Open Long",
        "closedPnl": "0.0",
        "hash": "0xa166e3fa63c25663024b03f2e0da011a00307e4017465df020210d3d432e7cb9",
        "oid": 287286372177,
        "crossed": false,
        "fee": "0.026868",
        "tid": 164087028129848,
        "feeToken":" USDC"
    },
    // Spot fill - note the difference in the "coin" format. Refer to 
    // https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
    // for more information on how spot asset IDs work
    {
        "coin": "@107",
        "px": "18.62041381",
        "sz": "43.84",
        "side": "A",
        "time": 1735969713869,
        "startPosition": "10659.65434798",
        "dir": "Sell",
        "closedPnl": "8722.988077",
        "hash": "0x2222138cc516e3fe746c0411dd733f02e60086f43205af2ae37c93f6a792430b",
        "oid": 59071663721,
        "crossed": true,
        "fee": "0.304521",
        "tid": 907359904431134,
        "feeToken": "USDC"
    }
]

{% endtab %}

Fills eines Nutzers nach Zeit abrufen

POST https://api.hyperliquid.xyz/info

Gibt höchstens 2000 Fills pro Antwort zurück, und es sind nur die 10000 jüngsten Fills verfügbar

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String userFillsByTime
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.
startTime* int Startzeit in Millisekunden, inklusive
endTime int Endzeit in Millisekunden, inklusive. Standardmäßig die aktuelle Zeit.
aggregateByTime bool Bei true werden Teilausführungen zusammengefasst, wenn eine kreuzende Order durch mehrere verschiedene ruhende Orders ausgeführt wird. Ruhende Orders, die durch mehrere kreuzende Orders ausgeführt werden, werden nur aggregiert, wenn sie im selben Block liegen.

{% tabs %}

[
    // Perp fill (first perp dex)
    {
        "closedPnl": "0.0",
        "coin": "AVAX",
        "crossed": false,
        "dir": "Open Long",
        "hash": "0xa166e3fa63c25663024b03f2e0da011a00307e4017465df020210d3d432e7cb8",
        "oid": 90542681,
        "px": "18.435",
        "side": "B",
        "startPosition": "26.86",
        "sz": "93.53",
        "time": 1681222254710,
        "fee": "0.01", // the total fee, inclusive of builderFee below
        "feeToken": "USDC",
        "builderFee": "0.01", // this is optional and will not be present if 0
        "tid": 118906512037719
    },
    // Perp Fill (HIP-3)
    {
        "coin": "xyz:XYZ100", // For HIP-3, the asset has the dex name as a prefix
        "px": "25372.0",
        "sz": "0.0353",
        "side": "B",
        "time": 1767651180109,
        "startPosition": "0.7045",
        "dir": "Open Long",
        "closedPnl": "0.0",
        "hash": "0xa166e3fa63c25663024b03f2e0da011a00307e4017465df020210d3d432e7cb9",
        "oid": 287286372177,
        "crossed": false,
        "fee": "0.026868",
        "tid": 164087028129848,
        "feeToken":" USDC"
    },
    // Spot fill - note the difference in the "coin" format. Refer to 
    // https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
    // for more information on how spot asset IDs work
    {
        "coin": "@107",
        "px": "18.62041381",
        "sz": "43.84",
        "side": "A",
        "time": 1735969713869,
        "startPosition": "10659.65434798",
        "dir": "Sell",
        "closedPnl": "8722.988077",
        "hash": "0x2222138cc516e3fe746c0411dd733f02e60086f43205af2ae37c93f6a792430b",
        "oid": 59071663721,
        "crossed": true,
        "fee": "0.304521",
        "tid": 907359904431134,
        "feeToken": "USDC"
    }
]

{% endtab %}

Rate Limits eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Anfrage-Body

Name Type Description
user String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000
type String userRateLimit

{% tabs %}

{
  "cumVlm": "2854574.593578",
  "nRequestsUsed": 2890, // max(0, cumulative_used minus reserved)
  "nRequestsCap": 2864574, 
  "nRequestsSurplus": 0, // max(0, reserved minus cumulative_used)
}

{% endtab %}

Order-Status nach oid oder cloid abfragen

POST https://api.hyperliquid.xyz/info

Anfrage-Body

Name Type Description
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.
type* String "orderStatus"
oid* uint64 or string Entweder u64 für die Order-ID oder 16-Byte-Hex-String für die Client-Order-ID

Die zurückgegebene \-Zeichenkette kann folgende Werte annehmen:

Order status Explanation
open Erfolgreich platziert
filled Ausgeführt
canceled Vom Nutzer storniert
triggered Trigger-Order ausgelöst
rejected Bei der Platzierung abgelehnt
marginCanceled Storniert, weil die Margin für die Ausführung nicht ausreicht
vaultWithdrawalCanceled Nur Vaults. Storniert aufgrund einer Auszahlung eines Nutzers aus dem Vault
openInterestCapCanceled Storniert, weil die Order zu aggressiv war, als das Open Interest die Obergrenze erreicht hatte
selfTradeCanceled Storniert aufgrund der Selbsthandelsprävention
reduceOnlyCanceled Stornierte Reduce-Only-Order, die die Position nicht reduziert
siblingFilledCanceled Nur TP/SL. Storniert, weil die zugehörige Schwester-Order ausgeführt wurde
delistedCanceled Storniert aufgrund eines Delisting des Assets
liquidatedCanceled Storniert aufgrund einer Liquidation
scheduledCancel Nur API. Storniert aufgrund Überschreitung der geplanten Stornierungsfrist (Dead Man's Switch)
tickRejected Abgelehnt aufgrund eines ungültigen Tick-Preises
minTradeNtlRejected Abgelehnt, weil der Order-Nominalwert unter dem Minimum liegt
perpMarginRejected Abgelehnt aufgrund unzureichender Margin
reduceOnlyRejected Abgelehnt aufgrund von Reduce Only
badAloPxRejected Abgelehnt aufgrund eines sofortigen Matches bei Post-Only
iocCancelRejected Abgelehnt, weil IOC nicht matchen konnte
badTriggerPxRejected Abgelehnt aufgrund eines ungültigen TP/SL-Preises
marketOrderNoLiquidityRejected Abgelehnt aufgrund mangelnder Liquidität für die Market-Order
positionIncreaseAtOpenInterestCapRejected Abgelehnt aufgrund der Open-Interest-Obergrenze
positionFlipAtOpenInterestCapRejected Abgelehnt aufgrund der Open-Interest-Obergrenze
tooAggressiveAtOpenInterestCapRejected Abgelehnt, weil der Preis bei der Open-Interest-Obergrenze zu aggressiv ist
openInterestIncreaseRejected Abgelehnt aufgrund der Open-Interest-Obergrenze
insufficientSpotBalanceRejected Abgelehnt aufgrund unzureichenden Spot-Guthabens
oracleRejected Abgelehnt, weil der Preis zu weit vom Oracle entfernt ist
perpMaxPositionRejected Abgelehnt aufgrund Überschreitung des Margin-Tier-Limits beim aktuellen Hebel

{% tabs %}

{
  "status": "order",
  "order": {
    "order": {
      "coin": "ETH",
      "side": "A",
      "limitPx": "2412.7",
      "sz": "0.0",
      "oid": 1,
      "timestamp": 1724361546645,
      "triggerCondition": "N/A",
      "isTrigger": false,
      "triggerPx": "0.0",
      "children": [],
      "isPositionTpsl": false,
      "reduceOnly": true,
      "orderType": "Market",
      "origSz": "0.0076",
      "tif": "FrontendMarket",
      "cloid": null
    },
    "status": <status>,
    "statusTimestamp": 1724361546645
  }
}

{% endtab %}

{% tab title="200: OK Missing Order" %}

{
  "status": "unknownOid"
}

{% endtab %}

L2-Orderbuch-Snapshot

POST https://api.hyperliquid.xyz/info

Gibt höchstens 20 Level pro Seite zurück

Header

Name Value
Content-Type* "application/json"

Body

Name Type Description
type* String "l2Book"
coin* String coin
nSigFigs Number Optionales Feld zur Aggregation von Leveln auf nSigFigs signifikante Stellen. Gültige Werte sind 2, 3, 4, 5 und null, was volle Genauigkeit bedeutet
mantissa Number Optionales Feld zur Aggregation von Leveln. Dieses Feld ist nur erlaubt, wenn nSigFigs 5 ist. Akzeptiert die Werte 1, 2 oder 5.

Antwort

{% tabs %}

{
  "coin": "BTC",
  "time": 1754450974231,
  "levels": [
    [
      {
        "px": "113377.0",
        "sz": "7.6699",
        "n": 17 // number of levels
      },
      {
        "px": "113376.0",
        "sz": "4.13714",
        "n": 8
      },
    ],
    [
      {
        "px": "113397.0",
        "sz": "0.11543",
        "n": 3
      }
    ]
  ]
}

{% endtab %}

Candle-Snapshot

POST https://api.hyperliquid.xyz/info

Es sind nur die 5000 jüngsten Candles verfügbar

Unterstützte Intervalle: "1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "8h", "12h", "1d", "3d", "1w", "1M"

Header

Name Value
Content-Type* "application/json"

Body

Name Type Description
type* String "candleSnapshot"
req* Object

{"coin": \, "interval": "15m", "startTime": \, "endTime": \}
Für HIP-3 müssen Sie den DEX-Namen voranstellen, z. B. "xyz:XYZ100"

Antwort

{% tabs %}

[
  {
    "T": 1681924499999,
    "c": "29258.0",
    "h": "29309.0",
    "i": "15m",
    "l": "29250.0",
    "n": 189,
    "o": "29295.0",
    "s": "BTC",
    "t": 1681923600000,
    "v": "0.98639"
  }
]

{% endtab %}

Builder-Fee-Genehmigung prüfen

POST https://api.hyperliquid.xyz/info

Header

Name Value
Content-Type* "application/json"

Body

Name Type Description
type* String "maxBuilderFee"
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.
builder* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

Antwort

{% tabs %}

1 // maximum fee approved in tenths of a basis point i.e. 1 means 0.001%

{% endtab %}

Historische Orders eines Nutzers abrufen

POST https://api.hyperliquid.xyz/info

Gibt höchstens die 2000 jüngsten historischen Orders zurück

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "historicalOrders"
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

[
  {
    "order": {
      "coin": "ETH",
      "side": "A",
      "limitPx": "2412.7",
      "sz": "0.0",
      "oid": 1,
      "timestamp": 1724361546645,
      "triggerCondition": "N/A",
      "isTrigger": false,
      "triggerPx": "0.0",
      "children": [],
      "isPositionTpsl": false,
      "reduceOnly": true,
      "orderType": "Market",
      "origSz": "0.0076",
      "tif": "FrontendMarket",
      "cloid": null
    },
    "status": "filled" | "open" | "canceled" | "triggered" | "rejected" | "marginCanceled",
    "statusTimestamp": 1724361546645
  }
]

{% endtab %}

TWAP-Slice-Fills eines Nutzers abrufen

POST https://api.hyperliquid.xyz/info

Gibt höchstens die 2000 jüngsten TWAP-Slice-Fills zurück

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "userTwapSliceFills"
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

[
    {
        "fill": {
            "closedPnl": "0.0",
            "coin": "AVAX",
            "crossed": true,
            "dir": "Open Long",
            "hash": "0x0000000000000000000000000000000000000000000000000000000000000000", // TWAP fills have a hash of 0
            "oid": 90542681,
            "px": "18.435",
            "side": "B",
            "startPosition": "26.86",
            "sz": "93.53",
            "time": 1681222254710,
            "fee": "0.01",
            "feeToken": "USDC",
            "tid": 118906512037719
        },
        "twapId": 3156
    }
]

{% endtab %}

Subkonten eines Nutzers abrufen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "subAccounts"
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

[
  {
    "name": "Test",
    "subAccountUser": "0x035605fc2f24d65300227189025e90a0d947f16c",
    "master": "0x8c967e73e6b15087c42a10d344cff4c96d877f1d",
    "clearinghouseState": {
      "marginSummary": {
        "accountValue": "29.78001",
        "totalNtlPos": "0.0",
        "totalRawUsd": "29.78001",
        "totalMarginUsed": "0.0"
      },
      "crossMarginSummary": {
        "accountValue": "29.78001",
        "totalNtlPos": "0.0",
        "totalRawUsd": "29.78001",
        "totalMarginUsed": "0.0"
      },
      "crossMaintenanceMarginUsed": "0.0",
      "withdrawable": "29.78001",
      "assetPositions": [],
      "time": 1733968369395
    },
    "spotState": {
      "balances": [
        {
          "coin": "USDC",
          "token": 0,
          "total": "0.22",
          "hold": "0.0",
          "entryNtl": "0.0"
        }
      ]
    }
  }
]

{% endtab %}

Details eines Vault abrufen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "vaultDetails"
vaultAddress* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.
user String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

{
  "name": "Test",
  "vaultAddress": "0xdfc24b077bc1425ad1dea75bcb6f8158e10df303",
  "leader": "0x677d831aef5328190852e24f13c46cac05f984e7",
  "description": "This community-owned vault provides liquidity to Hyperliquid through multiple market making strategies, performs liquidations, and accrues platform fees.",
  "portfolio": [
    [
      "day",
      {
        "accountValueHistory": [
          [
            1734397526634,
            "329265410.90790099"
          ]
        ],
        "pnlHistory": [
          [
            1734397526634,
            "0.0"
          ],
        ],
        "vlm": "0.0"
      }
    ],
    [
      "week" | "month" | "allTime" | "perpDay" | "perpWeek" | "perpMonth" | "perpAllTime",
      {...}
    ]
  ],
  "apr": 0.36387129259090006,
  "followerState": null,
  "leaderFraction": 0.0007904828725729887,
  "leaderCommission": 0,
  "followers": [
    {
      "user": "0x005844b2ffb2e122cf4244be7dbcb4f84924907c",
      "vaultEquity": "714491.71026243",
      "pnl": "3203.43026143",
      "allTimePnl": "79843.74476743",
      "daysFollowing": 388,
      "vaultEntryTime": 1700926145201,
      "lockupUntil": 1734824439201
    }
  ],
  "maxDistributable": 94856870.164485,
  "maxWithdrawable": 742557.680863,
  "isClosed": false,
  "relationship": {
    "type": "parent",
    "data": {
      "childAddresses": [
        "0x010461c14e146ac35fe42271bdc1134ee31c703a",
        "0x2e3d94f0562703b25c83308a05046ddaf9a8dd14",
        "0x31ca8395cf837de08b24da3f660e77761dfb974b"
      ]
    }
  },
  "allowDeposits": true,
  "alwaysCloseOnWithdraw": false
}  

{% endtab %}

Vault-Einzahlungen eines Nutzers abrufen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "userVaultEquities"
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

[
  {
    "vaultAddress": "0xdfc24b077bc1425ad1dea75bcb6f8158e10df303",
    "equity": "742500.082809",
  }
]

{% endtab %}

Rolle eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "userRole"
user* String Adresse im 42-stelligen Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

{"role":"user"} # "missing", "user", "agent", "vault", or "subAccount"

{% endtab %}

{% tab title="Agent" %}

{"role":"agent", "data": {"user": "0x..."}}

{% endtab %}

{% tab title="Vault" %}

{"role":"vault"}

{% endtab %}

{% tab title="Subaccount" %}

{"role":"subAccount", "data":{"master":"0x..."}}

{% endtab %}

{% tab title="Missing" %}

{"role":"missing"}

{% endtab %}

Portfolio eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "portfolio"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

[
  [
    "day",
    {
      "accountValueHistory": [
        [
          1741886630493,
          "0.0"
        ],
        [
          1741895270493,
          "0.0"
        ],
        ...
      ],
      "pnlHistory": [
        [
          1741886630493,
          "0.0"
        ],
        [
          1741895270493,
          "0.0"
        ],
        ...
      ],
      "vlm": "0.0"
    }
  ],
  ["week", { ... }],
  ["month", { ... }],
  ["allTime", { ... }],
  ["perpDay", { ... }],
  ["perpWeek", { ... }],
  ["perpMonth", { ... }],
  ["perpAllTime", { ... }]
]

{% endtab %}

Referral-Informationen eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "referral"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

{
    "referredBy": {
        "referrer": "0x5ac99df645f3414876c816caa18b2d234024b487",
        "code": "TESTNET"
    },
    "cumVlm": "149428030.6628420055", // USDC Only
    "unclaimedRewards": "11.047361", // USDC Only
    "claimedRewards": "22.743781", // USDC Only
    "builderRewards": "0.027802", // USDC Only
    "tokenToState":[
      0,
      {
         "cumVlm":"149428030.6628420055",
         "unclaimedRewards":"11.047361",
         "claimedRewards":"22.743781",
         "builderRewards":"0.027802"
      }
   ],
    "referrerState": {
        "stage": "ready",
        "data": {
            "code": "TEST",
            "referralStates": [
                {
                    "cumVlm": "960652.017122",
                    "cumRewardedFeesSinceReferred": "196.838825",
                    "cumFeesRewardedToReferrer": "19.683748",
                    "timeJoined": 1679425029416,
                    "user": "0x11af2b93dcb3568b7bf2b6bd6182d260a9495728"
                },
                {
                    "cumVlm": "438278.672653",
                    "cumRewardedFeesSinceReferred": "97.628107",
                    "cumFeesRewardedToReferrer": "9.762562",
                    "timeJoined": 1679423947882,
                    "user": "0x3f69d170055913103a034a418953b8695e4e42fa"
                }
            ]
        }
    },
    "rewardHistory": []
}

{% endtab %}

Beachten Sie, dass rewardHistory für Legacy-Belohnungen gilt. Eingelöste Belohnungen werden jetzt in nonFundingLedgerUpdate zurückgegeben

Gebühren eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "userFees"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

{
  "dailyUserVlm": [
    {
      "date": "2025-05-23",
      "userCross": "0.0",
      "userAdd": "0.0",
      "exchange": "2852367.0770729999"
    },
    ...
  ],
  "feeSchedule": {
    "cross": "0.00045",
    "add": "0.00015",
    "spotCross": "0.0007",
    "spotAdd": "0.0004",
    "tiers": {
      "vip": [
        {
          "ntlCutoff": "5000000.0",
          "cross": "0.0004",
          "add": "0.00012",
          "spotCross": "0.0006",
          "spotAdd": "0.0003"
        },
        ...
      ],
      "mm": [
        {
          "makerFractionCutoff": "0.005",
          "add": "-0.00001"
        },
        ...
      ]
    },
    "referralDiscount": "0.04",
    "stakingDiscountTiers": [
      {
        "bpsOfMaxSupply": "0.0",
        "discount": "0.0"
      },
      {
        "bpsOfMaxSupply": "0.0001",
        "discount": "0.05"
      },
      ...
    ]
  },
  "userCrossRate": "0.000315",
  "userAddRate": "0.000105",
  "userSpotCrossRate": "0.00049",
  "userSpotAddRate": "0.00028",
  "activeReferralDiscount": "0.0",
  "trial": null,
  "feeTrialReward": "0.0",
  "nextTrialAvailableTimestamp": null,
  "stakingLink": {
    "type": "tradingUser",
    "stakingUser": "0x54c049d9c7d3c92c2462bf3d28e083f3d6805061"
  },
  "activeStakingDiscount": {
    "bpsOfMaxSupply": "4.7577998927",
    "discount": "0.3"
  }
}

{% endtab %}

Staking-Delegierungen eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "delegations"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

[
    {
        "validator":"0x5ac99df645f3414876c816caa18b2d234024b487",
        "amount":"12060.16529862",
        "lockedUntilTimestamp":1735466781353
    },
    ...
]

{% endtab %}

Staking-Übersicht eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "delegatorSummary"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

{
    "delegated": "12060.16529862",
    "undelegated": "0.0",
    "totalPendingWithdrawal": "0.0",
    "nPendingWithdrawals": 0
}

{% endtab %}

Staking-Verlauf eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "delegatorHistory"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

[
    {
        "time": 1735380381353,
        "hash": "0x55492465cb523f90815a041a226ba90147008d4b221a24ae8dc35a0dbede4ea4",
        "delta": {
            "delegate": {
                "validator": "0x5ac99df645f3414876c816caa18b2d234024b487",
                "amount": "10000.0",
                "isUndelegate": false
            }
        }
    },
    ...
]

{% endtab %}

Staking-Belohnungen eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "delegatorRewards"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

[
    {
        "time": 1736726400073,
        "source": "delegation",
        "totalAmount": "0.73117184"
    },
    {
        "time": 1736726400073,
        "source": "commission",
        "totalAmount": "130.76445876"
    },
    ...
]

{% endtab %}

HIP-3-DEX-Abstraktionsstatus eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "userDexAbstraction"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

true

{% endtab %}

Abstraktionsstatus eines Nutzers abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "userAbstraction"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

"unifiedAccount" | "portfolioMargin" | "disabled" | "default" | "dexAbstraction"

{% endtab %}

Borrow/Lend-Nutzerstatus abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "borrowLendUserState"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

{
    "tokenToState":[
        [
            0,
            {
                "borrow":{
                    "basis": "0.0",
                    "value": "0.0"
                },
                "supply":{
                    "basis": "44.69295862",
                    "value": "44.69692314"
                }
            }
        ],
        [
            1105,
            {
                "borrow":{
                    "basis": "0.0",
                    "value": "0.0"
                },
                "supply":{
                    "basis": "0.0",
                    "value": "0.0"
                }
            }
        ],
    ],
    "health":"healthy",
    "healthFactor":null
}

{% endtab %}

Borrow/Lend-Reserve-Status abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "borrowLendReserveState"
token* Number Token-Index

{% tabs %}

{
    "borrowYearlyRate": "0.05",
    "supplyYearlyRate": "0.0008245002",
    "balance": "3245939.4732256099",
    "utilization": "0.018322226",
    "oraclePx": "1.0",
    "ltv": "0.0",
    "totalSupplied": "3306509.7335290499",
    "totalBorrowed": "60582.61869494"
}

{% endtab %}

Alle Borrow/Lend-Reserve-States abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "allBorrowLendReserveStates"

{% tabs %}

[
    [
        0,
        {
            "borrowYearlyRate": "0.05",
            "supplyYearlyRate": "0.0008244951",
            "balance": "3245960.0596176102",
            "utilization": "0.0183221137",
            "oraclePx": "1.0",
            "ltv": "0.0",
            "totalSupplied": "3306530.3251102199",
            "totalBorrowed": "60582.62446067"
        }
    ],
    [
        150,
        {
            "borrowYearlyRate": "0.05",
            "supplyYearlyRate": "0.0",
            "balance": "11318.09684696",
            "utilization": "0.0",
            "oraclePx": "23.99",
            "ltv": "0.5",
            "totalSupplied": "11318.09684696",
            "totalBorrowed": "0.0"
        }
    ]
]

{% endtab %}

Genehmigte Builder für Nutzer abfragen

POST https://api.hyperliquid.xyz/info

Header

Name Type Description
Content-Type* String "application/json"

Anfrage-Body

Name Type Description
type* String "approvedBuilders"
user* String Hexadezimalformat; z. B. 0x0000000000000000000000000000000000000000.

{% tabs %}

["0x476fa87b4d3818f437f38f1263bee508d7672d82"]

{% endtab %}

Offizielle Quelle: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint
Quellstand: · Mirror erstellt: · Community-Übersetzung; die englische Fassung ist maßgeblich
Inoffizielle Community-Übersetzung der Hyperliquid-Dokumentation. Inhalte © Hyperliquid; maßgeblich ist die englische Version. Quelle: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint