com.bitoex.bitopro.java.client

Class BitoProClient.BitoProPairClient

java.lang.Object

com.bitoex.bitopro.java.client.BitoProClient.BitoProPairClient

Enclosing interface:

BitoProClient

public static class BitoProClient.BitoProPairClient
extends Object

A pair specific BitoProClient.

Method Summary

Modifier and Type	Method and Description
Optional<OrderResponse>	cancelOrder(String orderId) Cancel an order.
OrderResponse	createLimitOrder(OrderAction action, BigDecimal price, BigDecimal amount) Place a limit price order.
OrderResponse	createMarketOrder(OrderAction action, BigDecimal totalAmount) Place a market order.
Optional<Order>	getOrder(String orderId) Get order specified by pair and id.
PaginatedList<Order>	getOrders(boolean active, int page) Get orders for specified pair in paginated form.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createMarketOrder

public OrderResponse createMarketOrder(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:

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

See Also:

BitoProClient.createMarketOrder(String, OrderAction, BigDecimal)

createLimitOrder

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

Place a limit price order.

Parameters:

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

See Also:

BitoProClient.createLimitOrder(String, OrderAction, BigDecimal, BigDecimal)

cancelOrder

public Optional<OrderResponse> cancelOrder(String orderId)
                                    throws IOException

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

Parameters:

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

See Also:

BitoProClient.cancelOrder(String, String)

getOrders

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

Get orders for specified pair in paginated form.

Parameters:

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

page - page number for the order list. Default: 1

Returns:

the paginated list of orders

Throws:

IOException - when connection error occured while called the Rest API

See Also:

Order, BitoProClient.getOrders(String, boolean, int)

getOrder

public Optional<Order> getOrder(String orderId)
                         throws IOException

Get order specified by pair and id.

Parameters:

orderId - id of the order

Returns:

specified order

Throws:

IOException - when connection error occured while called the Rest API

See Also:

Order, BitoProClient.getOrder(String, String)