Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypernode-docs.polynode.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET /v2/l4book?coin={symbol}
Returns every individual resting order for the specified asset, including the wallet address of each order.

​
Parameters

ParameterTypeRequiredDescription
coinstringYesAsset symbol (e.g., BTC, ETH, SOL, HYPE)

​
Response

{
  "coin": "ETH",
  "height": 958200000,
  "bid_count": 11490,
  "ask_count": 6861,
  "bids": [
    {
      "user": "0x847bd1ef4fede0fe191129894d63044843f4d473",
      "coin": "ETH",
      "side": "B",
      "limitPx": "2384.4",
      "sz": "5.1598",
      "oid": 380856822616,
      "orderType": "Limit",
      "tif": "Alo",
      "timestamp": 1776156995426,
      "reduceOnly": false,
      "isTrigger": false,
      "triggerPx": "0.0",
      "isPositionTpsl": false,
      "origSz": "5.1598",
      "cloid": "0x00000000000000000000019d889a29cd"
    }
  ],
  "asks": [
    {
      "user": "0xcde682fc64f38967b71cfd00803d4ba3d60e49d1",
      "coin": "ETH",
      "side": "A",
      "limitPx": "2385.5",
      "sz": "3.6932",
      "oid": 380856822611,
      "orderType": "Limit",
      "tif": "Alo",
      "timestamp": 1776156995426,
      "reduceOnly": false,
      "isTrigger": false,
      "triggerPx": "0.0",
      "isPositionTpsl": false,
      "origSz": "3.698",
      "cloid": "0x00000000000000000000019d889dc603"
    }
  ]
}

​
Order fields

FieldTypeDescription
userstringWallet address that placed the order
coinstringAsset symbol
sidestring"B" = buy/bid, "A" = sell/ask
limitPxstringOrder price
szstringCurrent size (may differ from origSz if partially filled)
origSzstringOriginal order size
oidnumberOrder ID
orderTypestring"Limit" or trigger type
tifstringTime in force: "Alo", "Gtc", "Ioc"
timestampnumberUnix milliseconds when order was placed
reduceOnlybooleanWhether this is a reduce-only order
isTriggerbooleanWhether this is a trigger/stop order
triggerPxstringTrigger price (if applicable)
isPositionTpslbooleanWhether this is a position TP/SL
cloidstring or nullClient order ID. Null if not set (~60% of orders).
childrenarrayChild TP/SL orders attached to this order. Each child is a full order object with trigger conditions.
triggerConditionstringTrigger condition: "N/A" for regular orders, or a condition like "Price above 74563" for trigger orders.

​
Example

curl -H "x-api-key: YOUR_KEY" \
  "https://hyper.polynode.dev/v2/l4book?coin=BTC"

const resp = await fetch("https://hyper.polynode.dev/v2/l4book?coin=BTC", {
  headers: { "x-api-key": "pn_live_YOUR_KEY" }
});
const book = await resp.json();

console.log(`BTC: ${book.bid_count} bids, ${book.ask_count} asks`);

// Find the largest bid
const biggestBid = book.bids.reduce((max, o) =>
  parseFloat(o.sz) > parseFloat(max.sz) ? o : max
);
console.log(`Largest bid: ${biggestBid.sz} @ ${biggestBid.limitPx} by ${biggestBid.user}`);

​
Nullable fields

Some fields can be null:
  • cloid — null when no client order ID was set (~60% of orders)
  • tif — rarely null, usually "Alo" or "Gtc"
  • builder — null when no builder fee is attached

​
Notes

  • Response size for BTC is ~18MB (~48,000 total orders). Use compression (Accept-Encoding: gzip).
  • Data refreshes every 1 second from our local node.
  • Trigger orders that have not been activated are not included.