Skip to main content
Returns paginated account activity: deposits, withdrawals, liquidations, and funding payments.
The examples on this page use Hyperliquid (provider: 'hyperliquid'). Replace the provider value with any supported DEX from getProviders().
import { getActivity } from '@lifi/perps-sdk';

const activity = await getActivity(client, {
  provider: 'hyperliquid',
  address: userAddress,
  limit: 50,
});

for (const item of activity.items) {
  console.log(item.type, item.timestamp);
  if (item.type === 'FUNDING') {
    console.log(item.asset.displaySymbol, item.amount, item.fundingRate);
  }
}

// Pagination
if (activity.pagination.hasMore) {
  const nextPage = await getActivity(client, {
    provider: 'hyperliquid',
    address: userAddress,
    cursor: activity.pagination.cursor,
  });
}

Filtering by type

import { getActivity, ActivityType } from '@lifi/perps-sdk';

// Only funding payments
const funding = await getActivity(client, {
  provider: 'hyperliquid',
  address: userAddress,
  type: [ActivityType.FUNDING],
});

// Deposits and withdrawals
const transfers = await getActivity(client, {
  provider: 'hyperliquid',
  address: userAddress,
  type: [ActivityType.DEPOSIT, ActivityType.WITHDRAWAL],
});

Parameters

ParameterTypeRequiredDescription
clientPerpsSDKClientYesSDK client
params.providerstringYesDEX identifier
params.addressstringYesUser’s wallet address
params.cursorstringNoPagination cursor from previous response
params.limitnumberNoItems per page (default 50, max 200)
params.startTimenumberNoFilter: activity after this timestamp (ms)
params.endTimenumberNoFilter: activity before this timestamp (ms)
params.typeActivityType[]NoFilter by activity type(s)
optionsSDKRequestOptionsNoRequest options

Returns

ActivitiesResponse:
FieldTypeDescription
providerstringProvider identifier
itemsActivityItem[]Activity items (discriminated union by type)
paginationPaginationPagination metadata

ActivityType enum

ValueDescription
DEPOSITFunds deposited
WITHDRAWALFunds withdrawn
FUNDINGFunding payment on position
LIQUIDATIONPosition liquidated

Activity item fields

All items share id, provider, type, and timestamp. Additional fields depend on type: DEPOSIT: amount WITHDRAWAL: amount, fee FUNDING: asset (AssetDisplay), amount (negative = paid), positionSize, fundingRate LIQUIDATION: liquidatedNotionalPosition, accountValue, leverageType, liquidatedPositions[] (each with asset: AssetDisplay and size) API Reference: GET /activity