HIP-3 Builder Perps - Positions

Get all HIP-3 positions

Every open position across all markets at one committed hourly snapshot (default: the latest), for bulk loading. Each row carries snapshot_ts. Billed at 1 credit per 1,000 rows returned, minimum 1 credit per request.

get/v1/hyperliquid/hip3/positions

Request

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

Query parameters

hourinteger

Committed hourly snapshot to read, as an exact UTC hour in Unix milliseconds. Defaults to the latest committed hour.

limitinteger

Maximum rows per page (default 1000; max 2000 as JSON, 50,000 as Arrow).

cursorstring

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

format'json' | 'arrow'

arrow returns an Apache Arrow IPC stream (application/vnd.apache.arrow.stream) with up to 50,000 rows per page and the page metadata in the x-count, x-next-cursor, and x-schema-version: positions.v1 headers, where Arrow output is enabled for this route; otherwise the response is JSON. Sending Accept: application/vnd.apache.arrow.stream has the same effect.

Response

Get all HIP-3 positions

successboolean required

Example response

{
  "success": true,
  "data": [
    {
      "user_address": "0x31ca8395cf837de08b24da3f660e77761dfb974b",
      "account_index": "513030",
      "account_kind": "user",
      "symbol": "BTC",
      "coin": "BTC",
      "dex": "xyz",
      "size": "12.5",
      "side": "long",
      "entry_price": "64210.5",
      "mark_price": "65020.1",
      "position_value": "812751.25",
      "unrealized_pnl": "10120.2",
      "leverage_type": "cross",
      "liquidation_price": "51000",
      "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.