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