Namespace Xrpl.Models.Methods

Classes

AccountChannels

The expected response from an AccountChannelsRequest .

The account_channels method returns information about an account's Payment Channels.
This includes only channels where the specified account is the channel's source, not the destination.
(A channel's "source" and "owner" are the same.)
All information retrieved is relative to a particular version of the ledger.
Returns an AccountChannels.

AccountCurrencies

The expected response from an AccountCurrenciesRequest.

AccountCurrenciesRequest

The account_currencies command retrieves a list of currencies that an account can send or receive, based on its trust lines. Expects an AccountCurrencies

AccountInfo

Response expected from an AccountInfoRequest.

AccountInfoRequest

The account_info command retrieves information about an account, its activity, and its XRP balance.
All information retrieved is relative to a particular version of the ledger. Returns an AccountInfo.

AccountingStateInfo

AccountingStateSummary

A map of various server states with information about the time the server spends in each.
This can be useful for tracking the long-term health of your server's connectivity to the network.

AccountLines

Response expected from an AccountLinesRequest.

AccountLinesRequest

The account_lines method returns information about an account's trust lines, including balances in all non-XRP currencies and assets.
All information retrieved is relative to a particular version of the ledger.
Expects an AccountLines.

AccountNFTs

Response expected from an AccountNFTsRequest.

AccountNFTsRequest

The account_nfts method retrieves all of the NFTs currently owned by the specified account.

AccountObjects

Response expected from an AccountObjectsRequest.

AccountObjectsRequest

The account_objects command returns the raw ledger format for all objects owned by an account.
For a higher-level view of an account's trust lines and balances, see the account_lines method instead.
Expects a response in the form of an AccountObjects.

AccountOffers

Response expected from an form an AccountOffersRequest.

AccountOffersRequest

The account_offers method retrieves a list of offers made by a given account that are outstanding as of a particular ledger version.
Expects a response in the form of a AccountOffers.

AccountTransaction

Information about each queued transaction from address.

AccountTransactions

Expected response from an AccountTransactionsRequest.

AccountTransactionsRequest

The account_tx method retrieves a list of transactions that involved the specified account.
Expects a response in the form of a AccountTransactions.

BaseLedgerRequest

BookCurrency

Order book currency

BookOffersRequest

The book_offers method retrieves a list of offers, also known as the order.
Book, between two currencies.
Returns an BookOffers.

Channel

Payment channel owned by account. https://xrpl.org/account_channels.html

ChannelAuthorizeRequest

The channel_authorize method creates a signature that can be used to redeem a specific amount of XRP from a payment channel.
The request must specify exactly one of secret, seed, seed_hex, or passphrase. *** Warning: Do not send secret keys to untrusted servers or through unsecured network connections. ***
(This includes the secret, seed, seed_hex, or passphrase fields of this request.))
You should only use this method on a secure, encrypted network connection to a server you run or fully trust with your funds.
Otherwise, eavesdroppers could use your secret key to sign claims and take all the money from this payment channel and anything else using the same key pair.
See Set Up Secure Signing for instructions.

ChannelVerifyRequest

The channel_verify method checks the validity of a signature that can be used to redeem a specific amount of XRP from a payment channel.
Expects a response in the form of a ChannelVerifyResponse.

Drops

The transaction cost

Fee

Response expected from a FeeRequest.

FeeRequest

The fee command reports the current state of the open-ledger requirements for the transaction cost.
This requires the FeeEscalation amendment to be enabled.
Expects a response in the form of a Fee.

GatewayBalances

Expected response from a GatewayBalancesRequest.

GatewayBalancesRequest

The gateway_balances command calculates the total balances issued by a given account, optionally excluding amounts held by operational addresses.
Expects a response in the form of a GatewayBalances.

Info

JobType

(Admin only) Detailed information about the current load state of the server.

LastClose

Information about the last time the server closed a ledger, including the amount of time it took to reach a consensus and the number of trusted validators participating.

LedgerClosedRequest

The ledger_closed method returns the unique identifiers of the most recently closed ledger.
Expects a response in the form of a LOBaseLedger.

LedgerCurrentRequest

The ledger_current method returns the unique identifiers of the current in-progress ledger.
Expects a response in the form of a LOLedgerCurrentIndex

LedgerDataRequest

The ledger_data method retrieves contents of the specified ledger.
You can iterate through several calls to retrieve the entire contents of a single ledger version.

LedgerEntryRequest

The ledger_entry method returns a single ledger object from the XRP Ledger in its raw format.
Expects a response in the form of a LOLedgerEntry.

LedgerRequest

Retrieve information about the public ledger.
Expects a response in the form.

Levels

required transaction cost level

Load

(Admin only) Detailed information about the current load state of the server.

NFT

One NFToken that might be returned from an AccountNFTsRequest. https://xrpl.org/account_nfts.html#account_nfts

NFTBuyOffers

Response expected from an NFTBuyOffersRequest ..

NFTBuyOffersRequest

The nft_buy_offers method retrieves all of buy offers for the specified NFToken.

NFTOffer

NFTSellOffers

Response expected from an NFTSellOffersRequest .

NFTSellOffersRequest

The nft_sell_offers method retrieves all of sell offers for the specified NFToken.

NoRippleCheck

Response expected by a NoRippleCheckRequest .

NoRippleCheckRequest

The noripple_check command provides a quick way to check the status of th default ripple field for an account and the No Ripple flag of its trust lines, compared with the recommended settings.
Expects a response in the form of an {@link NoRippleCheckResponse}.

Offer

offer made by account that is outstanding as of the requested ledger version.

Path

A path set is an array.
Each member of the path set is another array that represents an individual path.
Each member of a path is an object that specifies the step.

PingRequest

The ping command returns an acknowledgement, so that clients can test the connection status and latency.
Expects a response in the form of a PingRequest.

QueueData

Information about queued transactions sent by account.
This information describes the state of the local rippled server, which may be different from other servers in the peer-to-peer XRP Ledger network.
Some fields may be omitted because the values are calculated "lazily" by the queuing mechanism.

RandomRequest

The random command provides a random number to be used as a source of entropy for random number generation by clients.
Expects a response in the form of a RandomResponse.

RippleRequest

RippleState

Object specifying the RippleState (trust line) object to retrieve.
The accounts and currency sub-fields are required to uniquely specify the rippleState entry to retrieve.

ServerInfo

ServerInfoRequest

The server_info command asks the server for a human-readable version of various information about the rippled server being queried.
Expects a response in the form of a {@link ServerInfoResponse}.

SubmitRequest

The submit method applies a transaction and sends it to the network to be confirmed and included in future ledgers.
Expects a response in the form of a Submit .

SubscribeBase

base subscribe / unsubscribe request fields

SubscribeBook

Defines the order book for monitoring updates

SubscribeRequest

The subscribe method requests periodic notifications from the server when certain events happen.
https://xrpl.org/subscribe.html

TakerAmount

TransactionSummary

TrustLine

Trust line objects.

TxRequest

The tx method retrieves information on a single transaction, by its identifying hash.
Expects a response in the form of a TxResponse.

UnsubscribeRequest

The unsubscribe command tells the server to stop sending messages for a particular subscription or set of subscriptions.
The parameters in the request are specified almost exactly like the parameters to the subscribe method, except that they are used to define which subscriptions to end instead. The rt_accounts and url parameters, and the rt_transactions stream name, are deprecated and may be removed without further notice.
The response follows the standard format, with a successful result containing no fields.
https://xrpl.org/unsubscribe.html

ValidatedLedger

Information about the most recent fully-validated ledger.

Enums

LedgerEntryRequestType

RoleType

Whether the address refers to a gateway or user.
Recommendations depend on the role of the account.
Issuers must have Default Ripple enabled and must disable No Ripple on all trust lines.
Users should have Default Ripple disabled, and should enable No Ripple on all trust lines.

ServerState

Depending on how the rippled server is configured, how long it has been running, and other factors, a server may be participating in the global XRP Ledger peer-to-peer network to different degrees.
This is represented as the server_state field in the responses to the server_info method and server_state method.
The possible responses follow a range of ascending interaction, with each later value superseding the previous one.
https://xrpl.org/rippled-server-states.html