API reference, Builder codes
Builder orders stream
Every status of the orders sent with one builder code as it happens, rejections and their reasons included. One frame per block with all its matching events.
- Elysium: not served
- HyperCore
- HyperEVM: not served
- Not on Elysium or HyperEVM: a channel of HyperCore only
WebSocket channel hc.builder.orders on wss://api.femtos.xyz/v1/ws
Parameters
| Param | In | Example or values | Meaning |
|---|---|---|---|
builder | filter | 0xb84168cf3be63c6b8dad05ff5d755e97432ff80b | Builder address (0x, as orders name it in `builder.b`), or a named wallet's handle |
coin | filter | (optional) | HyperCore market (BTC, @107, xyz:TSLA) |
user | filter | (optional) | Account: 0x address or a named wallet's handle |
status | filter | (empty), open, filled, canceled, triggered, badAloPxRejected | Order status (open, filled, canceled, triggered, badAloPxRejected…) |
Subscribe
{"op":"subscribe","channel":"hc.builder.orders","filter":{"builder":"0xb84168cf3be63c6b8dad05ff5d755e97432ff80b"}}Key: Authorization: Bearer $FEMTOS_KEY. Get a free key, or with no browser through agent onboarding.
Response fields
| Field | Type | Meaning |
|---|---|---|
snapshot: true | WsBuilderOrder[] | the builder's last 50 order statuses (matching the filter) seen since hl-flows started, oldest first |
data | WsBuilderOrder[] | each status of an order carrying the builder's code (placed, filled, canceled, triggered, every rejection and its reason) with the fee rate it charges, the block it happens: one frame per HyperCore block, `data` the block's matching events in order (a block with none sends nothing): {block, eventIdx, time, user, entity, status, coin, side, oid, orderType, tif, limitPx, …} |
data[].status | string | Status as the node writes it: open, filled, canceled, triggered, badAloPxRejected… |
data[].feeTenthsBp | int | Builder fee the order charges, in tenths of a basis point (10 = 0.01 %) |
latency_ms.source_to_sent | int | block → sent by the server |
batch | "block" | every live frame: one block, `data` its matching events |
Related: Builder codes
- Builder leaderboard GET /v1/hypercore/builders HyperCore
Every builder code ranked by fees, volume, users or orders, over 24 h to all time. - Builder GET /v1/hypercore/builders/{builder} HyperCore
One builder code: totals and rank, day by day, per market, order outcomes and fee rates. - Builder orders GET /v1/hypercore/builders/{builder}/orders HyperCore
Every status of the orders sent with one builder code, rejections and their reasons included. - Builder fills GET /v1/hypercore/builders/{builder}/fills HyperCore
Every fill of one builder code, with its builder fee, oid, tid and hash. - Builder fills stream WS hc.builder.fills HyperCore
Every fill of one builder code as it happens, with its builder fee: the rows of the builder fills route, pushed per block. One frame per block with all its matching events.
More
- This page as Markdown
- The whole API reference
- What HyperCore serves
- The whole API in one Markdown file
- OpenAPI 3.1 document
Agent guide (agents.md)llms.txtOpenAPIMCP serverGet an API keyChangelog