> ## Documentation Index
> Fetch the complete documentation index at: https://goldrush.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Roadmap

# Hyperliquid API Roadmap

The GoldRush Hyperliquid API ships in phases. Available endpoints are documented under **Info API**; this page covers what's coming.

## Available now

The Info API ships with seventeen types: fifteen wire-compatible drop-ins covering market metadata, user state, user history, vaults, and HYPE staking (including HIP-4 outcome metadata), plus two GoldRush-native batch endpoints.

| Type                              | Description                                                                                                          |
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| **`metaAndAssetCtxs`**            | Perp universe + per-asset live mark price, funding, OI, and day volume.                                              |
| **`spotMetaAndAssetCtxs`**        | Spot universe + per-pair live mark price, mid, prior-day price, and day volume.                                      |
| **`outcomeMeta`**                 | Active HIP-4 outcome universe - integer outcome IDs, names, structured descriptions, and `sideSpecs` (`Yes` / `No`). |
| **`clearinghouseState`**          | Perp account: positions, margin summary, account value, withdrawable.                                                |
| **`spotClearinghouseState`**      | Spot balances per token, total USD value.                                                                            |
| **`frontendOpenOrders`**          | Open orders + trigger metadata (TP/SL, reduceOnly, orderType).                                                       |
| **`subAccounts`**                 | Sub-accounts of a master, each with inlined perp and spot state.                                                     |
| **`userFills`**                   | A user's most recent fills (up to 2,000).                                                                            |
| **`userFillsByTime`**             | User fills bounded by a `**startTime, endTime)` window.                                                              |
| \[`userFunding`\*\*               | Funding payment history with rate, applied size, and USDC delta per event.                                           |
| **`userNonFundingLedgerUpdates`** | Ledger events except funding - deposits, withdrawals, transfers, vault flows, liquidations.                          |
| **`userVaultEquities`**           | Per-vault locked equity with unlock timestamps.                                                                      |
| **`delegatorSummary`**            | Current delegated, undelegated, and pending-withdrawal HYPE totals.                                                  |
| **`delegatorHistory`**            | Delegate, undelegate, deposit, and withdrawal staking events.                                                        |
| **`delegatorRewards`**            | Accrued staking rewards (delegation and validator commission).                                                       |
| **`batchClearinghouseState`**     | Perp account state for 1 to 50 wallets in one request. **GoldRush-native**, no upstream equivalent.                  |
| **`batchSpotClearinghouseState`** | Spot balances for 1 to 50 wallets in one request. **GoldRush-native**, no upstream equivalent.                       |

Real-time streaming, Pipeline API delivery to warehouses, and full HyperEVM coverage are also live today - see the **Hyperliquid API Overview**.

***

## Next: remaining `/info` types

We're filling in the rest of the most-used types on the public Hyperliquid `/info` surface. Backed by data we already ingest in real time.

| Category                | Types                                                | Notes                                                  |
| ----------------------- | ---------------------------------------------------- | ------------------------------------------------------ |
| **Meta**                | `meta`, `spotMeta`                                   | Perp and spot universe metadata without live contexts. |
| **Prices**              | `allMids`                                            | All-asset mark prices.                                 |
| **Orderbook**           | `l2Book`                                             | Sub-150 ms p50 target.                                 |
| **Trades**              | `recentTrades`, `candleSnapshot`                     | Backed by the same fills we already stream.            |
| **User orders & fills** | `openOrders`, `historicalOrders`, `orderStatus`      | No 10,000-row cap - full history.                      |
| **User ledger**         | `fundingHistory`                                     | Funding rate history per asset.                        |
| **Misc**                | `userFees`, `userRateLimit`, `referral`, `portfolio` | Coming soon.                                           |

Until a type is implemented natively, requests for it return `{"error":"unsupported_type","type":""}`. Email us at **[support@covalenthq.com](mailto:support@covalenthq.com)** to prioritize a specific type.

***

## Then: Power-user endpoints

Capabilities that go beyond the public `/info` surface, addressable from the same `POST /info` body.

| Type                   | What it adds                                                                                                                                               |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `builderFills`         | Fills attributed to a specific builder code address.                                                                                                       |
| `builderLiquidations`  | Liquidations attributed to a specific builder.                                                                                                             |
| `liquidationFills`     | Market-wide liquidation feed, paged.                                                                                                                       |
| `webData2` (composite) | One call returns `clearinghouseState` + `openOrders` + `meta` + `assetCtxs` + recent fills. Saves 4–5 round trips for dashboards.                          |
| `perpDexs`             | List of all HIP-3 and HIP-4 builder-deployed perp DEXes. First-class HIP-3 and HIP-4 coverage across `meta` and `metaAndAssetCtxs` when `dex` is provided. |

### Historical depth

* Extended retention on `hl_trades` and `hl_fills`.
* Bulk archive export - `GET /archive/{type}.parquet?from=…&to=…` returns a presigned URL for backfill into your warehouse.

### Ergonomics

* `Accept-Encoding: zstd` for smaller payloads.
* Optional `?fields=` parameter for response field projection.

***

## Best-in-class differentiators

Capabilities no other Hyperliquid data provider offers today.

### Time-travel info (`asOfMs`)

Every user-state and market type accepts an optional `asOfMs` parameter. Replay any wallet's state at any past timestamp using the same `/info` request body.

**Use cases:** historical PnL audits, snapshot for tax reports, "what did this account look like before liquidation," backtest harnesses.

### Cross-venue unified perpetuals

New types `unifiedMeta` and `unifiedClearinghouseState` merge Hyperliquid + Drift + dYdX + Aevo positions for a wallet into one response.

**Use cases:** multi-venue portfolio dashboards, cross-margin monitoring, unified risk engines.

### Streaming mirror via SSE and gRPC

Mirror every WebSocket subscription as:

* **Server-Sent Events** (`GET /info/stream?type=…`) - works through corporate proxies and serverless edges where WS is blocked.
* **gRPC with Protobuf** - 3–5× lower bandwidth, hard typing for institutional clients.

### Smart-money and ML-derived analytics

Types not derivable from raw Hyperliquid data:

| Type                 | Description                                                       |
| -------------------- | ----------------------------------------------------------------- |
| `whaleFlow`          | Net 1h/24h delta for top-N PnL wallets per coin.                  |
| `predictedFunding`   | Funding forecast extending Hyperliquid's next-epoch-only horizon. |
| `liquidationHeatmap` | Clustered liquidation prices by coin.                             |
| `walletScore`        | Risk, PnL, and Sharpe per wallet.                                 |

***

## Have a request?

Need a type or capability that isn't on this list? **Email us** - we prioritize against real customer use cases.