HIP-3 Builder Perps - Positions

Get HIP-3 market positions summary

Long and short counts, sizes, values, average entries, and top-10 concentration for one market. Without start and end, one point at the latest live snapshot; with them, one point per committed hour in [start, end), at most 168 hours per page. Billed at 1 credit per 1,000 rows returned, minimum 1 credit per request.

get/v1/hyperliquid/hip3/positions/{symbol}/summary

Request

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

Path parameters

symbolstring required
Example:xyz:TSLA

HIP-3 symbol in dex:COIN form (e.g. xyz:TSLA).

Query parameters

integer

Unix milliseconds.

OR
string date-time

RFC 3339 instant.

Example:1767225600000

Inclusive start. Defaults to 24 hours before end. Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z.

integer

Unix milliseconds.

OR
string date-time

RFC 3339 instant.

Example:1767225600000

Exclusive end. Defaults to now. Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z.

limitinteger

Maximum rows per page (default 100, max 2000).

cursorstring

Opaque pagination cursor: pass meta.next_cursor from the previous page unchanged, with the same filters. Omit it for the first page. Keep every other parameter unchanged.

Response

Get HIP-3 market positions summary

successboolean required

Example response

{
  "success": true,
  "data": [
    {
      "symbol": "BTC",
      "coin": "BTC",
      "dex": "xyz",
      "long_count": 18234,
      "short_count": 15102,
      "long_size": "8123.45",
      "short_size": "8120.1",
      "long_value": "528000000.5",
      "short_value": "527800000.25",
      "long_avg_entry_price": "63120.4",
      "short_avg_entry_price": "66210.9",
      "long_positions_with_entry": 18230,
      "short_positions_with_entry": 15100,
      "long_top10_value_share": "0.412345",
      "short_top10_value_share": "0.385",
      "top10_value_share": "0.301",
      "quality": "complete"
    }
  ],
  "meta": {
    "totals": {
      "symbol": "BTC",
      "coin": "BTC",
      "dex": "xyz",
      "long_count": 18234,
      "short_count": 15102,
      "long_size": "8123.45",
      "short_size": "8120.1",
      "long_value": "528000000.5",
      "short_value": "527800000.25",
      "long_avg_entry_price": "63120.4",
      "short_avg_entry_price": "66210.9",
      "long_positions_with_entry": 18230,
      "short_positions_with_entry": 15100,
      "long_top10_value_share": "0.412345",
      "short_top10_value_share": "0.385",
      "top10_value_share": "0.301",
      "quality": "complete"
    },
    "symbol": "BTC",
    "venue": "hyperliquid"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.