XRP-API Data Types

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

The following data types are defined for this API:

Name Type Description
Address String(Address) The address of an XRP Ledger account.
Payment object and instructions Object(Payment object and instructions) Payment object (specification) and instructions on how to execute it.
TransactionID String(TransactionID) The identifying hash of a transaction.
LedgerIndex (LedgerIndex)
Load Object(Load) (Admin only) Detailed information about the current load state of the server.
Amount Object(Amount) An amount in the XRP Ledger.
ApiDoc Object(ApiDoc) The requested apiDoc.
ErrorItem Object(ErrorItem)
ServerInfo (ServerInfo)
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.
AccountTransactions Object(AccountTransactions)
AccountInfo (AccountInfo)
Transaction JSON Object(Transaction JSON) The complete transaction in rippled JSON format. If the transaction was submitted, get the transaction hash from here.
Transaction Instructions Object(Transaction Instructions) Indicates how to execute a transaction. Complements the transaction specification.
Currency String(Currency) A currency code that is valid in the XRP Ledger, or XRP for ledger's native currency.
RippleAPIError Object(RippleAPIError) A wrapper for one or more error messages that occurred when processing a request.
TransactionStatus Object(TransactionStatus) Transaction status. If the transaction was submitted, tx_json.hash and engine_result will be returned. Otherwise, they will be omitted.
ValidatedLedger Object(ValidatedLedger) Information about the fully-validated ledger with the highest sequence number (the most recent).
Payment Object Object(Payment Object) A payment object (specification).
AccountSettings (AccountSettings)
RippledServerInfo Object(RippledServerInfo)
LastClose Object(LastClose) Information about the last time the server closed a ledger.
Transaction Object(Transaction)