Developers menu

order

Sent when a new order in today's SPX ledger matches one of your order rules.

POSTyour https addressX-FirmTape-Event: order
Plan ORDERSPayload version 1Signed HMAC-SHA256Schema order.schema.json

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

FieldMeaningUnit
version1Payload version, 1.
idstringEvent id: the order's, the same for every account.
type"order"order.
symbolstringSPX.
tsstringWhen it was found, ISO 8601 in New York time.
daystringThe ET trading day.
ruleobjectThe rule that matched.
rule.idstringThe rule's id.
rule.namestringIts name.
orderobjectThe order, as the ledger has it.
order.idstringThe order's id in the session.
order.timestring | nullWhen it printed, ET.
order.structurestringThe structure, in words.
order.legsarrayThe legs.
order.legs[].strikenumberStrike.
order.legs[].rightstringC or P.
order.expirystring | nullThe expiry carrying most of its gamma.
order.expiry_bucketstring | nullThe expiry bucket the rules read.
order.sizenumber | nullContracts.
order.premium_usdnumber | nullNet premium.USD
order.flip_pointsnumber | nullPoints from the flip at that minute.index points
order.flip_sideabove | below | nullIts side of the flip.
order.wall_pointsnumber | nullPoints from the nearest wall.index points
order.strike_share_pctnumber | nullIts share of its strike's volume, percent.
order.open_interestarray | nullThe legs' morning open interest.
textstringThe sentence Telegram and push show.

Delivery

AnswerAny 2xx within 3 seconds. Redirects are not followed.
RetriesNo answer, a 429 or a 5xx: tried again after 1 s and 4 s, three tries in all, the same id each time.
Switched offAfter 10 failed events in a row; the account page shows why. Saving the address switches it on again.
VolumeUp to 30 events a minute per account; past that they are dropped and counted on the account page.
Testtype: "test", from Send test
LogThe last delivery (time, status, tries) on the account page.

Verify every request before reading it: Webhooks: verify the signature.

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.