Hyperliquid - Positions

Get Hyperliquid 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/positions/{symbol}/summary

Request

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

Path parameters

symbolstring required
Example:BTC

Hyperliquid perpetual symbol (e.g. BTC).

Query parameters

startinteger

Inclusive start in Unix milliseconds. Defaults to 24 hours before end.

endinteger

Exclusive end in Unix milliseconds. Defaults to now.

limitinteger

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

cursorstring

Cursor from the previous response meta.next_cursor. Keep every other parameter unchanged.

Response

Get Hyperliquid 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"
    }
  }
}

Changes

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