userHistoricalOrders

Subscribe to userHistoricalOrders

post

wss://api.hyperliquid.xyz/wswss://api.hyperliquid-testnet.xyz/ws

/

Subscription to user historical orders for a specific user.

Body

application/json

Subscription to user historical orders for a specific user.

typeundefined · enumRequired

Type of subscription.

Possible values:

userstring · min: 42 · max: 42Required

User address.

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

Responses

200

Event of user historical orders.

application/json

Event of user historical orders.

userstringRequired

User address.

Pattern: ^0x[a-fA-F0-9]{40}$

isSnapshotboolean · enumOptional

Whether this is an initial snapshot.

Possible values:

post

/

TypeScript

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

const transport = new hl.WebSocketTransport();
const client = new hl.SubscriptionClient({ transport });

const sub = await client.userHistoricalOrders({ user: "0x..." }, (data) => {
  console.log(data);
});

200

Event of user historical orders.

{
  "user": "text",
  "orderHistory": null,
  "isSnapshot": true
}