XRP-API Data Types

Warning: XRP-API is early alpha software. API methods and data formats are likely to change often, in ways that break backwards compatibility.

The following data types are defined for this API:

Name Type Description
TransactionStatus Object (TransactionStatus) Transaction status returned immediately after submitting. If the transaction was submitted, tx_json.hash and engine_result will be included.
ApiDoc Object (ApiDoc) The requested apiDoc.
PaymentTransaction (PaymentTransaction)
TransactionID String (TransactionID) The identifying hash of a transaction.
ValidatedLedger Object (ValidatedLedger) Information about the fully-validated ledger with the highest sequence number (the most recent).
RippledServerInfo Object (RippledServerInfo)
ServerState String (ServerState) A string indicating to what extent the server is participating in the network. See Possible Server States for more details.
AccountData Object (AccountData) The raw AccountRoot object of the account, as stored in the XRP Ledger.
ErrorItem Object (ErrorItem)
Signed Transaction Object (Signed Transaction) A signed transaction.
Payment object and instructions Object (Payment object and instructions) Payment object (specification) and instructions on how to execute it.
Amount Object (Amount) An amount in the XRP Ledger.
Payment Object Object (Payment Object) A payment object (specification).
AccountInfo (AccountInfo)
Transaction Instructions Object (Transaction Instructions) Indicates how to execute a transaction. Complements the transaction specification.
RippleAPIError Object (RippleAPIError) A wrapper for one or more error messages that occurred when processing a request.
AccountTransactions Object (AccountTransactions)
Transaction Common Fields Object (Transaction Common Fields) The fields that are common to all transactions.
Currency String (Currency) A currency code that is valid in the XRP Ledger, or XRP for ledger's native currency.
AppliedTransaction (AppliedTransaction) An applied transaction contains the fields of the Transaction object as well as some additional fields.
ServerInfo (ServerInfo)
LastClose Object (LastClose) Information about the last time the server closed a ledger.
Address String (Address) The address of an XRP Ledger account.
Load Object (Load) (Admin only) Detailed information about the current load state of the server.
AccountSettings (AccountSettings)
PreparedPaymentTransaction (PreparedPaymentTransaction) A payment transaction with min_ledger and max_ledger fields.
LedgerIndex (LedgerIndex)