com.bitoex.bitopro.java.client

Interface BitoProClient

All Known Implementing Classes:

DefaultBitoProClient

public interface BitoProClient

Client for BitoPro API. Provides direct methods to access BitoPro 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	BitoProClient.BitoProPairClient A pair specific BitoProClient.

Method Summary

Modifier and Type	Method and Description
Optional<OrderResponse>	cancelOrder(String pair, String orderId) Cancel an order.
OrderResponse	createLimitOrder(String pair, OrderAction action, BigDecimal price, BigDecimal amount) Place a limit price order.
OrderResponse	createMarketOrder(String pair, OrderAction action, BigDecimal totalAmount) Place a market order.
List<Balance>	getAccountBalances() Get account's balances.
Optional<Order>	getOrder(String pair, String orderId) Get order specified by pair and id.
List<Order>	getOrderHistory() Get the completed or cancelled orders.
PaginatedList<Order>	getOrders(String pair, boolean active, int page) Get orders for specified pair in paginated form.
default BitoProClient.BitoProPairClient	getPairClient(String pair) Create convenient methods for specified pair.

Method Detail

getAccountBalances

List<Balance> getAccountBalances()
                          throws IOException

Get account's balances.

Returns:

list of balances for each symbol

Throws:

IOException - when connection error occured while called the Rest API

createMarketOrder

OrderResponse createMarketOrder(String pair,
                                OrderAction action,
                                BigDecimal totalAmount)
                         throws IOException

Place a market order. If action is BUY, totalAmount is in terms of quote. If action is SELL, totalAmount is in terms of base.

Parameters:

pair - the pair to place order

action - OrderAction for the order, either BUY or SELL

totalAmount - total amount for the order

Returns:

OrderResponse with result of the order placed

Throws:

IOException - when connection error occured while called the Rest API

createLimitOrder

OrderResponse createLimitOrder(String pair,
                               OrderAction action,
                               BigDecimal price,
                               BigDecimal amount)
                        throws IOException

Place a limit price order.

Parameters:

pair - the pair to place order

action - OrderAction for the order, either BUY or SELL

price - price in terms of quote for the order

amount - amount in terms of quote for the order

Returns:

OrderResponse with result of the order placed

Throws:

IOException - when connection error occured while called the Rest API

cancelOrder

Optional<OrderResponse> cancelOrder(String pair,
                                    String orderId)
                             throws IOException

Cancel an order. If order id is not found, a com.bitoex.bitopro.java.exception.BadArgumentException is thrown.

Parameters:

pair - the pair to cancel order

orderId - id of the order to be cancelled

Returns:

OrderResponse with status of the order cancelled, if present

Throws:

IOException - when connection error occured while called the Rest API

getOrderHistory

List<Order> getOrderHistory()
                     throws IOException

Get the completed or cancelled orders.

Returns:

list of completed or cancelled orders

Throws:

IOException - when connection error occured while called the Rest API

See Also:

Order

getOrders

PaginatedList<Order> getOrders(String pair,
                               boolean active,
                               int page)
                        throws IOException

Get orders for specified pair in paginated form.

Parameters:

pair - the pair to get orders

active - whether to get active orders or not. Default: false

page - page number for the order list. Start from 1.

Returns:

the paginated list of orders

Throws:

IOException - when connection error occured while called the Rest API

See Also:

Order

getOrder

Optional<Order> getOrder(String pair,
                         String orderId)
                  throws IOException

Get order specified by pair and id.

Parameters:

pair - the pair to get order

orderId - id of the order

Returns:

specified order

Throws:

IOException - when connection error occured while called the Rest API

getPairClient

default BitoProClient.BitoProPairClient getPairClient(String pair)

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

Parameters:

pair - the pair to be acted on

Returns:

a BitoProPairClient for specified pair