YieldRedemptionPrice (FIX tag 697)
YieldRedemptionPrice (tag 697) is a Price field defined in FIX 4.4. It appears in 17 message types, always optionally.
At a glance
- Tag
- 697
- Name
- YieldRedemptionPrice
- Datatype
- Price (float)
- Dialects
- FIX 4.4
- Messages
- 17
What the specification says
Price to which the yield has been calculated.
Descriptions are quoted from the FIX Orchestra sources under the Apache 2.0 licence.
A real message using tag 697
| Tag | Field | Wire value | Meaning |
|---|---|---|---|
| 8 | BeginString | FIX.4.4 | |
| 9 | BodyLength | 123 | |
| 35 | MsgType | D | Order – Single |
| 49 | SenderCompID | BOARTEAM | |
| 56 | TargetCompID | COUNTERPARTY | |
| 34 | MsgSeqNum | 2 | |
| 52 | SendingTime | 20240101-12:00:00.000 | |
| 11 | ClOrdID | ORD-10042 | |
| 54 | Side | 1 | Buy |
| 60 | TransactTime | 20240101-12:00:00.000 | |
| 40 | OrdType | 1 | Market |
| 697 | YieldRedemptionPrice | 1.09210 | |
| 10 | CheckSum | 050 |
Shown with | separators for readability. On the wire FIX uses SOH (0x01), an invisible control byte — and because BodyLength and CheckSum are computed over the actual bytes, the two forms have different checksums. Both are valid and both decode here.
Generated from the FIX 4.4 dictionary and verified at build time: it parses and validates with no issues. Open the decoder to try your own message.
Where tag 697 appears
Requiredness is a property of the message, not of the field: the same tag can be optional in one message and conditionally required in another.
| Message | MsgType | Requiredness | Where in the message |
|---|---|---|---|
| AllocationInstruction | J | Optional | inside the YieldData component |
| AllocationReport | AS | Optional | inside the YieldData component |
| Confirmation | AK | Optional | inside the YieldData component |
| CrossOrderCancelReplaceRequest | t | Optional | inside the YieldData component |
| ExecutionReport | 8 | Optional | inside the YieldData component |
| IOI | 6 | Optional | inside the YieldData component |
| NewOrderCross | s | Optional | inside the YieldData component |
| NewOrderList | E | Optional | inside ListOrdGrp › YieldData |
| NewOrderSingle | D | Optional | inside the YieldData component |
| OrderCancelReplaceRequest | G | Optional | inside the YieldData component |
| Quote | S | Optional | inside the YieldData component |
| QuoteRequest | R | Optional | inside QuotReqGrp › YieldData |
| QuoteRequestReject | AG | Optional | inside QuotReqRjctGrp › YieldData |
| QuoteResponse | AJ | Optional | inside the YieldData component |
| QuoteStatusReport | AI | Optional | inside the YieldData component |
| SecurityList | y | Optional | inside SecListGrp › YieldData |
| TradeCaptureReport | AE | Optional | inside the YieldData component |
Wire format
A decimal price. Precision is a venue convention, not a protocol rule, so compare the raw string when exactness matters. @boarteam/fix parses the value as a number and reports parse/invalid-float when it does not lex as one; the raw string is kept so precision and trailing zeros are never lost.
Read tag 697 in TypeScript
import { createFixEngine } from "@boarteam/fix";import { dictionary } from "@boarteam/fix-dict-fix44";const fix = createFixEngine(dictionary);const { message, issues } = fix.parse(raw);const field = message.fields[697];field?.name; // "YieldRedemptionPrice"field?.raw; // the verbatim wire stringfield?.value; // coerced to a numberOther Price fields
- 684LegOfferPx
- 681LegBidPx
- 679LegBenchmarkPrice
- 669LastParPx
- 730SettlPrice
- 662BenchmarkPrice
- 732UnderlyingSettlPrice
- 734PriorSettlPrice
- 651UnderlyingLastPx
- 646MktOfferPx
- 645MktBidPx
- 640Price2
- 637LegLastPx
- 631MidPx
- 612LegStrikePrice
- 799OrderAvgPx
- 810UnderlyingPx
- 566LegPrice
- 839PeggedPrice
- 845DiscretionPrice
- 860AvgParPx
- 861ReportedPx
- 867EventPx
- 882UnderlyingDirtyPrice
Decode this in your own code
The same engine that produced the decoded example above is an Apache-2.0 npm package with zero runtime dependencies. It runs in Node and in the browser, and parse() returns problems as data instead of throwing.
npm i @boarteam/fix @boarteam/fix-dict-fix44