---
title: "Get HIP-3 market summary"
method: GET
path: "/v1/hyperliquid/hip3/summary/{symbol}"
tags: ["HIP-3 Builder Perps - Convenience"]
---

# Get HIP-3 market summary

`GET /v1/hyperliquid/hip3/summary/{symbol}`

## Request

- Base URL: `https://api.0xarchive.io`
- URL: `https://api.0xarchive.io/v1/hyperliquid/hip3/summary/{symbol}`
- Auth: API key in header `X-API-Key`

Get a combined market summary including price, mid price, funding, and open interest in a single call.

## Path parameters

- `symbol` string, required

## Response `200`

Market summary for the coin

- ApiResponseCoinSummary: API response wrapping a market summary
  - `success` boolean
  - `data` CoinSummary: Shared market-summary shape. Route families omit unsupported optional fields; consult the operation description for family-specific applicability.
    - `symbol` string, required: Trading pair symbol
    - `coin` string, required: Trading pair symbol (deprecated, use symbol instead)
    - `timestamp` string, date-time, required: Summary timestamp (UTC)
    - `mark_price` string, nullable: Current mark price
    - `oracle_price` string, nullable: Current oracle price
    - `mid_price` string, nullable: Current mid price
    - `funding_rate` string, nullable: Current funding rate
    - `premium` string, nullable: Current premium
    - `open_interest` string, nullable: Current open interest
    - `volume_24h` string, nullable: 24-hour notional volume
    - `liquidation_volume_24h` number, nullable: Total 24h liquidation volume in USD
    - `long_liquidation_volume_24h` number, nullable: Long 24h liquidation volume in USD
    - `short_liquidation_volume_24h` number, nullable: Short 24h liquidation volume in USD
  - `meta` ResponseMeta: Response metadata. Every 2xx JSON response carries `meta.request_id`; list payloads add `count`; cursor-paged routes add `has_more` and, when another page follows, `next_cursor`; per-symbol routes add `symbol` and `venue`. Fields that do not apply to a route are omitted.
    - `count` integer: Number of records returned
    - `has_more` boolean: Cursor-paged routes: whether another page follows. `next_cursor` is present exactly when this is `true`. A final page can be empty when the previous page was exactly full; `has_more` is `false` on it.
    - `next_cursor` string: Opaque cursor for the next page, present exactly when `has_more` is `true`. Pass it back unchanged as `cursor` with the same filters. Do not parse or construct it.
    - `request_id` string, uuid, required: Unique request ID for support
    - `symbol` string: Per-symbol routes: the canonical public symbol the response describes (for example `BTC`, `xyz:TSLA`, `HYPE-USDC`, `#0`).
    - `venue` 'hyperliquid' | 'hip3' | 'hip4' | 'spot' | 'lighter' | 'rh-lighter': Per-symbol routes: the venue the response describes.
    - `coverage_from` string, date-time: Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.
    - `notice` string: Human-readable advisory about the response. Used when the requested window ends before coverage begins for the symbol, and on CVD responses that are one page of several; may carry other advisories in future.
    - `finalized_through` string, date-time: Two-tier datasets (Lighter trades): data at or before this instant is final; later data is preliminary.
    - `requested_end` string, date-time, nullable: The `end` the request asked for, echoed when it was clamped to `finalized_through`.
    - `clamped_to` string, date-time, nullable: The boundary the request's `end` was clamped to, when clamping occurred.
    - `preliminary_row_count` integer, nullable: Number of preliminary rows in this response, on routes that intentionally serve preliminary data (Lighter `/recent`).

## Other responses

- `400`: Invalid request: a parameter, symbol, interval, cursor or time range failed validation. See `error_code`.
- `401`: Authentication required: the API key is missing or invalid.
- `429`: Rate limit, concurrency limit or monthly credits exceeded. See `error_code`.
- `default`: Any other error. The body is an `ErrorResponse`; branch on `error_code`. A 503 (`upstream_unavailable`) carries `Retry-After`.

---

[API](https://skmtc.dev/0xarchive/apis/0xarchive-api-2.md) · [All operations](https://skmtc.dev/0xarchive/apis/0xarchive-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/0xarchive/apis/0xarchive-api-2/revisions/27076f55595f?raw)