com.xeiam.xchange.service.polling.account

Interface PollingAccountService

All Superinterfaces:

BasePollingService

All Known Implementing Classes:

ANXAccountService, BitcurexAccountService, BitfinexAccountService, BitMarketAccountService, BitsoAccountService, BitstampAccountService, BittrexAccountService, BleutradeAccountService, BTCEAccountService, BTCTradeAccountService, BTERPollingAccountService, CampBXAccountService, CexIOAccountService, CleverCoinAccountService, CoinbaseAccountService, CoinbaseExAccountService, CoinmateAccountService, CointraderAccountService, CryptsyAccountService, EmpoExAccountService, HitbtcAccountService, IndependentReserveAccountService, ItBitAccountService, KrakenAccountService, LakeBTCAccountService, LoyalbitAccountService, MercadoBitcoinAccountService, MeXBTAccountService, OkCoinAccountService, OkCoinFuturesAccountService, PoloniexAccountService, QuoineAccountService, RippleAccountService, TaurusAccountService, TheRockAccountService, VircurexAccountService

public interface PollingAccountService
extends BasePollingService

Interface to provide the following to Exchange:

• Standard methods available to explore send/receive account-related data

The implementation of this service is expected to be based on a client polling mechanism of some kind

Method Summary

Modifier and Type	Method and Description
AccountInfo	getAccountInfo() Get account info
String	requestDepositAddress(String currency, String... args) Request a digital currency address to fund this account.
String	withdrawFunds(String currency, BigDecimal amount, String address) Withdraw funds from this account.

Methods inherited from interface com.xeiam.xchange.service.polling.BasePollingService

getExchangeSymbols

Method Detail

getAccountInfo

AccountInfo getAccountInfo()
                    throws ExchangeException,
                           NotAvailableFromExchangeException,
                           NotYetImplementedForExchangeException,
                           IOException

Get account info

Returns:

the AccountInfo object, null if some sort of error occurred. Implementers should log the error.

Throws:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

NotAvailableFromExchangeException - - Indication that the exchange does not support the requested function or data

NotYetImplementedForExchangeException - - Indication that the exchange supports the requested function or data, but it has not yet been implemented

IOException - - Indication that a networking error occurred while fetching JSON data

withdrawFunds

String withdrawFunds(String currency,
                     BigDecimal amount,
                     String address)
              throws ExchangeException,
                     NotAvailableFromExchangeException,
                     NotYetImplementedForExchangeException,
                     IOException

Withdraw funds from this account. Allows to withdraw digital currency funds from the exchange account to an external address

Parameters:

currency - The currency to withdraw

amount - The amount to withdraw

address - The destination address

Returns:

The result of the withdrawal (usually a transaction ID)

Throws:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

NotAvailableFromExchangeException - - Indication that the exchange does not support the requested function or data

NotYetImplementedForExchangeException - - Indication that the exchange supports the requested function or data, but it has not yet been implemented

IOException - - Indication that a networking error occurred while fetching JSON data

requestDepositAddress

String requestDepositAddress(String currency,
                             String... args)
                      throws ExchangeException,
                             NotAvailableFromExchangeException,
                             NotYetImplementedForExchangeException,
                             IOException

Request a digital currency address to fund this account. Allows to fund the exchange account with digital currency from an external address

Parameters:

currency - The digital currency that corresponds to the desired deposit address.

arguments -

Returns:

the internal deposit address to send funds to

Throws:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

NotAvailableFromExchangeException - - Indication that the exchange does not support the requested function or data

NotYetImplementedForExchangeException - - Indication that the exchange supports the requested function or data, but it has not yet been implemented

IOException - - Indication that a networking error occurred while fetching JSON data