HIP-4 Outcomes - Orders

Get HIP-4 TWAP order events

TWAP order status events: activated, waitingForTrigger, finished, terminated, stopped, and error. Each event carries the TWAP size, executed size and notional, duration, and trigger settings. This route returns the events of one HIP-4 outcome side. HIP-4 TWAP orders placed before capture began were not recorded; history starts at the first captured TWAP. Events are ordered oldest first. Page with meta.next_cursor until meta.has_more is false. A page never ends partway through a millisecond, so it can hold fewer events than limit.

get/v1/hyperliquid/hip4/twap/{symbol}

Request

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

Path parameters

symbolstring required
Example:0

HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). The #-prefixed form (#0, #1) is also accepted.

Query parameters

integer
OR
string date-time
Example:1790812800000

Start of the window: Unix milliseconds or an RFC 3339 timestamp. Defaults to 24 hours ago.

integer
OR
string date-time
Example:1790899200000

End of the window: Unix milliseconds or an RFC 3339 timestamp. Defaults to now.

cursorstring

Value of meta.next_cursor from the previous page. The next page starts after it.

limitinteger

Maximum number of events to return (default: 100, max: 1000; larger values are capped at 1000).

Response

TWAP order status events

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "status": "activated",
      "coin": "HYPE"
    }
  ]
}

Changes

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