Account data shapes

Account-level reads — account summary, positions, orders, fills, activity, and single-order lookup — are served by the SDK directly from each provider via @lifi/perps-sdk (getAccount, getPositions, getOrders, getFills, getActivity, getOrder). They are not LI.FI HTTP endpoints. This page documents the data shapes those calls return. getAccount returns the account’s access state as a value. The other reads throw it as a typed PerpsError. See Account access for the codes and what to render for each.

getAccount

Returns the account summary including balances, margin, and fee tier.

const account = await getAccount(client, {
  provider: 'hyperliquid',
  address: '0x1234...',
});

Parameters

Name	Type	Required	Description
`provider`	`string`	Yes	Provider identifier
`address`	`Address`	Yes	User’s wallet address

Shape

{
  "provider": "hyperliquid",
  "address": "0x1234567890abcdef1234567890abcdef12345678",
  "balances": [
    {
      "categoryId": "hyperliquid",
      "asset": { "providerId": "hyperliquid", "id": "0", "displaySymbol": "USDC", "logoURI": "https://assets.li.fi/tokens/usdc.png" },
      "units": "10000.00",
      "valueUsd": "10000.00"
    }
  ],
  "collateralBalances": [
    {
      "categoryId": "spot",
      "asset": { "providerId": "hyperliquid", "id": "0", "displaySymbol": "USDC", "logoURI": "https://assets.li.fi/tokens/usdc.png" },
      "units": "2500.00",
      "valueUsd": "2500.00"
    }
  ],
  "positions": [],
  "marginUsed": "2500.00",
  "unrealizedPnl": "150.00",
  "feeTier": {
    "maker": "0.0002",
    "taker": "0.0005"
  },
  "config": {
    "provider": "hyperliquid",
    "abstractionMode": "unifiedAccount",
    "agents": [],
    "dexStates": [
      {
        "dex": "",
        "marginSummary": {
          "accountValue": "10150.00",
          "totalNtlPos": "25000.00",
          "totalRawUsd": "10000.00",
          "totalMarginUsed": "2500.00"
        },
        "crossMarginSummary": {
          "accountValue": "10150.00",
          "totalNtlPos": "25000.00",
          "totalRawUsd": "10000.00",
          "totalMarginUsed": "2500.00"
        },
        "crossMaintenanceMarginUsed": "1250.00",
        "withdrawable": "7500.00"
      }
    ],
    "availableAfterMaintenance": "7500.00"
  }
}

AccountResponse fields

Field	Type	Description
`provider`	`string`	Provider identifier
`address`	`string`	User’s wallet address
`balances`	`Balance[]`	Flat, non-collateral holdings. Each `Balance` is `{ categoryId, asset, units, valueUsd, price?, transferable? }`. `price` is the USD price of one unit, absent when the provider holds no price for the asset. `transferable` is the part of `units` a category transfer can release; every collateral row and every spot row carries it.
`collateralBalances`	`Balance[]`	SDK-determined collateral subset (spot balances in a category’s quote asset).
`positions`	`Position[]`	Open positions the snapshot already computed; equals the unfiltered getPositions output.
`marginUsed`	`string?`	Total margin used across all positions
`unrealizedPnl`	`string?`	Total unrealized PnL across all positions
`feeTier`	`FeeTier`	Maker and taker fee rates
`config`	`AccountConfig`	Provider-specific account state — see AccountConfig

AccountConfig

Discriminated union of per-provider account configuration state. Narrow with config.provider === '<key>' to access provider-specific fields. Hyperliquid (provider: "hyperliquid"):

Field	Type	Description
`provider`	`"hyperliquid"`	Discriminator
`abstractionMode`	`string \| null`	Active abstraction variant (e.g. `"unifiedAccount"`, `"dexAbstraction"`, `"disabled"`). `null` when abstraction has never been set — clients fall back to the descriptor’s `default` `ParamOption`.
`agents`	`HyperliquidAgent[]`	Currently-authorised agent wallets. The `approveAgent` setup descriptor consults this to detect expiry.
`builderFeeApproval`	`HyperliquidBuilderFeeApproval?`	Builder fee approval state. The type carries the field, but `getAccount` never populates it.
`dexStates`	`HyperliquidDexAccountState[]`	One entry per perps sub-dex with a live market: `{ dex, marginSummary, crossMarginSummary, crossMaintenanceMarginUsed, withdrawable }`. `dex` is the empty string for the main perps dex.
`availableAfterMaintenance`	`string?`	Venue buying power for unified and portfolio-margin accounts. Absent in other modes.

Lighter (provider: "lighter"):

Field	Type	Description
`provider`	`"lighter" \| "lighter-rh"`	Discriminator — `"lighter"` for the mainnet deployment, `"lighter-rh"` for the Robinhood Chain deployment
`accountIndex`	`number`	L2 integer account identifier — used by the SDK for WASM signing. Transfer activities identify counterparties by this index.
`apiKeyIndex`	`number?`	Slot of the API key the SDK holds, as named by the backend when it registered the key. Absent while the SDK holds no key.
`apiKeyRegistered`	`boolean`	Whether a key is currently live in `apiKeyIndex`. The `registerApiKey` setup descriptor consults this to gate trading.
`accountType`	`number`	Lighter `account_type`, the sub-account type: `0` = Main, `1` = Sub, `2` = Public, `3` = LighterPublic, `4` = Staking. It is not an account tier — the tier is `userTierName`.
`availableBalance`	`string`	Lighter `available_balance`: buying power for the whole account, marked to market, in quote-asset units.
`totalAssetValue`	`string`	Lighter `total_asset_value`: perps-route equity, including isolated allocations and unrealized PnL. Excludes spot-route balances.
`userTierName`	`string?`	Lighter `user_tier_name` from `/accountLimits`, in the tier vocabulary `changeAccountTier` accepts. Absent on an unauthenticated read, which fetches no limits.
`accountTradingMode`	`number`	Lighter `account_trading_mode`: `0` = Classic/Simple (segregated margin), `1` = Unified (cross-asset margin). Matches the `mode` of an option on the `accountMode` setup step.
`assetCollateral`	`LighterAssetCollateral[]`	Per-asset cross-margin collateral flags for held spot assets, each `{ assetId, enabled }`. Meaningful only when `accountTradingMode === 1`; assets whose `margin_mode` Lighter omits are not listed.
`readOnlyTokenApproved`	`boolean`	Whether a read-only auth token is currently live. The `approveReadOnlyToken` client-side flow consults this to gate read access.
`readOnlyTokenExpiry`	`number?`	Unix timestamp (seconds) at which the read-only token expires. Absent when no token is approved.
`readOnlyTokenScope`	`'single' \| 'all'?`	Scope of the approved read-only token. Absent when no token is approved.
`referralPresent`	`boolean`	`true` if and only if a referral code is applied to the account, recorded by a confirmed `setReferrer` action. Lighter applies a referral code permanently at sign-up, so any applied code — whichever integrator owns it — satisfies `setReferrer`. A `false` keeps the step gateable.

Ondo (provider: "ondo"):

Field	Type	Description
`provider`	`"ondo"`	Discriminator
`loggedIn`	`boolean`	Whether a live login (auth) token is held
`balance`	`OndoAccountBalance?`	Venue figures, each a decimal string: `walletBalance`, `unrealizedPnl`, `marginBalance`, `usedMargin`, `availableMargin`, `withdrawableMargin`. Absent when logged out.
`authTokenExpiry`	`number?`	Unix timestamp (seconds) at which the login token expires. Present if and only if `loggedIn === true`. The token itself never appears here.
`termsAccepted`	`boolean`	Venue terms accepted. Derived by comparing the account’s `termsVersion` and `privacyVersion` (from `GET /v1/account`) against the versions LI.FI requires. Always `false` when logged out.
`apiKeyRegistered`	`boolean`	A venue API key is present in local storage. Local presence only — venue-side validity is not verified.
`referralSet`	`boolean`	A referral code (any referrer’s) is already applied to the account. Always `false` when logged out.
`depositAddress`	`string \| null`	The user’s provisioned Ethereum USDC margin-wallet deposit address, or `null` before `createDepositAddress` has run (or while logged out).

The response positions array mirrors the unfiltered getPositions output. Orders are fetched separately: getOrders.

SDK: getAccount()

getPositions

Returns the user’s open positions. Hyperliquid and Lighter return every open position in one response (hasMore: false); limit and cursor are hints for providers that page.

const result = await getPositions(client, {
  provider: 'hyperliquid',
  address: '0x1234...',
});

Parameters

Name	Type	Required	Description
`provider`	`string`	Yes	Provider identifier
`address`	`Address`	Yes	User’s wallet address
`marketId`	`string`	No	Filter by the canonical `Market.id` (not display symbol)
`limit`	`integer`	No	Page-size hint; provider defaults and caps apply
`cursor`	`string`	No	Pagination cursor from previous response

Shape

{
  "provider": "hyperliquid",
  "positions": [
    {
      "market": {
        "providerId": "hyperliquid",
        "id": "BTC",
        "categoryId": "hyperliquid",
        "baseAsset": { "providerId": "hyperliquid", "id": "BTC", "displaySymbol": "BTC", "logoURI": "https://assets.li.fi/tokens/btc.png" },
        "quoteAsset": { "providerId": "hyperliquid", "id": "0", "displaySymbol": "USDC", "logoURI": "https://assets.li.fi/tokens/usdc.png" },
        "positionMarginAdjustment": "ADD_AND_REMOVE"
      },
      "side": "LONG",
      "size": "0.5",
      "entryPrice": "94000.00",
      "markPrice": "95000.50",
      "liquidationPrice": "85000.00",
      "unrealizedPnl": "500.25",
      "accruedFunding": "-1.20",
      "leverage": "10",
      "marginUsed": "4700.00",
      "initialMarginRequirement": "4750.03",
      "marginMode": "ISOLATED"
    }
  ],
  "pagination": {
    "limit": 50,
    "hasMore": false
  }
}

Position fields

Field	Type	Description
`market`	`PerpsMarketDisplay`	Market reference (see below), plus `positionMarginAdjustment` and `isDelisted?`
`side`	`'LONG' \| 'SHORT'`	Position direction
`size`	`string`	Position size
`entryPrice`	`string`	Average entry price
`markPrice`	`string?`	Current mark price
`liquidationPrice`	`string`	Estimated liquidation price
`unrealizedPnl`	`string`	Unrealized profit/loss
`accruedFunding`	`string?`	Funding accrued since the position opened. Positive means funding received, negative means funding paid.
`leverage`	`string?`	Current leverage as a decimal string multiple (for example `"10"` means 10x)
`marginUsed`	`string`	Margin allocated
`initialMarginRequirement`	`string`	Exact initial margin the venue currently requires for the position, safe for risk calculations
`marginMode`	`'ISOLATED' \| 'CROSS'`	Margin mode

MarketDisplay

The MarketDisplay object is used across positions, orders, fills, and activity to identify the market and its underlying assets:

Field	Type	Description
`providerId`	`string`	Provider that owns the market (e.g., `"hyperliquid"`)
`id`	`string`	Provider’s canonical, stringified market id that uniquely identifies the trading instrument (e.g., `"BTC"`, `"xyz:PURR"`, `"@142"`; numeric on Lighter)
`categoryId`	`string`	Provider category id (e.g., `"hyperliquid"`, `"xyz"`, `"spot"`)
`baseAsset`	`Asset`	Base leg of the market
`quoteAsset`	`Asset`	Quote leg of the market
`isDelisted?`	`boolean`	`true` when the venue has delisted the market

SDK: getPositions()

getOrders

Returns the user’s orders as a single Order union: regular (MARKET, LIMIT), trigger, and TWAP orders. By default only active orders are returned; pass statuses to read order history.

const result = await getOrders(client, {
  provider: 'hyperliquid',
  address: '0x1234...',
});

Parameters

Name	Type	Required	Description
`provider`	`string`	Yes	Provider identifier
`address`	`Address`	Yes	User’s wallet address
`marketId`	`string`	No	Filter by the canonical `Market.id` (not display symbol)
`statuses`	`OrderStatus[]`	No	Lifecycle statuses to return. Defaults to the active set: `OPEN`, `PENDING`, `ACCEPTED`, `PARTIALLY_FILLED`, `TRIGGERED`. Pass `FILLED`, `CANCELLED`, `REJECTED`, or `EXPIRED` for history.
`limit`	`integer`	No	Maximum items returned; provider defaults and caps apply
`cursor`	`string`	No	Opaque pagination cursor from the previous response; check `pagination.hasMore`

Shape

{
  "provider": "hyperliquid",
  "orders": [
    {
      "type": "LIMIT",
      "orderId": "12345678",
      "market": {
        "providerId": "hyperliquid",
        "id": "ETH",
        "categoryId": "hyperliquid",
        "baseAsset": { "providerId": "hyperliquid", "id": "ETH", "displaySymbol": "ETH", "logoURI": "https://assets.li.fi/tokens/eth.png" },
        "quoteAsset": { "providerId": "hyperliquid", "id": "0", "displaySymbol": "USDC", "logoURI": "https://assets.li.fi/tokens/usdc.png" }
      },
      "side": "BUY",
      "status": "OPEN",
      "originalSize": "1.0",
      "remainingSize": "1.0",
      "filledSize": "0",
      "price": "3150.00",
      "timeInForce": "GTC",
      "reduceOnly": false,
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:00Z"
    },
    {
      "type": "TAKE_PROFIT_MARKET",
      "orderId": "87654321",
      "market": {
        "providerId": "hyperliquid",
        "id": "BTC",
        "categoryId": "hyperliquid",
        "baseAsset": { "providerId": "hyperliquid", "id": "BTC", "displaySymbol": "BTC", "logoURI": "https://assets.li.fi/tokens/btc.png" },
        "quoteAsset": { "providerId": "hyperliquid", "id": "0", "displaySymbol": "USDC", "logoURI": "https://assets.li.fi/tokens/usdc.png" }
      },
      "side": "SELL",
      "status": "OPEN",
      "originalSize": "0.1",
      "remainingSize": "0.1",
      "filledSize": "0",
      "triggerPrice": "100000.00",
      "triggerCondition": "ABOVE",
      "reduceOnly": true,
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "hasMore": false
  }
}

orders is an array of Order = RegularOrder | TriggerOrder | TwapOrder, discriminated on type.

Order fields (all variants)

Field	Type	Description
`orderId`	`string`	Venue-assigned order ID
`clientOrderId`	`string?`	Client-set ID, absent when none was set
`market`	`MarketDisplay`	Market reference
`side`	`'BUY' \| 'SELL'`	Order direction
`type`	`OrderType`	Discriminator — see OrderType
`status`	`OrderStatus`	Lifecycle status — see OrderStatus
`statusReason`	`string?`	Venue text for a `REJECTED` or `CANCELLED` order, when the venue gives one
`originalSize`	`string`	Quantity the order was submitted for, in base-asset units
`remainingSize`	`string`	Quantity not yet filled, in base-asset units
`filledSize`	`string`	Amount filled
`averagePrice`	`string?`	Average fill price
`reduceOnly`	`boolean`	Whether reduce-only
`parentOrderId`	`string?`	Parent of a placement take-profit/stop-loss leg or of a TWAP child. Absent on position-level triggers.
`explorerLink`	`string?`	Set only when the venue row carries a transaction hash
`createdAt`	`string`	ISO 8601 timestamp
`updatedAt`	`string`	ISO 8601 timestamp

RegularOrder fields

type is MARKET or LIMIT.

Field	Type	Description
`price`	`string?`	Limit price
`timeInForce`	`TimeInForce`	Time-in-force policy
`expiresAt`	`string?`	ISO 8601 expiry

TriggerOrder fields

type is STOP_MARKET, STOP_LIMIT, TAKE_PROFIT_MARKET, or TAKE_PROFIT_LIMIT.

Field	Type	Description
`triggerPrice`	`string`	Price at which the order activates
`triggerCondition`	`'ABOVE' \| 'BELOW'`	Direction in which the price crosses `triggerPrice`
`limitPrice`	`string?`	For a `_LIMIT` type, the limit price. For a `_MARKET` type, the slippage-adjusted limit price that the venue holds, when the venue holds one.

TwapOrder fields

type is TWAP. TWAP parents are read-only.

Field	Type	Description
`durationSeconds`	`number`	Total TWAP duration
`startedAt`	`string`	ISO 8601 start timestamp

OrderType

MARKET, LIMIT, STOP_MARKET, STOP_LIMIT, TAKE_PROFIT_MARKET, TAKE_PROFIT_LIMIT, TWAP. TWAP appears on reads only; placement types exclude it. Provider support for each placement type is listed under placeOrder.

OrderStatus

Value	Description
`PENDING`	A placement take-profit/stop-loss leg waiting for its parent order to fill
`ACCEPTED`	The venue accepted the order and has not yet placed it on the book. Waits on no parent order.
`OPEN`	Live on the book, or an armed trigger waiting for its trigger price
`PARTIALLY_FILLED`	Open with a positive filled size
`TRIGGERED`	The trigger price was hit and the order went live
`FILLED`	Terminal: the order filled
`CANCELLED`	Terminal: the order was cancelled
`REJECTED`	Terminal: the order was rejected
`EXPIRED`	Terminal: the order expired

SDK: getOrders()

getFills

Returns paginated order fills. Results are sorted by creation time, newest first.

const fills = await getFills(client, {
  provider: 'hyperliquid',
  address: '0x1234...',
  limit: 50,
});

Parameters

Name	Type	Required	Description
`provider`	`string`	Yes	Provider identifier
`address`	`Address`	Yes	User’s wallet address
`startTime`	`integer`	No	Filter: fills at or after this timestamp (ms)
`endTime`	`integer`	No	Filter: fills at or before this timestamp (ms)
`cursor`	`string`	No	Pagination cursor from previous response
`limit`	`integer`	No	Items per page; provider defaults and caps apply (Hyperliquid: default 50, max 200)

Shape

The filledSize, fee, and realizedPnl fields are optional. realizedPnl is null when the fill did not close a position.

{
  "provider": "hyperliquid",
  "items": [
    {
      "id": "12345678",
      "orderId": "12340001",
      "market": {
        "providerId": "hyperliquid",
        "id": "BTC",
        "categoryId": "hyperliquid",
        "baseAsset": { "providerId": "hyperliquid", "id": "BTC", "displaySymbol": "BTC", "logoURI": "https://assets.li.fi/tokens/btc.png" },
        "quoteAsset": { "providerId": "hyperliquid", "id": "USDC", "displaySymbol": "USDC", "logoURI": "https://assets.li.fi/tokens/usdc.png" }
      },
      "side": "BUY",
      "type": "LIMIT",
      "size": "0.5",
      "price": "94000.00",
      "liquidity": "maker",
      "filledSize": "0.5",
      "fee": { "amount": "4.70", "asset": "USDC" },
      "realizedPnl": null,
      "startPosition": "0",
      "classification": "Opened Long",
      "createdAt": "2025-01-15T09:00:00Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "hasMore": true,
    "cursor": "abc123"
  }
}

Fill fields

Field	Type	Description
`id`	`string`	Fill ID
`orderId`	`string`	ID of the parent order
`market`	`MarketDisplay`	Market reference
`side`	`'BUY' \| 'SELL'`	Order direction
`type`	`OrderType?`	Order type — see OrderType. Absent when the provider’s fill payload doesn’t carry it and it can’t be inferred (e.g. a Hyperliquid taker fill).
`size`	`string`	Size of this fill
`price`	`string`	Fill price
`liquidity`	`'maker' \| 'taker'`	Whether the fill provided or removed liquidity
`filledSize`	`string?`	Amount filled (absent if no fills yet)
`fee`	`Fee?`	Fee the venue charged, as `{ amount, asset }`. Absent when the venue reports no fee for the fill. Format `amount` against `fee.asset`, never against the fill’s quote asset.
`builderFee`	`Fee?`	Portion of `fee` the venue reports as the builder portion, in its own asset. Absent when the venue reports no builder portion.
`clientOrderId`	`string?`	Client order ID of the order that produced the fill, as the venue echoes it. Absent when the order carried none or the venue omits it.
`leverage`	`string?`	Leverage the account had set on the fill’s market at the moment the venue executed the fill, as a decimal string (e.g. `"10"` means 10x). Absent when the venue reports no leverage on its fill payload.
`realizedPnl`	`string \| null?`	Realized PnL (present only when closing a position, `null` otherwise)
`startPosition`	`string?`	Position size before this fill
`classification`	`FillClassification`	How this fill affected the position (see below)
`createdAt`	`string`	ISO 8601 timestamp
`explorerLink`	`string?`	Block-explorer URL for the settling on-chain tx. Absent when the venue row carries no transaction hash.

FillClassification

Describes how the fill affected the user’s position. Wire values are Title Case strings:

Value	Description
`"Opened Long"`	Opened a new long position from zero
`"Opened Short"`	Opened a new short position from zero
`"Increased Long"`	Added to an existing long position
`"Increased Short"`	Added to an existing short position
`"Reduced Long"`	Partially closed a long position
`"Reduced Short"`	Partially closed a short position
`"Closed Long"`	Fully closed a long position
`"Closed Short"`	Fully closed a short position
`"Switched Long"`	Closed a short and opened a long (crossed zero)
`"Switched Short"`	Closed a long and opened a short (crossed zero)
`"Spot Buy"`	Spot market buy
`"Spot Sell"`	Spot market sell
`"Buy"`	A perps buy whose position change the venue data cannot show
`"Sell"`	A perps sell whose position change the venue data cannot show

Pagination

Use the cursor from the response to fetch the next page:

const nextPage = await getFills(client, {
  provider: 'hyperliquid',
  address: '0x1234...',
  cursor: 'abc123',
});

When hasMore is false, there are no more pages. SDK: getFills()

getActivity

Returns paginated account activity: deposits, withdrawals, transfers, liquidations, and funding payments.

const activity = await getActivity(client, {
  provider: 'hyperliquid',
  address: '0x1234...',
});

Parameters

Name	Type	Required	Description
`provider`	`string`	Yes	Provider identifier
`address`	`Address`	Yes	User’s wallet address
`startTime`	`integer`	No	Filter: activity after this timestamp (ms)
`endTime`	`integer`	No	Filter: activity before this timestamp (ms)
`cursor`	`string`	No	Pagination cursor from previous response
`limit`	`integer`	No	Items per page; provider defaults and caps apply (Hyperliquid: default 50, max 200)
`type`	`ActivityType[]`	No	Filter by activity type(s): `DEPOSIT`, `WITHDRAWAL`, `FUNDING`, `LIQUIDATION`, `TRANSFER`

Shape

The response contains a discriminated union of activity items — the type field determines which fields are present.

{
  "provider": "hyperliquid",
  "items": [
    {
      "id": "dep-001",
      "provider": "hyperliquid",
      "type": "DEPOSIT",
      "timestamp": "2025-01-15T10:00:00Z",
      "asset": { "providerId": "hyperliquid", "id": "0", "displaySymbol": "USDC", "logoURI": "https://assets.li.fi/tokens/usdc.png" },
      "amount": "5000.00"
    },
    {
      "id": "wd-002",
      "provider": "hyperliquid",
      "type": "WITHDRAWAL",
      "timestamp": "2025-01-14T09:00:00Z",
      "asset": { "providerId": "hyperliquid", "id": "0", "displaySymbol": "USDC", "logoURI": "https://assets.li.fi/tokens/usdc.png" },
      "amount": "1000.00",
      "fee": { "amount": "1.00", "asset": "USDC" }
    },
    {
      "id": "fund-003",
      "provider": "hyperliquid",
      "type": "FUNDING",
      "timestamp": "2025-01-14T08:00:00Z",
      "market": {
        "providerId": "hyperliquid",
        "id": "BTC",
        "categoryId": "hyperliquid",
        "baseAsset": { "providerId": "hyperliquid", "id": "BTC", "displaySymbol": "BTC", "logoURI": "https://assets.li.fi/tokens/btc.png" },
        "quoteAsset": { "providerId": "hyperliquid", "id": "USDC", "displaySymbol": "USDC", "logoURI": "https://assets.li.fi/tokens/usdc.png" }
      },
      "amount": "-2.50",
      "positionSize": "0.5",
      "fundingRate": "0.0001"
    },
    {
      "id": "liq-004",
      "provider": "hyperliquid",
      "type": "LIQUIDATION",
      "timestamp": "2025-01-13T12:00:00Z",
      "liquidatedNotionalPosition": "50000.00",
      "accountValue": "100.00",
      "leverageType": "Cross",
      "liquidatedPositions": [
        {
          "market": {
            "providerId": "hyperliquid",
            "id": "ETH",
            "categoryId": "hyperliquid",
            "baseAsset": { "providerId": "hyperliquid", "id": "ETH", "displaySymbol": "ETH", "logoURI": "https://assets.li.fi/tokens/eth.png" },
            "quoteAsset": { "providerId": "hyperliquid", "id": "USDC", "displaySymbol": "USDC", "logoURI": "https://assets.li.fi/tokens/usdc.png" }
          },
          "size": "10.0"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 50,
    "hasMore": true,
    "cursor": "abc123"
  }
}

Activity Types

All activity items share these base fields:

Field	Type	Description
`id`	`string`	Activity ID
`provider`	`string`	Provider identifier
`type`	`string`	Activity type (discriminator)
`timestamp`	`string`	ISO 8601 timestamp

DEPOSIT — Funds deposited into the provider account:

Field	Type	Description
`asset`	`Asset`	Deposited asset
`amount`	`string`	Deposit amount
`counterpartyAddress`	`string?`	Source address, when the venue’s deposit payload names one
`explorerLink`	`string?`	Block-explorer URL for the on-chain deposit tx

WITHDRAWAL — Funds withdrawn from the provider account:

Field	Type	Description
`asset`	`Asset`	Withdrawn asset
`amount`	`string`	Withdrawal amount
`fee`	`Fee?`	Withdrawal fee, as `{ amount, asset }`. Absent when the venue reports no fee.
`explorerLink`	`string?`	Block-explorer URL for the on-chain withdrawal tx

FUNDING — Funding payment received or paid on an open position:

Field	Type	Description
`market`	`MarketDisplay`	Market reference
`amount`	`string`	Funding amount (negative = paid)
`positionSize`	`string`	Position size at time of funding
`fundingRate`	`string`	Funding rate applied

LIQUIDATION — Position(s) liquidated:

Field	Type	Description
`liquidatedNotionalPosition`	`string?`	Total notional value liquidated. Absent when the venue reports no such value.
`accountValue`	`string?`	Account value at time of liquidation. Absent when the venue reports no such value.
`leverageType`	`string?`	Leverage type (e.g., `"Cross"`). Absent when the venue reports no such value.
`liquidatedPositions`	`LiquidatedPosition[]`	Positions that were liquidated

Each LiquidatedPosition:

Field	Type	Description
`market`	`MarketDisplay`	Market reference
`size`	`string?`	Position size liquidated. Absent when the venue reports no such value.

TRANSFER — Transfer between two accounts on the same provider, emitted by Hyperliquid (identified by counterpartyAddress) and Lighter (identified by counterpartyAccountIndex). Direction is relative to the queried account. The counterparty is identified by either an account index (integer L2 account identifier — Lighter) or a wallet address (Hyperliquid, where accounts ARE addresses). The shape is a discriminated union: at least one of counterpartyAccountIndex / counterpartyAddress MUST be present, and either may appear alone or alongside the other. Consumers that render counterparties should prefer counterpartyAccountIndex when present (canonical handle on index-based providers) and fall back to a truncated counterpartyAddress otherwise.

Field	Type	Description
`direction`	`'IN' \| 'OUT'`	Direction relative to the queried account
`counterpartyAccountIndex`	`number?`	The other side’s account index (required when `counterpartyAddress` is absent)
`counterpartyAddress`	`string?`	The other side’s wallet address (required when `counterpartyAccountIndex` is absent)
`asset`	`Asset`	Transferred asset
`amount`	`string`	Transfer amount
`fees`	`Fee[]?`	Every fee the venue charged, in the order reported. Absent when the venue reports no fee.
`meta`	`object?`	Provider-specific metadata
`explorerLink`	`string?`	Block-explorer URL for the on-chain transfer tx

Pagination

Use the cursor from the response to fetch the next page:

const nextPage = await getActivity(client, {
  provider: 'hyperliquid',
  address: '0x1234...',
  cursor: 'abc123',
});

When hasMore is false, there are no more pages. SDK: getActivity()

Getting Started

Concepts

Providers

SDK

API Reference

Reference

getAccount

Parameters

Shape

AccountResponse fields

AccountConfig

getPositions

Parameters

Shape

Position fields

MarketDisplay

getOrders

Parameters

Shape

Order fields (all variants)

RegularOrder fields

TriggerOrder fields

TwapOrder fields

OrderType

OrderStatus

getFills

Parameters

Shape

Fill fields

FillClassification

getActivity

Parameters

Shape

Activity Types

​getAccount

​Parameters

​Shape

​AccountResponse fields

​AccountConfig

​getPositions

​Parameters

​Shape

​Position fields

​MarketDisplay

​getOrders

​Parameters

​Shape

​Order fields (all variants)

​RegularOrder fields

​TriggerOrder fields

​TwapOrder fields

​OrderType

​OrderStatus

​getFills

​Parameters

​Shape

​Fill fields

​FillClassification

​Pagination

​getActivity

​Parameters

​Shape

​Activity Types

​Pagination

getAccount

Parameters

Shape

AccountResponse fields

AccountConfig

getPositions

Parameters

Shape

Position fields

MarketDisplay

getOrders

Parameters

Shape

Order fields (all variants)

RegularOrder fields

TriggerOrder fields

TwapOrder fields

OrderType

OrderStatus

getFills

Parameters

Shape

Fill fields

FillClassification

Pagination

getActivity

Parameters

Shape

Activity Types

Pagination