API reference · Stops & take-profits

Stop map

Open stop-loss and take-profit orders of one coin, bucketed by trigger price around the mark.

GET https://api.femtos.xyz/v1/hypercore/stops

Parameters

Param	In	Example or values	Meaning
`coin`	query	`BTC`	HyperCore coin: perp (BTC), HIP-3 (xyz:TSLA)
`buckets`	query	`40`	Most buckets (width rounded up to a round number); not with step
`step`	query	(optional)	Bucket width in price units, instead of buckets (at most 400 buckets)
`range_pct`	query	`10`	Half-width of the grid around the mark, percent, (0, 100]

curl -H "Authorization: Bearer $FEMTOS_KEY" "https://api.femtos.xyz/v1/hypercore/stops?coin=BTC&buckets=40&range_pct=10"

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

Field	Type	Meaning
`buckets[]`	object	Ascending price; empty when the mark is unknown: {pxLo, pxHi, count, notional, stop, takeProfit}
`buckets[].stop`	object	Open trigger orders of one kind, by side and execution: {sell, buy}
`totals`	object	Open trigger orders by kind: {count, notional, stop, takeProfit}
`below`	object	Under the grid: {count, notional}
`above`	object	Over the grid: {count, notional}
`markPx`	decimal \| null	Mark: last trade
`rangePct`	decimal	range_pct applied
`step`	decimal \| null	Bucket width
`asOf`	int \| null	Time of `height` (latest status of the open trigger-order table) (Unix ms); null before the table has one
`height`	int \| null	Head block of the layer the answer is cut at: every event up to it is counted (latest status of the open trigger-order table); null before the table has one
`positions`	object \| null	The perp positions that sized the whole-position orders: their cut (height, the node state rolled forward to it); null without any: {asOf, height, baseHeight, baseAsOf}

Stops stream WS hc.stops HyperCore
Every trigger order event: placed, triggered, canceled, and the order a trigger placed.
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.