Get activity

Get unified perp activity

curl --request GET \
  --url https://perps.yield.xyz/v1/activity \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://perps.yield.xyz/v1/activity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://perps.yield.xyz/v1/activity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://perps.yield.xyz/v1/activity"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://perps.yield.xyz/v1/activity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "total": 150,
  "offset": 0,
  "limit": 100,
  "items": [
    {
      "type": "event",
      "event": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventType": "order_filled",
        "providerId": "hyperliquid",
        "occurredAt": "2023-11-07T05:31:56Z",
        "order": {
          "orderId": "394438950581",
          "marketId": "hyperliquid-eth-usdc",
          "asset": "ETH",
          "side": "buy",
          "type": "market",
          "originalSizeBase": "0.0063",
          "remainingSizeBase": "0.0",
          "reduceOnly": false,
          "isPositionLevel": false,
          "clientOrderId": null,
          "childOrderIds": [],
          "createdAt": "2026-04-23T07:52:05.187Z",
          "limitPrice": 2395.2,
          "timeInForce": "ioc",
          "triggerPrice": 2500,
          "closedPnl": "-12.45",
          "fillPrice": 2500.5
        },
        "marketId": "<string>",
        "perpActionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "providerOrderId": "<string>",
        "explorerUrl": "https://app.hyperliquid.xyz/explorer/tx/0x8a3fb2c1d4e5f67890abcdef12345678901234567890abcdef1234567890abcd"
      }
    }
  ]
}

{
  "statusCode": 401,
  "timestamp": "2026-05-04T12:00:00.000Z",
  "path": "/v1/actions",
  "message": "Invalid API key",
  "details": {
    "message": "Invalid API key",
    "code": "AUTH_INVALID_API_KEY"
  }
}

{
  "statusCode": 429,
  "timestamp": "2026-05-04T12:00:00.000Z",
  "path": "/v1/actions",
  "message": "Rate limit exceeded",
  "details": {
    "message": "Rate limit exceeded",
    "code": "RATE_LIMIT_EXCEEDED",
    "error": "Too Many Requests",
    "retryAfter": 30
  }
}

GET

activity

Get unified perp activity

curl --request GET \
  --url https://perps.yield.xyz/v1/activity \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://perps.yield.xyz/v1/activity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://perps.yield.xyz/v1/activity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://perps.yield.xyz/v1/activity"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://perps.yield.xyz/v1/activity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "total": 150,
  "offset": 0,
  "limit": 100,
  "items": [
    {
      "type": "event",
      "event": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventType": "order_filled",
        "providerId": "hyperliquid",
        "occurredAt": "2023-11-07T05:31:56Z",
        "order": {
          "orderId": "394438950581",
          "marketId": "hyperliquid-eth-usdc",
          "asset": "ETH",
          "side": "buy",
          "type": "market",
          "originalSizeBase": "0.0063",
          "remainingSizeBase": "0.0",
          "reduceOnly": false,
          "isPositionLevel": false,
          "clientOrderId": null,
          "childOrderIds": [],
          "createdAt": "2026-04-23T07:52:05.187Z",
          "limitPrice": 2395.2,
          "timeInForce": "ioc",
          "triggerPrice": 2500,
          "closedPnl": "-12.45",
          "fillPrice": 2500.5
        },
        "marketId": "<string>",
        "perpActionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "providerOrderId": "<string>",
        "explorerUrl": "https://app.hyperliquid.xyz/explorer/tx/0x8a3fb2c1d4e5f67890abcdef12345678901234567890abcdef1234567890abcd"
      }
    }
  ]
}

{
  "statusCode": 401,
  "timestamp": "2026-05-04T12:00:00.000Z",
  "path": "/v1/actions",
  "message": "Invalid API key",
  "details": {
    "message": "Invalid API key",
    "code": "AUTH_INVALID_API_KEY"
  }
}

{
  "statusCode": 429,
  "timestamp": "2026-05-04T12:00:00.000Z",
  "path": "/v1/actions",
  "message": "Rate limit exceeded",
  "details": {
    "message": "Rate limit exceeded",
    "code": "RATE_LIMIT_EXCEEDED",
    "error": "Too Many Requests",
    "retryAfter": 30
  }
}

Each item has type of event (with an event object) or action (with an action object); see Activity. Requires address and providerId or providerIds. actionStatus and actionStatuses (up to 7) filter only action items; events are never filtered by them. This is a paginated GET feed, not a subscription.

Authorizations

x-api-key

string

header

required

Query Parameters

offset

number

default:0

Offset for pagination

Required range: x >= 0

Example:

0

limit

number

default:100

Maximum number of items to return

Required range: 1 <= x <= 500

Example:

100

providerId

enum<string>

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

Available options:

hyperliquid,

hyperliquid-xyz

Example:

"hyperliquid"

providerIds

enum<string>[]

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.

Available options:

hyperliquid,

hyperliquid-xyz

Example:

["hyperliquid", "hyperliquid-xyz"]

address

string

required

User wallet address

Example:

"0xb8c8eb8efc68796e766f6ab320db8c165c064949"

actionStatus

enum<string>

If provided, filters only action items by their status. Timeline events are not affected. Current action status

Available options:

CANCELED,

CREATED,

WAITING_FOR_NEXT,

PROCESSING,

FAILED,

SUCCESS,

STALE

actionStatuses

enum<string>[]

Filter by multiple action statuses (supports CSV or repeated query params)

Current action status

Available options:

CANCELED,

CREATED,

WAITING_FOR_NEXT,

PROCESSING,

FAILED,

SUCCESS,

STALE

Response

Paginated unified activity

total

number

required

Total number of items available

Example:

150

offset

number

required

Offset of the current page

Example:

0

limit

number

required

Limit of the current page

Example:

100

items

object[]

Option 1
Option 2

Show child attributes

Getting started

Earn

Trade

Borrow

Authorizations

Query Parameters

Response