> ## Documentation Index
> Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt
> Use this file to discover all available pages before exploring further.

# PositioningRecord Schema

> One listed perp over the trailing window. Includes generated fields, route metadata, response shapes, and implementation-safe 0xArchive contract details.

Source OpenAPI: 0xArchive API 1.13.0; 242 paths; 243 component schemas.

One listed perp over the trailing window.

## Required Fields

| Field | Type | Description |
| - | - | - |
| `buy_usd` | number:double | Taker buy notional in the window, USD to the cent. |
| `liq_long_count` | integer:int64 | Long liquidations in the window. |
| `liq_long_usd` | number:double | Notional of long positions liquidated in the window, USD to the cent. |
| `liq_short_count` | integer:int64 | Short liquidations in the window. |
| `liq_short_usd` | number:double | Notional of short positions liquidated in the window, USD to the cent. |
| `mark_end` | number:double | Mark price at the window's last 5-minute reading. |
| `mark_start` | number:double | Mark price at the 5-minute reading before the window. |
| `oi_buckets` | integer | Number of 5-minute open interest readings inside the window. |
| `oi_end` | number:double | Open interest in contracts at the window's last 5-minute reading. |
| `oi_start` | number:double | Open interest in contracts at the 5-minute reading before the window. |
| `sell_usd` | number:double | Taker sell notional in the window, USD to the cent. |
| `symbol` | string | The market's symbol. |
| `typical_flow` | number:double | Median absolute taker imbalance, (buy - sell) / (buy + sell), over the same windows. |
| `typical_oi` | number:double | Median absolute relative change of open interest over the same windows. |
| `typical_price` | number:double | Median absolute relative change of the mark over every window of this length in the last 2,000 five-minute buckets. |
| `typical_windows` | integer | Windows counted for the `typical_*` figures. |
| `window` | string | The requested window. |
| `window_end` | string:date-time | End of the window, exclusive: the 5-minute close the cross-section is as of. |
| `window_end_ms` | integer:int64 | `window_end` as Unix milliseconds. |
| `window_start` | string:date-time | Start of the window, inclusive. |
| `window_start_ms` | integer:int64 | `window_start` as Unix milliseconds. |

## JSON Schema

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "PositioningRecord",
  "description": "One listed perp over the trailing window.",
  "type": "object",
  "required": [
    "buy_usd",
    "liq_long_count",
    "liq_long_usd",
    "liq_short_count",
    "liq_short_usd",
    "mark_end",
    "mark_start",
    "oi_buckets",
    "oi_end",
    "oi_start",
    "sell_usd",
    "symbol",
    "typical_flow",
    "typical_oi",
    "typical_price",
    "typical_windows",
    "window",
    "window_end",
    "window_end_ms",
    "window_start",
    "window_start_ms"
  ],
  "properties": {
    "buy_usd": {
      "description": "Taker buy notional in the window, USD to the cent. 0 means none.",
      "type": "number",
      "format": "double",
      "example": 426153898.11
    },
    "liq_long_count": {
      "description": "Long liquidations in the window.",
      "type": "integer",
      "format": "int64",
      "example": 35
    },
    "liq_long_usd": {
      "description": "Notional of long positions liquidated in the window, USD to the cent.",
      "type": "number",
      "format": "double",
      "example": 132411.14
    },
    "liq_short_count": {
      "description": "Short liquidations in the window.",
      "type": "integer",
      "format": "int64",
      "example": 1
    },
    "liq_short_usd": {
      "description": "Notional of short positions liquidated in the window, USD to the cent.",
      "type": "number",
      "format": "double",
      "example": 5186.43
    },
    "mark_end": {
      "description": "Mark price at the window's last 5-minute reading. Null when that bucket has no reading.",
      "type": "number",
      "format": "double",
      "nullable": true,
      "example": 80010
    },
    "mark_start": {
      "description": "Mark price at the 5-minute reading before the window. Null when that bucket has no reading.",
      "type": "number",
      "format": "double",
      "nullable": true,
      "example": 80139
    },
    "oi_buckets": {
      "description": "Number of 5-minute open interest readings inside the window.",
      "type": "integer",
      "example": 48
    },
    "oi_end": {
      "description": "Open interest in contracts at the window's last 5-minute reading. Null when that bucket has no reading.",
      "type": "number",
      "format": "double",
      "nullable": true,
      "example": 39592.93574
    },
    "oi_start": {
      "description": "Open interest in contracts at the 5-minute reading before the window. Null when that bucket has no reading, never 0.",
      "type": "number",
      "format": "double",
      "nullable": true,
      "example": 41558.2733
    },
    "sell_usd": {
      "description": "Taker sell notional in the window, USD to the cent. 0 means none.",
      "type": "number",
      "format": "double",
      "example": 452128639.73
    },
    "symbol": {
      "description": "The market's symbol.",
      "type": "string",
      "example": "BTC"
    },
    "typical_flow": {
      "description": "Median absolute taker imbalance, (buy - sell) / (buy + sell), over the same windows. Null under 288 counted windows.",
      "type": "number",
      "format": "double",
      "nullable": true,
      "example": 0.10512875847481765
    },
    "typical_oi": {
      "description": "Median absolute relative change of open interest over the same windows. Null under 288 counted windows.",
      "type": "number",
      "format": "double",
      "nullable": true,
      "example": 0.010328192376292733
    },
    "typical_price": {
      "description": "Median absolute relative change of the mark over every window of this length in the last 2,000 five-minute buckets. Null under 288 counted windows.",
      "type": "number",
      "format": "double",
      "nullable": true,
      "example": 0.003597216644913026
    },
    "typical_windows": {
      "description": "Windows counted for the `typical_*` figures.",
      "type": "integer",
      "example": 1952
    },
    "window": {
      "description": "The requested window.",
      "type": "string",
      "enum": [
        "1h",
        "4h",
        "24h"
      ],
      "example": "4h"
    },
    "window_end": {
      "description": "End of the window, exclusive: the 5-minute close the cross-section is as of. Equal to `meta.as_of`.",
      "type": "string",
      "format": "date-time",
      "example": "2026-11-04T20:00:00.000Z"
    },
    "window_end_ms": {
      "description": "`window_end` as Unix milliseconds.",
      "type": "integer",
      "format": "int64",
      "example": 1793822400000
    },
    "window_start": {
      "description": "Start of the window, inclusive.",
      "type": "string",
      "format": "date-time",
      "example": "2026-11-04T16:00:00.000Z"
    },
    "window_start_ms": {
      "description": "`window_start` as Unix milliseconds.",
      "type": "integer",
      "format": "int64",
      "example": 1793808000000
    }
  }
}
```

## Components using this schema

* [ApiResponsePositioningArray](https://docs.0xarchive.io/schemas/components/api-response-positioning-array.md)

## Referenced By

Use this shared schema with the generated component index and route-specific endpoint pages during implementation.

## Operations using this component transitively

* [`GET /v1/hyperliquid/hip3/positioning`](https://docs.0xarchive.io/schemas/operations/get-hip3-positioning)
* [`GET /v1/hyperliquid/positioning`](https://docs.0xarchive.io/schemas/operations/get-positioning)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.