Developers menu
Developers / LIVE / Webhook events / order
Markdown copyorder
Sent when a new order in today's SPX ledger matches one of your order rules.
This event serves
Plan: ORDERS. Free on every finished session. Today's ledger, live, and the live POSITIONS check are the ORDERS plan. Pricing. Turn it on: ORDERS, RULES in the terminal; the alert goes where your level alerts go.
When it is sent
- Today's ledger is read every five seconds in session; a new order that matches a rule that is on goes out once.
- At most thirty order alerts an hour per account.
Payload
| Field | Meaning | Unit |
|---|---|---|
| version1 | Payload version, 1. | |
| idstring | Event id: the order's, the same for every account. | |
| type"order" | order. | |
| symbolstring | SPX. | |
| tsstring | When it was found, ISO 8601 in New York time. | |
| daystring | The ET trading day. | |
| ruleobject | The rule that matched. | |
| rule.idstring | The rule's id. | |
| rule.namestring | Its name. | |
| orderobject | The order, as the ledger has it. | |
| order.idstring | The order's id in the session. | |
| order.timestring | null | When it printed, ET. | |
| order.structurestring | The structure, in words. | |
| order.legsarray | The legs. | |
| order.legs[].strikenumber | Strike. | |
| order.legs[].rightstring | C or P. | |
| order.expirystring | null | The expiry carrying most of its gamma. | |
| order.expiry_bucketstring | null | The expiry bucket the rules read. | |
| order.sizenumber | null | Contracts. | |
| order.premium_usdnumber | null | Net premium. | USD |
| order.flip_pointsnumber | null | Points from the flip at that minute. | index points |
| order.flip_sideabove | below | null | Its side of the flip. | |
| order.wall_pointsnumber | null | Points from the nearest wall. | index points |
| order.strike_share_pctnumber | null | Its share of its strike's volume, percent. | |
| order.open_interestarray | null | The legs' morning open interest. | |
| textstring | The sentence Telegram and push show. |
Delivery
| Answer | Any 2xx within 3 seconds. Redirects are not followed. |
| Retries | No answer, a 429 or a 5xx: tried again after 1 s and 4 s, three tries in all, the same id each time. |
| Switched off | After 10 failed events in a row; the account page shows why. Saving the address switches it on again. |
| Volume | Up to 30 events a minute per account; past that they are dropped and counted on the account page. |
| Test | type: "test", from Send test |
| Log | The last delivery (time, status, tries) on the account page. |
Verify every request before reading it: Webhooks: verify the signature.
Related events
flip_cross · wall_break · regime_change · wall_move · flip_move · level_near · price_alert · level_line · test
Measurements of dealer positioning, never a forecast or a trade call. This page is built from FirmTape's public contract, the same files the OpenAPI document is built from; the tests hold them against the route code. Markdown: /docs/developers/live/events/order.md.