Perp order book

Level-2 order book for one perpetual: best bid/ask, mid, spread (absolute and bps), up to 20 levels per side with size and order count, cumulative depth in coins and USD on each side, and the bid/ask imbalance within the requested depth. Send POST /api/perp-orderbook with the required field coin and pay $0.002 per call over x402 or MPP (there is no free tier). It returns a JSON object with source, coin, time, bestBid, bestAsk and 9 more.

Hyperliquid public data, no key.

Category: Crypto & onchain data · Tags: crypto derivatives perpetuals orderbook depth spread hyperliquid

TRY IN PLAYGROUND →

Parameters

Example request

curl -i -X POST https://agent402.tools/api/perp-orderbook \
  -H "Content-Type: application/json" \
  -d '{"coin":"BTC","depth":5}'

Without payment this returns HTTP 402 Payment Required with the exact price for perp-orderbook; any x402 v2 or MPP client pays it and retries.

Example response

{
  "source": "hyperliquid",
  "coin": "BTC",
  "time": "2026-08-22T12:00:00.000Z",
  "bestBid": 77279,
  "bestAsk": 77280,
  "mid": 77279.5,
  "spread": 1,
  "spreadBps": 0.129,
  "bids": [
    {
      "px": 77279,
      "sz": 3.13,
      "n": 10
    }
  ],
  "asks": [
    {
      "px": 77280,
      "sz": 1.2,
      "n": 4
    }
  ],
  "bidDepth": {
    "levels": 5,
    "size": 6.1,
    "notionalUsd": 471000
  },
  "askDepth": {
    "levels": 5,
    "size": 4.2,
    "notionalUsd": 324000
  },
  "imbalance": 0.185,
  "fetchedAt": "2026-08-22T12:00:00.000Z"
}

From an MCP client

catalog.call {
  "slug": "perp-orderbook",
  "params": {
    "coin": "BTC",
    "depth": 5
  }
}

The hosted connector at https://agent402.tools/mcp needs a payment for perp-orderbook; the stdio package pays it from a wallet or from AGENT402_CREDITS_KEY. Local install: npx -y agent402-mcp.

Errors and behavior

• coin is required. An input the tool rejects returns an HTTP 4xx whose body carries error, tool, expected, required and example, so the caller can correct it.
• A paid call that ends in any status of 400 or above is not charged over x402, MPP or a prepaid credits key: settlement is cancelled when the tool fails. The exception is a Tempo push credential, a transfer the buyer sent before the call: it settles before the tool runs, so if the tool then fails the payment is recorded as a refund owed to the paying wallet.
• Wallet-only: this tool reaches the network or stored state, so it has no proof-of-work tier. A prepaid card-credits key issued earlier (Authorization: Bearer a402_...) also pays it.
• A GET or HEAD to /api/perp-orderbook returns the same 402 quote, so the price can be read without a body.
• An Idempotency-Key header makes a retried paid call replay the first 200 instead of charging again (an answer larger than 1 MB is not replayed).

Paid call (JavaScript agent)

import { wrapFetchWithPayment } from "@x402/fetch";
import { x402Client } from "@x402/core/client";
import { registerExactEvmScheme } from "@x402/evm/exact/client";
import { privateKeyToAccount } from "viem/accounts";

const client = new x402Client();
client.setSpendControls?.(false); // keep your own spending ceiling in code
registerExactEvmScheme(client, { signer: privateKeyToAccount(KEY) });
const payFetch = wrapFetchWithPayment(fetch, client);

const res = await payFetch("https://agent402.tools/api/perp-orderbook", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "coin": "BTC",
    "depth": 5
  }),
});

Related tools