DocsInfo Endpoint
POST/v1/exchanges/hyperliquid/info

Info Endpoint

Get market data, prices, order books, and account information. This endpoint is 100% compatible with Hyperliquid's /info endpoint.

Base URL

https://api.paperx.co/v1/exchanges/hyperliquid/info

Request Format

All requests are POST with a JSON body containing a type field:

{
  "type": "requestType",
  // ... additional parameters
}

Available Request Types

allMids

Get mid prices for all trading pairs

Request

{"type": "allMids"}

Response

{
  "BTC": "97234.5",
  "ETH": "3456.78",
  "SOL": "234.56",
  // ... 221+ pairs
}

meta

Get exchange metadata and available assets

Request

{"type": "meta"}

Response

{
  "universe": [
    {
      "name": "BTC",
      "szDecimals": 5,
      "maxLeverage": 50,
      "onlyIsolated": false
    },
    // ... more assets
  ]
}

l2Book

Get order book depth for a specific coin

Request

{
  "type": "l2Book",
  "coin": "BTC"
}

Response

{
  "coin": "BTC",
  "levels": [
    [
      {"px": "97234.0", "sz": "1.5", "n": 3},  // bids
      {"px": "97233.5", "sz": "2.1", "n": 5}
    ],
    [
      {"px": "97235.0", "sz": "0.8", "n": 2},  // asks
      {"px": "97235.5", "sz": "1.2", "n": 4}
    ]
  ],
  "time": 1700000000000
}

clearinghouseState

Get your account state, positions, and margin info

Request

{"type": "clearinghouseState"}

Response

{
  "marginSummary": {
    "accountValue": "10000.00",
    "totalMarginUsed": "500.00",
    "totalNtlPos": "5000.00",
    "totalRawUsd": "10000.00"
  },
  "crossMarginSummary": {
    "accountValue": "10000.00",
    "totalMarginUsed": "500.00"
  },
  "withdrawable": "9500.00",
  "assetPositions": [
    {
      "position": {
        "coin": "BTC",
        "szi": "0.05",
        "entryPx": "97000.00",
        "positionValue": "4850.00",
        "unrealizedPnl": "12.50",
        "leverage": {
          "type": "cross",
          "value": 10
        }
      }
    }
  ]
}

openOrders

Get all open orders

Request

{"type": "openOrders"}

Response

[
  {
    "coin": "BTC",
    "oid": 12345,
    "side": "B",
    "limitPx": "96000.00",
    "sz": "0.1",
    "origSz": "0.1",
    "timestamp": 1700000000000,
    "orderType": "Limit"
  }
]

userFills

Get trade history (fills)

Request

{"type": "userFills"}

Response

[
  {
    "coin": "BTC",
    "px": "97234.50",
    "sz": "0.05",
    "side": "B",
    "time": 1700000000000,
    "fee": "2.43",
    "oid": 12345,
    "tid": 67890
  }
]

candles

Get historical candlestick data

Request

{
  "type": "candles",
  "coin": "BTC",
  "interval": "1h",
  "startTime": 1699900000000,
  "endTime": 1700000000000
}

Parameters

ParameterTypeDescription
coinstringTrading pair (e.g., "BTC")
intervalstring1m, 5m, 15m, 1h, 4h, 1d
startTimenumberUnix timestamp (ms)
endTimenumberUnix timestamp (ms)

Response

[
  {
    "t": 1699900000000,
    "o": "97000.00",
    "h": "97500.00",
    "l": "96800.00",
    "c": "97234.50",
    "v": "1234.56"
  }
]

orderStatus

Get status of a specific order

Request

{
  "type": "orderStatus",
  "oid": "12345678"
}

Response

{
  "order": {
    "coin": "BTC",
    "oid": "12345678",
    "side": "B",
    "limitPx": "97000.00",
    "sz": "0.1",
    "status": "open",
    "filledSz": "0",
    "timestamp": 1700000000000
  }
}

historicalOrders

Get order history (filled, canceled, etc.)

Request

{"type": "historicalOrders"}

userFillsByTime

Get fills within a time range

Request

{
  "type": "userFillsByTime",
  "startTime": 1699900000000,
  "endTime": 1700000000000
}

userRateLimit

Get current rate limit status

Request

{"type": "userRateLimit"}

Response

{
  "cumVlm": "0",
  "nRequestsUsed": 45,
  "nRequestsCap": 1200,
  "rateLimitResetTime": 1700000060000
}

spotMeta

Get spot market metadata (proxied from Hyperliquid)

Request

{"type": "spotMeta"}

Next: Exchange Endpoint

Learn how to place orders, cancel orders, and manage positions.

Exchange Endpoint Reference