com.bitoex.bitopro.java.client

Interface BitoProPublicClient

All Known Implementing Classes:

DefaultBitoProPublicClient

public interface BitoProPublicClient

Client for BitoPro Public API. Provides direct methods to access BitoPro Public API. Default implementation can be created via BitoProClientBuilder. All methods throw ApiException when server returns error. All parameter related errors will be thrown with BadArgumentException. Pair is in terms of base and quote and combined in the form of @{code ${base}_${quote}}.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BitoProPublicClient.BitoProPublicPairClient A pair specific BitoProPublicClient.

Method Summary

Modifier and Type	Method and Description
OrderBook	getOrderBook(String pair) Get order book for specific pair.
default BitoProPublicClient.BitoProPublicPairClient	getPairClient(String pair) Create convenient methods for specified pair.
Ticker	getTicker(String pair) Get ticker for specific pair.
List<Ticker>	getTickers() Get tickers for all pairs.
List<Trade>	getTrades(String pair) Get recent trades for specific pair.

Method Detail

getTicker

Ticker getTicker(String pair)
          throws IOException

Get ticker for specific pair.

Parameters:

pair - the pair to get ticker

Returns:

ticker for the pair

Throws:

IOException - when connection error occured while called the Rest API

getTickers

List<Ticker> getTickers()
                 throws IOException

Get tickers for all pairs.

Returns:

ticker for the pair

Throws:

IOException - when connection error occured while called the Rest API

getOrderBook

OrderBook getOrderBook(String pair)
                throws IOException

Get order book for specific pair.

Parameters:

pair - the pair to get order book

Returns:

order book for the pair

Throws:

IOException - when connection error occured while called the Rest API

getTrades

List<Trade> getTrades(String pair)
               throws IOException

Get recent trades for specific pair.

Parameters:

pair - the pair to get trades

Returns:

trades for the pair

Throws:

IOException - when connection error occured while called the Rest API

getPairClient

default BitoProPublicClient.BitoProPublicPairClient getPairClient(String pair)

Create convenient methods for specified pair. Save users from passing the same pair parameters.

Parameters:

pair - the pair to act on

Returns:

a BitoProPublicPairClient for specified pair