API reference · Stops & take-profits

Stops stream

Every trigger order event: placed, triggered, canceled, and the order a trigger placed.

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

Parameters

Param	In	Example or values	Meaning
`coin`	filter	`BTC`	HyperCore market (BTC, @107, xyz:TSLA)
`user`	filter	(optional)	Account: 0x address or a named wallet's handle
`status`	filter	`(empty)`, `open`, `triggered`, `filled`, `canceled`	Status: open, triggered, canceled, filled…
`kind`	filter	`(empty)`, `stop`, `take_profit`	stop \| take_profit

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

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

Field	Type	Meaning
`snapshot: true`	HcStopEvent[]	last 50 trigger-order events
`data`	HcStopEvent	every status of a stop-loss / take-profit order (placed, triggered, canceled, rejected) and of the order its trigger places (filled, canceled: triggered true): the hc.orders fields + is_position_tpsl, kind, exec (market \| limit), triggered: {coin, side, px, sz, orig_sz, status, order_type, tif, oid, user, block, time, …}
`data.kind`	stop \| take_profit	Stop-loss or take-profit (from the order type)
`data.exec`	market \| limit	What the trigger places: a market or a limit order
`data.triggered`	boolean	true: the order a trigger placed (filled, canceled)

Stop map GET /v1/hypercore/stops HyperCore
Open stop-loss and take-profit orders of one coin, bucketed by trigger price around the mark.
Triggered stops GET /v1/hypercore/stops/triggered HyperCore
Stop-loss and take-profit orders that fired, newest first, with the fill they got.
Wallet stops GET /v1/hypercore/wallet/{address}/stops HyperCore
One wallet's open trigger orders, or with history=1 every status event of them.