Sign in

v1

latestOpenAPI 3.0.02026-07-2442138225.7 KB
Actions

Get perp events

Retrieve async venue outcomes (fills, liquidations, SL/TP triggers) for a user on a specific provider. Returns a paginated list ordered by most recent first.

get/v1/events

Query parameters

offsetnumber

Offset for pagination

limitnumber

Maximum number of items to return

providerId'hyperliquid' | 'hyperliquid-xyz'

Single provider identifier. At least one of providerId or providerIds must be provided.

providerIdsstring[]

Filter by multiple providers (CSV, repeated query params, or JSON array). At least one of providerId or providerIds must be provided. When both providerId and providerIds are set, results include all listed providers.

addressstring required

User wallet address

eventType'order_filled' | 'liquidation' | 'stop_loss_triggered' | 'take_profit_triggered'

Filter by a single event type

eventTypesPerpEventType[]

Filter by multiple event types (CSV or repeated query params)

marketIdstring

Filter by market (e.g. hyperliquid-eth-usdc)

perpActionIdstring uuid

Filter events linked to a specific StakeKit action

providerOrderIdstring

Filter by venue order identifier (e.g. Hyperliquid oid)

fromDatestring

Include events with occurredAt >= fromDate (ISO 8601)

toDatestring

Include events with occurredAt <= toDate (ISO 8601)

Response

Paginated list of perp events

totalnumber required

Total number of items available

offsetnumber required

Offset of the current page

limitnumber required

Limit of the current page

Example response

{
  "total": 150,
  "limit": 100,
  "items": [
    {
      "providerId": "hyperliquid",
      "explorerUrl": "https://app.hyperliquid.xyz/explorer/tx/0x8a3fb2c1d4e5f67890abcdef12345678901234567890abcdef1234567890abcd",
      "order": {
        "orderId": "394438950581",
        "marketId": "hyperliquid-eth-usdc",
        "asset": "ETH",
        "originalSizeBase": "0.0063",
        "remainingSizeBase": "0.0",
        "limitPrice": 2395.2,
        "triggerPrice": 2500,
        "childOrderIds": [],
        "createdAt": "2026-04-23T07:52:05.187Z",
        "closedPnl": "-12.45",
        "fillPrice": 2500.5
      }
    }
  ]
}