API reference, Bridges & wallets

Wallet PnL stream

  • Elysium: A wallet's positions and PnL on Elysium (GET /v1/wallet/{address}/pnl), pushed on subscribe, then the positions each block changes.
  • HyperEVM: A wallet's positions and PnL on HyperEVM (GET /v1/wallet/{address}/pnl), pushed on subscribe, then the positions each block changes.
  • Not on HyperCore: HyperCore trades on its order book: an account's positions and PnL move with its fills, pushed by the wallet channel (`hc.account`)

WebSocket channel pnl on wss://api.femtos.xyz/v1/ws

Parameters

ParamInExample or valuesMeaning
addressfilter0x876f1301aaa8452ceb98201cd4407fa9510a8181 (Elysium); 0x5a69a60ca8a4d189855b33bd9f1bbe71095c1039 (HyperEVM)The wallet: 0x, or a named wallet's handle
layerfilterelysium (Elysium); hyperevm (HyperEVM)hyperevm or elysium
statusfilter(optional)all (default), open (held now) or closed: the positions sent
limitfilter20Positions of the snapshot, by USD held, default 100 (1..500)
includeSpamfilter(optional)true: spam tokens too, and in the PnL totals

Subscribe

Elysium

{"op":"subscribe","channel":"pnl","filter":{"address":"0x876f1301aaa8452ceb98201cd4407fa9510a8181","layer":"elysium","limit":"20"}}

HyperEVM

{"op":"subscribe","channel":"pnl","filter":{"address":"0x5a69a60ca8a4d189855b33bd9f1bbe71095c1039","layer":"hyperevm","limit":"20"}}

Key: Authorization: Bearer $FEMTOS_KEY. Get a free key, or with no browser through agent onboarding.

Response fields

FieldTypeMeaning
snapshot: trueWalletPnlthe GET /v1/wallet/{address}/pnl?layer=<layer> answer (sort value): positions, cost basis, PnL, 1d / 7d / 30d / all totals, the block read
dataPnlUpdatethe positions of the wallet that a block the indexer commits changed (a swap credited to the wallet, a balance moved), whole rows to replace by `token` (any position the filter keeps, not only the snapshot's page), the tokens gone, and the totals. Never sent for a price move: each row carries heldWithCost and costOfHeldUsd, unrealized PnL = heldWithCost × price − costOfHeldUsd at the client's price (`<layer>.prices`): {layer, address, height, asOf, positions, removed, totals}
data.positions[]objectThe positions the block changed (a swap of the wallet, a balance moved), whole: replace each by `token`: {token, symbol, name, decimals, spam, spamReason, held, heldNative, heldWithCost, heldNoCost, priceUsd, valueUsd, …}
data.removedstring[]Positions gone (a token received, never swapped, no longer held)
data.totalsobjectTotals over every position of the wallet (not only the page): the last 24, 168, 720 UTC hours (1d, 7d, 30d) and all: {1d, 7d, 30d, all}
billingmediumthe snapshot a subscribe asks for counts as GET /v1/wallet/{address}/pnl (medium); every other frame by its bytes (1 credit per 48 KiB)

Related: Bridges & wallets

  • Cross-layer wallet GET /v1/wallet/{address} Elysium, HyperCore, HyperEVM
    One address (or a named wallet's handle) on HyperCore, HyperEVM and Elysium, plus its latest events.
  • Wallet stream WS wallet Elysium, HyperCore, HyperEVM
    Every event of the three layers touching one address.
  • Wallet list stream WS wallets Elysium, HyperCore, HyperEVM
    Every event of the three layers touching any of up to 100 addresses, in one subscription, each event tagged with its address.
  • HyperCore account GET /v1/hypercore/wallet/{address} HyperCore
    One address's HyperCore account: perp value and margin, positions, spot balances.
  • Wallet open orders GET /v1/hypercore/wallet/{address}/orders HyperCore
    One wallet's open orders: resting limit orders and trigger orders, on the main dex and every HIP-3 dex.
  • Wallet order history GET /v1/hypercore/wallet/{address}/orders/history HyperCore
    One wallet's orders that left the book, newest first: how (filled, canceled, rejected) and why, the size filled and its average price.
  • Wallet fills GET /v1/hypercore/wallet/{address}/fills HyperCore
    One wallet's HyperCore fills, newest first, with closed PnL, fees and the position before each.
  • Wallet fills per bar GET /v1/hypercore/wallet/{address}/fills/bars HyperCore
    One wallet's fills on one market summed per bar: buys and sells with their average price, and the position after each bar.
  • Wallet funding GET /v1/hypercore/wallet/{address}/funding HyperCore
    One wallet's funding payments, newest first: paid or received per perp and hour, with the position and the rate.
  • Swaps by wallet GET /v1/trades Elysium, HyperEVM
    Every swap a wallet sent (or a pool’s, a token’s), newest first, filterable by token, side, size and time.
  • Transfers by wallet GET /v1/transfers Elysium, HyperEVM
    ERC-20 transfers sent and received by a wallet, newest first, filterable by token, direction, size and time.
  • Wallet PnL GET /v1/wallet/{address}/pnl Elysium, HyperEVM
    Any wallet on HyperEVM: per token balance, cost basis, realized and unrealized PnL, with 1d / 7d / 30d / all totals and win rate.
  • Portfolio value history GET /v1/wallet/{address}/value Elysium, HyperEVM
    Any address on HyperEVM: its total USD value per 5 min (1d), hour (7d) or day (30d, all).
  • Wallet PnL curve GET /v1/hypercore/wallet/{address}/pnl HyperCore
    One HyperCore wallet's PnL per hour or day: realized, fees, funding, net and cumulative, and its account value.
  • Was I sandwiched? GET /v1/wallet/{address}/mev Elysium
    Every sandwich of a wallet’s swaps on Elysium: the bot, its two transactions, what the wallet lost. Free, no key.
  • Ledger stream WS hc.ledger HyperCore
    Deposits, withdrawals, transfers and other non-trade balance moves.
  • Bridge movements GET /v1/bridges Elysium, HyperCore, HyperEVM
    Matched HyperCore ↔ HyperEVM transfers with 24 h stats.
  • Bridge stream WS elysium.bridge | bridge.transfers Elysium, HyperCore, HyperEVM
    Each HyperCore ↔ HyperEVM transfer, initiated then completed.
  • Bridge movements stream WS bridges.recent Elysium, HyperCore, HyperEVM
    The GET /v1/bridges answer (movements newest first, 24 h stats), pushed on subscribe, then when a movement of the route changes state.
  • Bridge coverage GET /v1/bridges/coverage HyperCore, HyperEVM
    Every HyperCore ↔ HyperEVM leg since our data starts, paired with its other leg: matched share per direction and token, why the others are not, latency.

More

Agent guide (agents.md)llms.txtOpenAPIMCP serverGet an API keyChangelog