Package org.knowm.xchange.ripple
Interface RipplePublic
-
@Path("v1") @Produces("application/json") public interface RipplePublicReturns public information that is stored in the ledger - secret not needed. See https://github.com/ripple/ripple-rest for up-to-date documentation.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RippleAccountBalancesgetAccountBalances(String address)Returns the account balances for this address.RippleAccountSettingsgetAccountSettings(String address)Returns the account settings for this address.RippleOrderBookgetOrderBook(String address, String base, String counter, String limit)Returns the order book for this address and base/counter pair.RippleTransactionFeegetTransactionFee()Fetch the network transaction fee.RippleNotificationsnotifications(String address, Boolean excludeFailed, Boolean earliestFirst, Integer resultsPerPage, Integer page, Long startLedger, Long endLedger)Returns notifications for this address.RippleAccountOrdersopenAccountOrders(String address)Returns the account information for this address.RippleOrderTransactionorderTransaction(String address, String hash)Returns detailed information about this order transaction.RipplePaymentTransactionpaymentTransaction(String address, String hash)Returns detailed information about this payment transaction.
-
-
-
Method Detail
-
getOrderBook
@GET @Path("accounts/{address}/order_book/{base}/{counter}") RippleOrderBook getOrderBook(@PathParam("address") String address, @PathParam("base") String base, @PathParam("counter") String counter, @QueryParam("limit") String limit) throws IOException, RippleExceptionReturns the order book for this address and base/counter pair.- Throws:
IOExceptionRippleException
-
getAccountBalances
@GET @Path("accounts/{address}/balances") RippleAccountBalances getAccountBalances(@PathParam("address") String address) throws IOException, RippleExceptionReturns the account balances for this address. This is public information in the ledger (secret not needed).- Throws:
IOExceptionRippleException
-
getAccountSettings
@GET @Path("accounts/{address}/settings") RippleAccountSettings getAccountSettings(@PathParam("address") String address) throws IOException, RippleExceptionReturns the account settings for this address. This is public information in the ledger (secret not needed).- Throws:
IOExceptionRippleException
-
openAccountOrders
@GET @Path("accounts/{address}/orders") RippleAccountOrders openAccountOrders(@PathParam("address") String address) throws IOException, RippleExceptionReturns the account information for this address.- Throws:
IOExceptionRippleException
-
orderTransaction
@GET @Path("accounts/{address}/orders/{hash}") RippleOrderTransaction orderTransaction(@PathParam("address") String address, @PathParam("hash") String hash) throws IOException, RippleExceptionReturns detailed information about this order transaction.- Throws:
IOExceptionRippleException
-
paymentTransaction
@GET @Path("accounts/{address}/payments/{hash}") RipplePaymentTransaction paymentTransaction(@PathParam("address") String address, @PathParam("hash") String hash) throws IOException, RippleExceptionReturns detailed information about this payment transaction.- Throws:
IOExceptionRippleException
-
notifications
@GET @Path("accounts/{address}/notifications") RippleNotifications notifications(@PathParam("address") String address, @QueryParam("exclude_failed") Boolean excludeFailed, @QueryParam("earliest_first") Boolean earliestFirst, @QueryParam("results_per_page") Integer resultsPerPage, @QueryParam("page") Integer page, @QueryParam("start_ledger") Long startLedger, @QueryParam("end_ledger") Long endLedger) throws IOException, RippleExceptionReturns notifications for this address.- Throws:
IOExceptionRippleException
-
getTransactionFee
@GET @Path("transaction-fee") RippleTransactionFee getTransactionFee()Fetch the network transaction fee.
-
-