twapHistory

post

https://api.hyperliquid.xyzhttps://api.hyperliquid-testnet.xyz

/info

Request TWAP history of a user.

Body

application/json

Request TWAP history of a user.

typeundefined · enumRequired

Type of request.

Possible values:

userstring · min: 42 · max: 42Required

User address.

Pattern: ^0[xX][0-9a-fA-F]+$

Responses

200

Array of user's TWAP history.

application/json

Array of user's TWAP history.

timenumberRequired

Creation time of the history record (in seconds since epoch).

statusany ofRequired

Current status of the TWAP order.

• "finished": Fully executed.
• "activated": Active and executing.
• "terminated": Terminated.
• "error": An error occurred.

or

twapIdnumberOptional

ID of the TWAP.

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

TypeScript

import * as hl from "@nktkas/hyperliquid";

const transport = new hl.HttpTransport(); // or `WebSocketTransport`
const client = new hl.InfoClient({ transport });

const data = await client.twapHistory({ user: "0x..." });

[
  {
    "time": 1,
    "state": null,
    "status": {
      "status": "finished"
    },
    "twapId": 1
  }
]