Skip to content

Public API Methods

Interact directly with an xahaud server using public API methods. These methods are not necessarily intended for general public use but are accessible to any client connected to the server.

MethodDescription
account_channelsList payment channels where the account is the channel source.
account_currenciesList currencies the account can send or receive.
account_infoRetrieve basic information about an account.
account_linesAccess trust line information for an account.
account_objectsRetrieve all ledger objects owned by an account.
account_offersView an account’s currency exchange offers.
account_txRetrieve transaction history for an account.
gateway_balancesCalculate total issued amounts for an account.
noripple_checkSuggest changes to an account’s Default Ripple and No Ripple settings.
MethodDescription
ledgerGet information about a specific ledger version.
ledger_closedRetrieve the most recently closed ledger version.
ledger_currentRetrieve the current working ledger version.
ledger_dataAccess raw ledger content.
ledger_entryRetrieve a specific element from a ledger version.
MethodDescription
submitSubmit a transaction to the network.
submit_multisignedSubmit a multi-signed transaction.
transaction_entryRetrieve details about a transaction in a specific ledger.
txRetrieve transaction information across all ledgers.
sign(Admin) Cryptographically sign a transaction.
sign_for(Admin) Contribute to a multi-signature.
MethodDescription
book_offersView offers for exchanging two currencies.
deposit_authorizedCheck if one account can send payments directly to another.
MethodDescription
channel_authorizeSign a claim for a payment channel
channel_verifyVerify a payment channel claim signature.
MethodDescription
subscribeListen for updates on a subject
unsubscribeStop receiving updates
MethodDescription
feeRetrieve information about transaction costs.
server_infoGet server status in human-readable format.
server_stateGet server status in machine-readable format.
manifestRetrieve public key details for a validator.
MethodDescription
jsonProxy for running commands with JSON parameters. (Commandline only.)
pingVerify server connectivity.
randomGenerate random numbers.