Class BookChange
Represents a single order book change in a validated ledger.
Volume and rate values are strings. When the corresponding asset is XRP,
values are in drops (1 XRP = 1,000,000 drops).
Rates (high, low, open, close) are expressed as CurrencyA per 1 unit of CurrencyB.
Inheritance
Namespace: Xrpl.Models.Subscriptions
Assembly: Xrpl.dll
Syntax
public class BookChange
Properties
| Edit this page View SourceAssetA
Parsed currency for the first asset. For XRP returns IssuedCurrency with Currency="XRP"; for tokens parses issuer and currency code; for an MPT carries MptIssuanceIdA.
Declaration
[JsonIgnore]
public Common.IssuedCurrency AssetA { get; }
Property Value
| Type | Description |
|---|---|
| Common.IssuedCurrency |
AssetB
Parsed currency for the second asset. For XRP returns IssuedCurrency with Currency="XRP"; for tokens parses issuer and currency code; for an MPT carries MptIssuanceIdB.
Declaration
[JsonIgnore]
public Common.IssuedCurrency AssetB { get; }
Property Value
| Type | Description |
|---|---|
| Common.IssuedCurrency |
Close
Closing exchange rate: CurrencyA per 1 CurrencyB (in drops when IsXrpA is true).
Declaration
[JsonPropertyName("close")]
public string Close { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
CurrencyA
Raw currency identifier for the first asset. Format: "XRP_drops" for XRP, or "issuer/currency" for tokens, the currency as rippled displays it (a three-character code, or 40-character hex). Absent when the asset is an MPT.
Declaration
[JsonPropertyName("currency_a")]
public string CurrencyA { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
CurrencyB
Raw currency identifier for the second asset, in the format of CurrencyA. Absent when the asset is an MPT.
Declaration
[JsonPropertyName("currency_b")]
public string CurrencyB { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Domain
The permissioned domain of the order book, for offers in a permissioned DEX.
Declaration
[JsonPropertyName("domain")]
public string Domain { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
High
High exchange rate: CurrencyA per 1 CurrencyB (in drops when IsXrpA is true).
Declaration
[JsonPropertyName("high")]
public string High { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
IsXrpA
True if the first asset is XRP (values for VolumeA and rates are in drops).
Declaration
[JsonIgnore]
public bool IsXrpA { get; }
Property Value
| Type | Description |
|---|---|
| bool |
IsXrpB
True if the second asset is XRP (VolumeB is in drops).
Declaration
[JsonIgnore]
public bool IsXrpB { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Low
Low exchange rate: CurrencyA per 1 CurrencyB (in drops when IsXrpA is true).
Declaration
[JsonPropertyName("low")]
public string Low { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
MptIssuanceIdA
The MPT issuance ID of the first asset, when it is an MPT; CurrencyA is then absent.
Declaration
[JsonPropertyName("mpt_issuance_id_a")]
public string MptIssuanceIdA { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
MptIssuanceIdB
The MPT issuance ID of the second asset, when it is an MPT; CurrencyB is then absent.
Declaration
[JsonPropertyName("mpt_issuance_id_b")]
public string MptIssuanceIdB { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Open
Opening exchange rate: CurrencyA per 1 CurrencyB (in drops when IsXrpA is true).
Declaration
[JsonPropertyName("open")]
public string Open { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
VolumeA
Volume of the first asset traded (in drops when IsXrpA is true).
Declaration
[JsonPropertyName("volume_a")]
public string VolumeA { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
VolumeB
Volume of the second asset traded (in drops when IsXrpB is true).
Declaration
[JsonPropertyName("volume_b")]
public string VolumeB { get; set; }
Property Value
| Type | Description |
|---|---|
| string |