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