Show / Hide Table of Contents

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
object
BookChange
Namespace: Xrpl.Models.Subscriptions
Assembly: Xrpl.dll
Syntax
public class BookChange

Properties

| Edit this page View Source

AssetA

Parsed currency for the first asset. For XRP returns IssuedCurrency with Currency="XRP"; for tokens parses issuer and currency code.

Declaration
[JsonIgnore]
public Common.IssuedCurrency AssetA { get; }
Property Value
Type Description
Common.IssuedCurrency
| Edit this page View Source

AssetB

Parsed currency for the second asset. For XRP returns IssuedCurrency with Currency="XRP"; for tokens parses issuer and currency code.

Declaration
[JsonIgnore]
public Common.IssuedCurrency AssetB { get; }
Property Value
Type Description
Common.IssuedCurrency
| Edit this page View Source

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
| Edit this page View Source

CurrencyA

Raw currency identifier for the first asset. Format: "XRP_drops" for XRP, or "issuer/currency_hex" for tokens.

Declaration
[JsonPropertyName("currency_a")]
public string CurrencyA { get; set; }
Property Value
Type Description
string
| Edit this page View Source

CurrencyB

Raw currency identifier for the second asset. Format: "XRP_drops" for XRP, or "issuer/currency_hex" for tokens.

Declaration
[JsonPropertyName("currency_b")]
public string CurrencyB { get; set; }
Property Value
Type Description
string
| Edit this page View Source

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
| Edit this page View Source

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
| Edit this page View Source

IsXrpB

True if the second asset is XRP (VolumeB is in drops).

Declaration
[JsonIgnore]
public bool IsXrpB { get; }
Property Value
Type Description
bool
| Edit this page View Source

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
| Edit this page View Source

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
| Edit this page View Source

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
| Edit this page View Source

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
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX