com.xeiam.xchange.btce.v3

Interface BTCEAuthenticated

All Superinterfaces:

BTCE

public interface BTCEAuthenticated
extends BTCE

Author:

Matija Mazi

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BTCEAuthenticated.SortOrder

Method Summary

Modifier and Type	Method and Description
BTCEOpenOrdersReturn	ActiveOrders(String apiKey, si.mazi.rescu.ParamsDigest signer, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, String pair) None of the parameters are obligatory (ie.
BTCECancelOrderReturn	CancelOrder(String apiKey, si.mazi.rescu.ParamsDigest signer, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, Long orderId)
BTCEAccountInfoReturn	getInfo(String apiKey, si.mazi.rescu.ParamsDigest signer, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, Long from, Long count, Long fromId, Long endId, BTCEAuthenticated.SortOrder order, Long since, Long end)
BTCEPlaceOrderReturn	Trade(String apiKey, si.mazi.rescu.ParamsDigest signer, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, String pair, BTCEOrder.Type type, BigDecimal rate, BigDecimal amount) All parameters are obligatory (ie.
BTCETradeHistoryReturn	TradeHistory(String apiKey, si.mazi.rescu.ParamsDigest signer, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, Long from, Long count, Long fromId, Long endId, BTCEAuthenticated.SortOrder order, Long since, Long end, String pair) All parameters are nullable
BTCETransHistoryReturn	TransHistory(String apiKey, si.mazi.rescu.ParamsDigest signer, si.mazi.rescu.SynchronizedValueFactory<Long> nonce, Long from, Long count, Long fromId, Long endId, BTCEAuthenticated.SortOrder order, Long since, Long end) POST to retrieve transaction history from BTCE exchange.

Methods inherited from interface com.xeiam.xchange.btce.v3.BTCE

getDepth, getInfo, getTicker, getTrades

Method Detail

getInfo

BTCEAccountInfoReturn getInfo(@HeaderParam(value="Key")
                              String apiKey,
                              @HeaderParam(value="Sign")
                              si.mazi.rescu.ParamsDigest signer,
                              si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                              Long from,
                              Long count,
                              Long fromId,
                              Long endId,
                              BTCEAuthenticated.SortOrder order,
                              Long since,
                              Long end)
                       throws IOException

Parameters:

from - The ID of the transaction to start displaying with; default 0

count - The number of transactions for displaying default 1000

fromId - The ID of the transaction to start displaying with default 0

endId - The ID of the transaction to finish displaying with default +inf

order - sorting ASC or DESC default DESC

since - When to start displaying? UNIX time default 0

end - When to finish displaying? UNIX time default +inf

Returns:

{success=1, return={funds={usd=0, rur=0, eur=0, btc=0.1, ltc=0, nmc=0}, rights={info=1, trade=1, withdraw=1}, transaction_count=1, open_orders=0, server_time=1357678428}}

Throws:

IOException

ActiveOrders

BTCEOpenOrdersReturn ActiveOrders(@HeaderParam(value="Key")
                                  String apiKey,
                                  @HeaderParam(value="Sign")
                                  si.mazi.rescu.ParamsDigest signer,
                                  si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                  String pair)
                           throws IOException

None of the parameters are obligatory (ie. all are nullable). Use this method instead of OrderList, which is deprecated.

Parameters:

pair - the pair to display the orders eg. btc_usd (default: all pairs)

Throws:

IOException

Trade

BTCEPlaceOrderReturn Trade(@HeaderParam(value="Key")
                           String apiKey,
                           @HeaderParam(value="Sign")
                           si.mazi.rescu.ParamsDigest signer,
                           si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                           String pair,
                           BTCEOrder.Type type,
                           BigDecimal rate,
                           BigDecimal amount)
                    throws IOException

All parameters are obligatory (ie. none may be null).

Parameters:

pair - pair, eg. btc_usd

type - The transaction type (buy or sell)

rate - The price to buy/sell

amount - The amount which is necessary to buy/sell

Throws:

IOException

CancelOrder

BTCECancelOrderReturn CancelOrder(@HeaderParam(value="Key")
                                  String apiKey,
                                  @HeaderParam(value="Sign")
                                  si.mazi.rescu.ParamsDigest signer,
                                  si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                  Long orderId)
                           throws IOException

Throws:

IOException

TradeHistory

BTCETradeHistoryReturn TradeHistory(@HeaderParam(value="Key")
                                    String apiKey,
                                    @HeaderParam(value="Sign")
                                    si.mazi.rescu.ParamsDigest signer,
                                    si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                    Long from,
                                    Long count,
                                    Long fromId,
                                    Long endId,
                                    BTCEAuthenticated.SortOrder order,
                                    Long since,
                                    Long end,
                                    String pair)
                             throws IOException

All parameters are nullable

Parameters:

from - The number of the transactions to start displaying with; default 0

count - The number of transactions for displaying; default 1000

fromId - The ID of the transaction to start displaying with; default 0

endId - The ID of the transaction to finish displaying with; default +inf

order - sorting ASC or DESC; default DESC

since - When to start displaying; UNIX time default 0

end - When to finish displaying; UNIX time default +inf

pair - The pair to show the transaction; example btc_usd; all pairs

Returns:

{success=1, return={tradeId={pair=btc_usd, type=sell, amount=1, rate=1, orderId=1234, timestamp=1234}}}

Throws:

IOException

TransHistory

BTCETransHistoryReturn TransHistory(@HeaderParam(value="Key")
                                    String apiKey,
                                    @HeaderParam(value="Sign")
                                    si.mazi.rescu.ParamsDigest signer,
                                    si.mazi.rescu.SynchronizedValueFactory<Long> nonce,
                                    Long from,
                                    Long count,
                                    Long fromId,
                                    Long endId,
                                    BTCEAuthenticated.SortOrder order,
                                    Long since,
                                    Long end)
                             throws IOException

POST to retrieve transaction history from BTCE exchange. All parameters are nullable

Parameters:

from - The number of the transactions to start displaying with; default 0

count - The number of transactions for displaying; default 1000

fromId - The ID of the transaction to start displaying with; default 0

endId - The ID of the transaction to finish displaying with; default +inf

order - sorting ASC or DESC; default DESC

since - When to start displaying; UNIX time default 0

end - When to finish displaying; UNIX time default +inf

Returns:

JSON like {success=1, return={tradeId={type=sell, amount=1.00000000, currency="BTC", status=2, description="BTC Payment", timestamp=1234}}}

Throws:

IOException