API reference, TWAPs

Running TWAPs stream

The GET /v1/hypercore/twaps answer (running TWAPs, their progress, the net TWAP pressure) of a market or an account, pushed on subscribe, then when one of its TWAPs starts, fills a slice or ends (whole, or as a JSON Patch).

  • Elysium: not served
  • HyperCore
  • HyperEVM: not served
  • Not on Elysium or HyperEVM: a channel of HyperCore only

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

Parameters

ParamInExample or valuesMeaning
coinfilterBTCHyperCore market (BTC, @107, xyz:TSLA)
userfilter(optional)Account: 0x address or a named wallet's handle
sortfilter(empty), remaining, newest, endingremaining (default), newest or ending
limitfilter(optional)TWAPs, default 200 (1..1000)

Subscribe

{"op":"subscribe","channel":"hc.twaps","filter":{"coin":"BTC"}}

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

Response fields

FieldTypeMeaning
snapshot: trueobjectthe full GET /v1/hypercore/twaps answer: the first frame, and any frame sent whole
patch: trueJsonPatchwith "patch": true on subscribe: the operations, in order, that turn the previous answer into this one

Related: TWAPs

  • Running TWAPs GET /v1/hypercore/twaps HyperCore
    Running TWAPs of a market or an account with their progress, and the net TWAP pressure per market.
  • TWAP history GET /v1/hypercore/twaps/history HyperCore
    Ended TWAPs of a market or an account, newest first: what executed, at what price, how they ended.

More

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