org.oxerr.okcoin.rest

Interface OKCoin

public interface OKCoin

RESTful API.

Method Summary

Modifier and Type	Method and Description
BatchTradeResult	batchTrade(String apiKey, String symbol, Type type, String ordersData, si.mazi.rescu.ParamsDigest sign) Batch trade.
BorrowResult	borrowMoney(String apiKey, String symbol, String days, BigDecimal amount, BigDecimal rate, si.mazi.rescu.ParamsDigest sign) Request borrow.
BorrowResult	cancelBorrow(String apiKey, String symbol, long borrowId, si.mazi.rescu.ParamsDigest sign) Cancel borrow order.
CancelOrderResult	cancelOrder(String apiKey, String symbol, String orderId, si.mazi.rescu.ParamsDigest sign) Cancel orders.
Withdrawal	cancelWithdraw(String apiKey, String symbol, long withdrawId, si.mazi.rescu.ParamsDigest sign) Withdrawal Cancellation Request.
AccountRecords	getAccountRecords(String apiKey, String symbol, int type, int currentPage, int pageLength, si.mazi.rescu.ParamsDigest sign) Get user deposits or withdraw Records.
BorrowOrderInfo	getBorrowOrderInfo(String apiKey, long borrowId, si.mazi.rescu.ParamsDigest sign) Get borrowing order info.
BorrowsInfo	getBorrowsInfo(String apiKey, String symbol, si.mazi.rescu.ParamsDigest sign) Get user borrow information.
CandlestickChart	getCandlestickChart(String symbol, String type, Integer size, Long since) Get BTC/LTC candlestick data.
Depth	getDepth(String symbol, Integer size, Integer merge) Get market depth.
LendDepth	getLendDepth(String symbol) Get top 10 lending entries.
OrderResult	getOrder(String apiKey, String symbol, long orderId, si.mazi.rescu.ParamsDigest sign) Get order info.
OrderFee	getOrderFee(String apiKey, String symbol, long orderId, si.mazi.rescu.ParamsDigest sign) Query fee.
OrderHistory	getOrderHistory(String apiKey, String symbol, int status, int currentPage, int pageLength, si.mazi.rescu.ParamsDigest sign) Returns the most recent 7 days orders.
OrderResult	getOrders(String apiKey, String symbol, int type, String orderId, si.mazi.rescu.ParamsDigest sign) Get order information in batch.
TickerResponse	getTicker(String symbol) Get price ticker.
Trade[]	getTradeHistory(String apiKey, String symbol, Long since, si.mazi.rescu.ParamsDigest sign) Get Trade History (Not for Personal).
Trade[]	getTrades(String symbol, Long since) Get trade history.
UnrepaymentsInfo	getUnrepaymentsInfo(String apiKey, String symbol, int currentPage, int pageLength, si.mazi.rescu.ParamsDigest sign) Get debt list.
UserInfo	getUserInfo(String apiKey, si.mazi.rescu.ParamsDigest sign) Get user account info.
BorrowResult	repay(String apiKey, long borrowId, si.mazi.rescu.ParamsDigest sign) Pay off debt.
TradeResult	trade(String apiKey, String symbol, Type type, BigDecimal price, BigDecimal amount, si.mazi.rescu.ParamsDigest sign) Place order.
Withdrawal	withdraw(String apiKey, String symbol, BigDecimal chargeFee, String tradePassword, String withdrawAddress, BigDecimal withdrawAmount, si.mazi.rescu.ParamsDigest sign) BTC/LTC Withdraw.

Method Detail

getTicker

TickerResponse getTicker(String symbol)
                  throws IOException

Get price ticker.

Parameters:

symbol - the symbol: btc_cny, ltc_cny.

Returns:

price ticker.

Throws:

IOException - indicates I/O exception.

getDepth

Depth getDepth(String symbol,
               Integer size,
               Integer merge)
        throws IOException

Get market depth.

Parameters:

symbol - the symbol: btc_cny, ltc_cny.

size - must be between 1 - 200

merge - 1 (merge depth)

Returns:

market depth.

Throws:

IOException - indicates I/O exception.

getTrades

Trade[] getTrades(String symbol,
                  Long since)
           throws IOException

Get trade history.

Parameters:

symbol - the symbol: btc_cny, ltc_cny.

since - get 600 pieces of data starting from the given tid(optional).

Returns:

the trade history.

Throws:

IOException - indicates I/O exception.

getCandlestickChart

CandlestickChart getCandlestickChart(String symbol,
                                     String type,
                                     Integer size,
                                     Long since)
                              throws IOException

Get BTC/LTC candlestick data.

Parameters:

symbol - the symbol: btc_cny, ltc_cny.

type -

• 1min : 1 minute candlestick data
• 3min : 3 minutes candlestick data
• 5min : 5 minutes candlestick data
• 15min : 15 minutes candlestick data
• 30min : 30 minutes candlestick data
• 1day : 1 day candlestick data
• 3day : 3 days candlestick data
• 1week : 1 week candlestick data
• 1hour : 1 hour candlestick data
• 2hour : 2 hours candlestick data
• 4hour : 4 hours candlestick data
• 6hour : 6 hours candlestick data
• 12hour : 12 hours candlestick data

size - specify data size to be acquired.

since - timestamp(eg:1417536000000). data after the timestamp will be returned

Returns:

candlestick.

Throws:

IOException - indicates I/O exception.

getLendDepth

LendDepth getLendDepth(String symbol)
                throws OKCoinException,
                       IOException

Get top 10 lending entries.

Parameters:

symbol - the symbol, such as btc_cny, ltc_cny, cny.

Returns:

the top 10 lending entries.

Throws:

IOException - indicates I/O exception.

OKCoinException

getUserInfo

UserInfo getUserInfo(String apiKey,
                     si.mazi.rescu.ParamsDigest sign)
              throws OKCoinException,
                     IOException

Get user account info.

Parameters:

apiKey - API key of the user.

sign - signature of request parameters

Returns:

user account info.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

trade

TradeResult trade(String apiKey,
                  String symbol,
                  Type type,
                  BigDecimal price,
                  BigDecimal amount,
                  si.mazi.rescu.ParamsDigest sign)
           throws OKCoinException,
                  IOException

Place order.

Parameters:

apiKey - the API key of the user.

symbol - the symbol: btc_cny, ltc_cny.

type - order type: limit order(buy/sell) market order(buy_market/sell_market).

price - order price. For limit orders, the price must be between 0~1,000,000. IMPORTANT: for market buy orders, the price is to total amount you want to buy, and it must be higher than the current price of 0.01 BTC (minimum buying unit) or 0.1 LTC.

amount - order quantity. Must be higher than 0.01 for BTC, or 0.1 for LTC.

sign - signature of request parameters

Returns:

result: true means order placed successfully order_id: order ID of the newly placed order

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

getTradeHistory

Trade[] getTradeHistory(String apiKey,
                        String symbol,
                        Long since,
                        si.mazi.rescu.ParamsDigest sign)
                 throws OKCoinException,
                        IOException

Get Trade History (Not for Personal).

Parameters:

apiKey - the API key of the user.

symbol - the symbol: btc_cny, ltc_cny.

since - get 600 pieces of data starting from the given tid (Required).

sign - signature of request parameters.

Returns:

the trade history.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

batchTrade

BatchTradeResult batchTrade(String apiKey,
                            String symbol,
                            Type type,
                            String ordersData,
                            si.mazi.rescu.ParamsDigest sign)
                     throws OKCoinException,
                            IOException

Batch trade.

Parameters:

apiKey - the API key of the user.

symbol - the symbol: btc_cny, ltc_cny.

type - optional, order type for limit orders (buy/sell).

ordersData - JSON string Example: [{price:3,amount:5,type: 'sell'},{price:3,amount:3,type:'buy'},{price:3,amount:3}] max order number is 5，for 'price' and 'amount' parameter, refer to trade/API. Final order type is decided primarily by 'type' field within 'orders_data' and subsequently by 'type' field (if no 'type' is provided within 'orders_data' field)

sign - signature of request parameters.

Returns:

result: true indicates order successfully placed order_id: order ID Note: return true if any one order is placed successfully returned orders info and 'orders_data' are in same sequence if fail to place order: order_id is -1

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

cancelOrder

CancelOrderResult cancelOrder(String apiKey,
                              String symbol,
                              String orderId,
                              si.mazi.rescu.ParamsDigest sign)
                       throws OKCoinException,
                              IOException

Cancel orders.

Parameters:

apiKey - the API key of the user.

symbol - the symbol: btc_cny, ltc_cny.

orderId - order ID (multiple orders are separated by a comma ',', Max of 3 orders are allowed per request)

sign - signature of request parameters.

Returns:

result: request result (applicable to single order) order_id: order ID (applicable to single order) success: success order IDs (applicable to batch orders) error: failed order IDs (applicable to batch orders)

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

getOrder

OrderResult getOrder(String apiKey,
                     String symbol,
                     long orderId,
                     si.mazi.rescu.ParamsDigest sign)
              throws OKCoinException,
                     IOException

Get order info.

Parameters:

apiKey - the API key of the user.

symbol - the symbol: btc_cny, ltc_cny.

orderId - if order_id is -1, then return all unfilled orders, otherwise return the order specified

sign - signature of request parameters.

Returns:

the order with the specified order ID or all unfilled orders.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

getOrders

OrderResult getOrders(String apiKey,
                      String symbol,
                      int type,
                      String orderId,
                      si.mazi.rescu.ParamsDigest sign)
               throws OKCoinException,
                      IOException

Get order information in batch.

Parameters:

apiKey - the API key of the user.

symbol - the symbol: btc_cny, ltc_cny.

type - query type: 0 for unfilled (open) orders, 1 for filled orders

orderId - order ID (multiple orders are separated by ',', 50 orders at most are allowed per request).

sign - signature of request parameters

Returns:

order information.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

getOrderHistory

OrderHistory getOrderHistory(String apiKey,
                             String symbol,
                             int status,
                             int currentPage,
                             int pageLength,
                             si.mazi.rescu.ParamsDigest sign)
                      throws OKCoinException,
                             IOException

Returns the most recent 7 days orders.

Parameters:

apiKey - the API key of the user.

symbol - the symbol: btc_cny, ltc_cny.

status - query status: 0 for unfilled orders, 1 for filled orders.

currentPage - current page number.

pageLength - number of orders returned per page, maximum 200.

sign - signature of request parameters

Returns:

recent orders with specified parameters, only the most recent 7 days are returned.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

withdraw

Withdrawal withdraw(String apiKey,
                    String symbol,
                    BigDecimal chargeFee,
                    String tradePassword,
                    String withdrawAddress,
                    BigDecimal withdrawAmount,
                    si.mazi.rescu.ParamsDigest sign)
             throws OKCoinException,
                    IOException

BTC/LTC Withdraw.

Parameters:

apiKey - the API key of the suer.

symbol - the symbol: BTC, LTC.

chargeFee - network transaction fee. By default, fee is between 0.0001 - 0.01 for BTC, and 0.001 - 0.2 for LTC, transaction gets confirmed faster with higher fees. For withdraws to another OKCoin address, chargefee can be 0 and the withdraw will be 0 confirmation as well.

tradePassword - trade/admin password.

withdrawAddress - withdraw address.

withdrawAmount - withdraw amount in BTC or LTC.

sign - signature of request parameters.

Returns:

withdraw_id: withdrawal request ID result: true means request successful

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

cancelWithdraw

Withdrawal cancelWithdraw(String apiKey,
                          String symbol,
                          long withdrawId,
                          si.mazi.rescu.ParamsDigest sign)
                   throws OKCoinException,
                          IOException

Withdrawal Cancellation Request.

Parameters:

apiKey - the API key of the user.

symbol - the symbol: BTC, LTC.

withdrawId - withdrawal request ID.

sign - signature of request parameters.

Returns:

result: true for success, false for error withdraw_id: withdrawal request ID

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

getOrderFee

OrderFee getOrderFee(String apiKey,
                     String symbol,
                     long orderId,
                     si.mazi.rescu.ParamsDigest sign)
              throws OKCoinException,
                     IOException

Query fee.

Parameters:

apiKey - the API key of the user.

symbol - the symbol: btc_cny, ltc_cny.

orderId - the order ID.

sign - the signature of request parameters.

Returns:

the order fee.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

getBorrowsInfo

BorrowsInfo getBorrowsInfo(String apiKey,
                           String symbol,
                           si.mazi.rescu.ParamsDigest sign)
                    throws OKCoinException,
                           IOException

Get user borrow information.

Parameters:

apiKey - the API key of the user.

symbol - the symbol, such as btc_cny, ltc_cny, cny.

sign - signature of request parameters.

Returns:

the borrow information of the user.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

borrowMoney

BorrowResult borrowMoney(String apiKey,
                         String symbol,
                         String days,
                         BigDecimal amount,
                         BigDecimal rate,
                         si.mazi.rescu.ParamsDigest sign)
                  throws OKCoinException,
                         IOException

Request borrow.

Parameters:

apiKey - the API key of the user.

symbol - the symbol, such as btc_cny, ltc_cny, cny.

days - days of borrow: three, seven, fifteen, thirty, sixty, ninety.

amount - borrow amount.

rate - borrow rate [0.0001, 0.01].

sign - signature of request parameters.

Returns:

the borrow.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

cancelBorrow

BorrowResult cancelBorrow(String apiKey,
                          String symbol,
                          long borrowId,
                          si.mazi.rescu.ParamsDigest sign)
                   throws OKCoinException,
                          IOException

Cancel borrow order.

Parameters:

apiKey - the API key of the user.

symbol - the symbol, such as btc_cny, ltc_cny, cny.

borrowId - the borrow order ID.

sign - signature of request parameters.

Returns:

the cancelled borrow order.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

getBorrowOrderInfo

BorrowOrderInfo getBorrowOrderInfo(String apiKey,
                                   long borrowId,
                                   si.mazi.rescu.ParamsDigest sign)
                            throws OKCoinException,
                                   IOException

Get borrowing order info.

Parameters:

apiKey - the API key of the user.

borrowId - the borrow order ID.

sign - signature of request parameters.

Returns:

the borrowing order info.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

repay

BorrowResult repay(String apiKey,
                   long borrowId,
                   si.mazi.rescu.ParamsDigest sign)
            throws OKCoinException,
                   IOException

Pay off debt.

Parameters:

apiKey - the API key of the user.

borrowId - the borrow order ID.

sign - signature of request parameters.

Returns:

the borrowing order info.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

getUnrepaymentsInfo

UnrepaymentsInfo getUnrepaymentsInfo(String apiKey,
                                     String symbol,
                                     int currentPage,
                                     int pageLength,
                                     si.mazi.rescu.ParamsDigest sign)
                              throws OKCoinException,
                                     IOException

Get debt list.

Parameters:

apiKey - the API key of the user.

symbol - the symbol, such as btc_cny, ltc_cny, cny.

currentPage - the current page number.

pageLength - data entries number per page, maximum 50.

sign - signature of request parameters

Returns:

the debt list.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.

getAccountRecords

AccountRecords getAccountRecords(String apiKey,
                                 String symbol,
                                 int type,
                                 int currentPage,
                                 int pageLength,
                                 si.mazi.rescu.ParamsDigest sign)
                          throws OKCoinException,
                                 IOException

Get user deposits or withdraw Records.

Parameters:

apiKey - the API key of the user.

symbol - the symbol: btc_cny, ltc_cny, cny

type - 0: deposits, 1: withdraw.

currentPage - the current page number. 1 based.

pageLength - the data entries number per page, maximum 50.

sign - the signature of request parameters.

Returns:

user deposits or withdraw records.

Throws:

OKCoinException - indicates request failed.

IOException - indicates I/O exception.