Class OrderBookStream
When you subscribe to one or more order books with the books field, you get back any transactions that affect those order books. https://xrpl.org/subscribe.html#order-book-streams
Namespace: Xrpl.Models.Subscriptions
Assembly: Xrpl.dll
Syntax
public class OrderBookStream : BaseStream
Properties
| Edit this page View SourceEngineResult
String Transaction result code
Declaration
[JsonPropertyName("engine_result")]
public string EngineResult { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
EngineResultCode
Numeric transaction response code, if applicable.
Declaration
[JsonPropertyName("engine_result_code")]
public int EngineResultCode { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
EngineResultMessage
Human-readable explanation for the transaction response
Declaration
[JsonPropertyName("engine_result_message")]
public string EngineResultMessage { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Meta
(Validated transactions only) The transaction metadata, which shows the exact outcome of the transaction in detail.
Declaration
[JsonPropertyName("meta")]
public Meta Meta { get; set; }
Property Value
| Type | Description |
|---|---|
| Meta |
Status
Declaration
[JsonPropertyName("status")]
public string Status { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Transaction
The transaction from TxJson (API v2), else from TransactionJson (API v1); null when the event carries neither.
Declaration
[JsonIgnore]
public ITransactionResponse Transaction { get; }
Property Value
| Type | Description |
|---|---|
| ITransactionResponse |
Remarks
rippled moves the transaction from transaction to tx_json under API v2
(NetworkOPs.cpp transJson), so reading only the v1 member threw
System.NullReferenceException for every v2 event.
TransactionJson
The definition of the transaction in JSON format, as API v1 sends it.
Declaration
[JsonPropertyName("transaction")]
public object TransactionJson { get; set; }
Property Value
| Type | Description |
|---|---|
| object |
TxJson
The definition of the transaction in JSON format, as API v2 sends it.
Declaration
[JsonPropertyName("tx_json")]
public object TxJson { get; set; }
Property Value
| Type | Description |
|---|---|
| object |
Validated
If true, this transaction is included in a validated ledger and its outcome is final.
Responses from the transaction stream should always be validated.
Declaration
[JsonPropertyName("validated")]
public bool Validated { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |