> ## Documentation Index > Fetch the complete documentation index at: https://docs.ironflow.sh/llms.txt > Use this file to discover all available pages before exploring further. # Hyperliquid HIP-4 outcome markets summary > GET /v1/predictions/summary returns activity on Hyperliquid's HIP-4 outcome markets: notional, fills, wallets, an hourly series and the active markets. ## OpenAPI ````yaml GET /v1/predictions/summary openapi: 3.1.0 info: title: Ironflow API version: 1.0.0 description: > Hyperliquid market data from Ironflow's own nodes: tick-level fills and trades, candles, funding rates, liquidations, mark prices, open interest, markets and wallet analytics over REST, live Server-Sent Events streams and read-only SQL. One schema across native HL perps, HIP-3 builder markets, HIP-4 outcome contracts and HL spot. The same data is a hosted MCP server for AI agents at `https://mcp.ironflow.sh/mcp`, and agents with a USDC wallet on Base can pay per call with x402, no key: the data GET endpoints are also served at `/x402/v1/...` (discovery: `https://api.ironflow.sh/openapi.json` and `https://api.ironflow.sh/.well-known/x402`). **Base URL:** `https://api.ironflow.sh` **Authentication:** Read endpoints work without a key (keyless access) or with a Bearer token in the `Authorization` header. Writes always need a key. ``` Authorization: Bearer if_your_api_key ``` Get a free key at https://ironflow.sh/key. **Access levels:** | Access | Requests per minute | History | Max range per request | |---|---|---|---| | No key | 30 per IP (2,000 a day) | 24 hours | 1 hour | | Free key | 60 | 30 days | 6 hours | | Explorer | 100 | 90 days | 24 hours | | Builder | 1,000 | 1 year | 7 days | | Enterprise | 10,000 | full | unlimited | Without a market filter, high-volume endpoints allow at most 4 hours per request. `/v1/trades` filtered to one perp or spot market allows 24 hours per request without a key and on a free key. A header that is present but malformed returns 401; keyless access applies only when no `Authorization` header is sent. **Data availability:** fills and trades start on 25 May 2025; other datasets start later (funding 2025-09-27, open interest and mark prices 2026-04-29). Bulk history is free to download from https://huggingface.co/ironflow. **Timestamps:** All timestamps are Unix milliseconds (int64). **Pagination:** Paginated endpoints return a `cursor` in `pagination.next_cursor`. Pass it as the `cursor` query parameter to fetch the next page. When `pagination.has_more` is `false`, you have reached the last page. **Notices:** a successful JSON object may start with `notice`, the `X-Ironflow-Notice` header in the body: what was served when it differs from what was asked (a keyless sample, a shortened history, a guessed path) and how to get the rest. **Guessed paths:** a few paths callers guess are answered by the endpoint they mean, with a `notice` and the `X-Ironflow-Canonical` header naming it: `/v1/liquidations/aggregate`, `/v1/summary/liquidations` and similar by `/v1/liquidations/summary`, `/v1/liquidations/buckets` and `heatmap` by `/v1/analytics/liquidation-levels`, and `/v1/liquidations/map/BTC-PERP` by `/v1/liquidations/map?market=BTC-PERP`. A path with trailing `.`, `,`, `;` or `)` (`/v1/query.`, copied from a sentence) is answered by the endpoint without them, with the same method, query and body. OpenAI-style paths (`/v1/models`, `/v1/chat/completions`) answer 404: this is not an LLM API, and agents use the MCP server above. contact: name: Ironflow Support url: https://ironflow.sh servers: - url: https://api.ironflow.sh description: Production security: - bearerAuth: [] - {} tags: - name: Market Data description: Historical tick-level market data stored in ClickHouse. - name: Analytics description: >- Aggregated analytics. Net flows, funding stats and the liquidation map markets work without a key; liquidation levels, the liquidation map and the vault leaderboard return a sample without one; order flow needs a key (a free key works). - name: Cohorts description: Predefined and custom address groups for filtering market data. - name: Alerts description: >- Liquidation alerts that Ironflow posts to your webhook, Discord channel, Slack channel or Telegram chat. - name: Ironbox description: >- Secure, sandboxed environments in Tokyo, next to Hyperliquid, where a trading agent runs with Ironflow's data, analytics, alerts and execution. Any API key, free included. - name: Query description: >- Read-only ClickHouse SQL over curated Hyperliquid tables (hl.*), limited by tier. - name: Billing description: >- Paid plans, paid in USDC on Hyperliquid or with x402 on Base. No card, no account page. - name: System description: Health checks and metadata endpoints. - name: TradingApp description: >- The trading terminal's own endpoints (terminal.ironflow.sh), wallet-session auth. Not part of the public data API; left out of the docs copy. paths: /v1/predictions/summary: get: tags: - Market Data summary: HIP-4 outcome markets summary description: | Activity on Hyperliquid's HIP-4 outcome (prediction) markets over a trailing window: total notional, fills, wallets and active markets, an hourly series with the BTC price beside it, and the active markets with their last price and 24-hour volume. Refreshed every 60 seconds. No key and no rate tier: the limit is per IP. operationId: getPredictionsSummary parameters: - name: window in: query required: false description: Trailing window. An unknown value falls back to `1d`. schema: type: string enum: - 4h - 1d - 1w default: 1d responses: '200': description: Summary of the window. content: application/json: schema: type: object required: - window_hours - notional_total - fills_total - wallets_total - markets_active - hourly - active_markets - computed_at properties: window_hours: type: integer notional_total: type: number description: USD notional over all outcome fills in the window fills_total: type: integer wallets_total: type: integer markets_active: type: integer description: Outcome markets with at least one fill in the window hourly: type: array items: type: object properties: hour: type: string format: date-time notional: type: number fills: type: integer btc: type: number description: BTC-PERP volume-weighted price that hour active_markets: type: array items: type: object properties: market_id: type: integer display_symbol: type: string hl_coin: type: string description: 'Hyperliquid coin, #N' last_price: type: number last_fill_ms: type: integer format: int64 fills_24h: type: integer notional_24h: type: number computed_at: type: integer format: int64 description: Unix seconds example: window_hours: 4 notional_total: 1092868.21 fills_total: 30964 wallets_total: 503 markets_active: 479 hourly: - hour: '2026-11-06T17:00:00Z' notional: 207216.14 fills: 6766 btc: 75646.09 active_markets: - market_id: 214730 display_symbol: English Premier League 2026/2027-Arsenal-Yes hl_coin: '#14730' last_price: 0.69582 last_fill_ms: 1794000132818 fills_24h: 2655 notional_24h: 179426.32 computed_at: 1794000728 security: [] components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Ironflow API key, format `if_xxxx`. Free keys at https://ironflow.sh/key. Optional on read endpoints. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.