> ## 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.

# TwapRecord Schema

> One TWAP order status event. Includes required fields, field types, schema references, and generated JSON details from the 0xArchive OpenAPI contract.

Source OpenAPI: 0xArchive API 1.8.0; 227 paths; 217 component schemas.

One TWAP order status event.

## Required Fields

| Field | Type | Description |
| - | - | - |
| `block_number` | integer:int64 | Hyperliquid block number. |
| `block_time` | string:date-time | Time of the block that carried the event (RFC 3339, UTC). |
| `coin` | string | Market symbol. |
| `executed_notional` | number | Notional filled so far, in quote units. |
| `executed_size` | number | Size filled so far, in base units. |
| `minutes` | integer | TWAP duration in minutes. |
| `randomize` | boolean | True when slice timing is randomized. |
| `reduce_only` | boolean | True for a reduce-only TWAP. |
| `side` | string | `B` (buy) or `A` (sell). |
| `size` | number | Total TWAP size, in base units. |
| `started_at` | string:date-time | When the TWAP started (RFC 3339, UTC). |
| `status` | string | `activated`, `waitingForTrigger`, `finished`, `terminated`, `stopped`, or `error`. |
| `timestamp` | string:date-time | When the status event happened (RFC 3339, UTC). |
| `twap_id` | integer:int64 | TWAP order ID. |
| `user_address` | string | Wallet that placed the TWAP, lowercase. |

## JSON Schema

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TwapRecord",
  "description": "One TWAP order status event.",
  "type": "object",
  "required": [
    "block_number",
    "block_time",
    "coin",
    "executed_notional",
    "executed_size",
    "minutes",
    "randomize",
    "reduce_only",
    "side",
    "size",
    "started_at",
    "status",
    "timestamp",
    "twap_id",
    "user_address"
  ],
  "properties": {
    "block_number": {
      "description": "Hyperliquid block number.",
      "type": "integer",
      "format": "int64"
    },
    "block_time": {
      "description": "Time of the block that carried the event (RFC 3339, UTC).",
      "type": "string",
      "format": "date-time"
    },
    "coin": {
      "description": "Market symbol.",
      "type": "string",
      "example": "HYPE"
    },
    "executed_notional": {
      "description": "Notional filled so far, in quote units.",
      "type": "number"
    },
    "executed_size": {
      "description": "Size filled so far, in base units.",
      "type": "number"
    },
    "minutes": {
      "description": "TWAP duration in minutes.",
      "type": "integer"
    },
    "randomize": {
      "description": "True when slice timing is randomized.",
      "type": "boolean"
    },
    "reduce_only": {
      "description": "True for a reduce-only TWAP.",
      "type": "boolean"
    },
    "side": {
      "description": "`B` (buy) or `A` (sell).",
      "type": "string",
      "enum": [
        "B",
        "A"
      ]
    },
    "size": {
      "description": "Total TWAP size, in base units.",
      "type": "number"
    },
    "started_at": {
      "description": "When the TWAP started (RFC 3339, UTC).",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "description": "`activated`, `waitingForTrigger`, `finished`, `terminated`, `stopped`, or `error`.",
      "type": "string",
      "example": "activated"
    },
    "stop_px": {
      "description": "Price bound that ends the TWAP: the highest price for a buy, the lowest for a sell. Omitted when not set.",
      "type": "number"
    },
    "timestamp": {
      "description": "When the status event happened (RFC 3339, UTC).",
      "type": "string",
      "format": "date-time"
    },
    "trigger_above": {
      "description": "True when the TWAP activates at or above `trigger_px`. Omitted for a TWAP without a trigger.",
      "type": "boolean"
    },
    "trigger_px": {
      "description": "Activation trigger price. Omitted for a TWAP without a trigger.",
      "type": "number"
    },
    "twap_id": {
      "description": "TWAP order ID. Every event of one TWAP carries the same ID.",
      "type": "integer",
      "format": "int64"
    },
    "user_address": {
      "description": "Wallet that placed the TWAP, lowercase.",
      "type": "string"
    }
  }
}
```

## Components using this schema

* [ApiResponseTwapArray](/schemas/components/api-response-twap-array)

## 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/twap/{symbol}`](/schemas/operations/get-hip3-twap)
* [`GET /v1/hyperliquid/hip3/twap/user/{user}`](/schemas/operations/get-hip3-user-twap)
* [`GET /v1/hyperliquid/hip4/twap/{symbol}`](/schemas/operations/get-hip4-twap)
* [`GET /v1/hyperliquid/hip4/twap/user/{user}`](/schemas/operations/get-hip4-user-twap)
* [`GET /v1/hyperliquid/twap/{symbol}`](/schemas/operations/get-hyperliquid-twap)
* [`GET /v1/hyperliquid/twap/user/{user}`](/schemas/operations/get-hyperliquid-user-twap)


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