API Reference
Log inRegister interest

Get perp events

get
https://perps.yield.xyz/v1/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.

Query Params
number
≥ 0
Defaults to 0

Offset for pagination

number
1 to 500
Defaults to 100

Maximum number of items to return

string
enum

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

Allowed:
providerIds
array of strings

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.

providerIds
Allowed:
string
required

User wallet address

string
enum

Filter by a single event type

Allowed:
eventTypes
array of strings

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

eventTypes
Allowed:
string

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

uuid

Filter events linked to a specific StakeKit action

string

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

string

Include events with occurredAt >= fromDate (ISO 8601)

string

Include events with occurredAt <= toDate (ISO 8601)

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?