org.knowm.xchange.ripple

Interface RipplePublic

@Path(value="v1")
 @Produces(value="application/json")
public interface RipplePublic

Returns 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

Modifier and Type	Method and Description
RippleAccountBalances	getAccountBalances(String address) Returns the account balances for this address.
RippleAccountSettings	getAccountSettings(String address) Returns the account settings for this address.
RippleOrderBook	getOrderBook(String address, String base, String counter, String limit) Returns the order book for this address and base/counter pair.
RippleTransactionFee	getTransactionFee() Fetch the network transaction fee.
RippleNotifications	notifications(String address, Boolean excludeFailed, Boolean earliestFirst, Integer resultsPerPage, Integer page, Long startLedger, Long endLedger) Returns notifications for this address.
RippleAccountOrders	openAccountOrders(String address) Returns the account information for this address.
RippleOrderTransaction	orderTransaction(String address, String hash) Returns detailed information about this order transaction.
RipplePaymentTransaction	paymentTransaction(String address, String hash) Returns detailed information about this payment transaction.

Method Detail

getOrderBook

@GET
 @Path(value="accounts/{address}/order_book/{base}/{counter}")
RippleOrderBook getOrderBook(@PathParam(value="address")
                                                                                                 String address,
                                                                                                 @PathParam(value="base")
                                                                                                 String base,
                                                                                                 @PathParam(value="counter")
                                                                                                 String counter,
                                                                                                 @QueryParam(value="limit")
                                                                                                 String limit)
                                                                                          throws IOException,
                                                                                                 RippleException

Returns the order book for this address and base/counter pair.

Throws:

IOException

RippleException

getAccountBalances

@GET
 @Path(value="accounts/{address}/balances")
RippleAccountBalances getAccountBalances(@PathParam(value="address")
                                                                                          String address)
                                                                                   throws IOException,
                                                                                          RippleException

Returns the account balances for this address. This is public information in the ledger (secret not needed).

Throws:

IOException

RippleException

getAccountSettings

@GET
 @Path(value="accounts/{address}/settings")
RippleAccountSettings getAccountSettings(@PathParam(value="address")
                                                                                          String address)
                                                                                   throws IOException,
                                                                                          RippleException

Returns the account settings for this address. This is public information in the ledger (secret not needed).

Throws:

IOException

RippleException

openAccountOrders

@GET
 @Path(value="accounts/{address}/orders")
RippleAccountOrders openAccountOrders(@PathParam(value="address")
                                                                                     String address)
                                                                              throws IOException,
                                                                                     RippleException

Returns the account information for this address.

Throws:

IOException

RippleException

orderTransaction

@GET
 @Path(value="accounts/{address}/orders/{hash}")
RippleOrderTransaction orderTransaction(@PathParam(value="address")
                                                                                              String address,
                                                                                              @PathParam(value="hash")
                                                                                              String hash)
                                                                                       throws IOException,
                                                                                              RippleException

Returns detailed information about this order transaction.

Throws:

IOException

RippleException

paymentTransaction

@GET
 @Path(value="accounts/{address}/payments/{hash}")
RipplePaymentTransaction paymentTransaction(@PathParam(value="address")
                                                                                                    String address,
                                                                                                    @PathParam(value="hash")
                                                                                                    String hash)
                                                                                             throws IOException,
                                                                                                    RippleException

Returns detailed information about this payment transaction.

Throws:

IOException

RippleException

notifications

@GET
 @Path(value="accounts/{address}/notifications")
RippleNotifications notifications(@PathParam(value="address")
                                                                                        String address,
                                                                                        @QueryParam(value="exclude_failed")
                                                                                        Boolean excludeFailed,
                                                                                        @QueryParam(value="earliest_first")
                                                                                        Boolean earliestFirst,
                                                                                        @QueryParam(value="results_per_page")
                                                                                        Integer resultsPerPage,
                                                                                        @QueryParam(value="page")
                                                                                        Integer page,
                                                                                        @QueryParam(value="start_ledger")
                                                                                        Long startLedger,
                                                                                        @QueryParam(value="end_ledger")
                                                                                        Long endLedger)
                                                                                 throws IOException,
                                                                                        RippleException

Returns notifications for this address.

Throws:

IOException

RippleException

getTransactionFee

@GET
 @Path(value="transaction-fee")
RippleTransactionFee getTransactionFee()

Fetch the network transaction fee.