API reference · Market data

Forming candle

The forming candle, pushed once per block where it changes.

WebSocket channel elysium.candles on wss://api.femtos.xyz/v1/ws · WebSocket channel hc.candles on wss://api.femtos.xyz/v1/ws · WebSocket channel hyperevm.candles on wss://api.femtos.xyz/v1/ws

Parameters

ParamInExample or valuesMeaning
pairfilter<pair> (Elysium); <evmPair> (HyperEVM)Pool key: the pool address, or <PoolManager>:<PoolId> (V4, PancakeSwap Infinity); any case (Elysium, HyperEVM)
tffilter1s, 15s, 1m, 5m, 15m, 1h, 4h, 1dCandle unit
coinfilterBTCHyperCore market: BTC, @107 (spot), xyz:TSLA (HIP-3) (HyperCore)

Subscribe

Elysium

{"op":"subscribe","channel":"elysium.candles","filter":{"pair":"<pair>","tf":"1m"}}

HyperCore

{"op":"subscribe","channel":"hc.candles","filter":{"coin":"BTC","tf":"1s"}}

HyperEVM

{"op":"subscribe","channel":"hyperevm.candles","filter":{"pair":"<evmPair>","tf":"1m"}}

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

Response fields

FieldTypeMeaning
snapshot: trueCandle[]last 300 candles at subscribe (Elysium, HyperEVM)
dataWsCandlethe forming candle, once per block where it changes: {t, o, h, l, c, v, vq, n, vUsd, mcUsd, usd, mcap, …} (Elysium, HyperCore)
snapshot: trueWsCandle[]last 300 candles at subscribe (HyperCore)
dataWsCandlethe forming candle: each candle that changed (while syncing: up to 50 per poll): {t, o, h, l, c, v, vq, n, vUsd, mcUsd, usd, mcap, …} (HyperEVM)

Related: Market data

  • Markets GET /v1/markets Elysium, HyperCore, HyperEVM
    Every tradable perp, spot, HIP-3 and outcome market with 24 h stats.
  • Candles GET /v1/candles Elysium, HyperCore, HyperEVM
    OHLCV of any HyperCore market down to 1 s, ascending, UTC-aligned.
  • Token candles GET /v1/candles Elysium, HyperCore, HyperEVM
    OHLCV of a token through its USDC market (a perp coin: the perp).
  • Trades GET /v1/trades Elysium, HyperCore, HyperEVM
    Latest fills of one market, newest first.
  • Trades stream WS elysium.trades · hc.trades · hyperevm.trades Elysium, HyperCore, HyperEVM
    All trades of one market as they happen: raced between our node and Hyperliquid's public feed, first copy sent, the other dropped.
  • Order book GET /v1/book HyperCore
    L2 book of one market with order counts, from our node.
  • Book stream WS hc.book HyperCore
    Full-depth book, then the levels each block changes.
  • Best bid / offer WS hc.bbo HyperCore
    Top of book of one market each block: raced between Hyperliquid's public feed and our node (newest block wins, our node corrects the same block).
  • Order updates WS hc.orders HyperCore
    Every order status change, filterable by coin, user and status.
  • Token prices GET /v1/prices Elysium, HyperCore, HyperEVM
    USD price of up to 100 tokens in one call, each with its source and provenance.
  • Price history GET /v1/prices/history Elysium, HyperCore, HyperEVM
    USD closes per unit of up to 25 tokens over a window, or the price of 100 tokens at one time (at=).
  • HYPE price WS prices.hype HyperCore
    HYPE from the Hyperliquid oracle, perp mark and exchanges.
  • Pool detail GET /v1/pools/{address} Elysium, HyperEVM
    One pool: dex, fee, tokens, liquidity in USD, depth, 5m to 24h activity, top LPs.
  • Liquidity events GET /v1/liquidity Elysium, HyperEVM
    Liquidity added to and removed from one pool, newest first.
  • Daily token volume GET /v1/volume Elysium, HyperEVM
    USD swap volume of a token per UTC day, both sides of every priced swap.

More

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