com.xeiam.xchange.service.polling.marketdata

Interface PollingMarketDataService

All Superinterfaces:

BasePollingService

All Known Implementing Classes:

ANXMarketDataService, BitbayMarketDataService, BitcoinAverageMarketDataService, BitcoinChartsMarketDataService, BitcoindeMarketDataService, BitcoiniumMarketDataService, BitcurexMarketDataService, BitfinexMarketDataService, BitKonanMarketDataService, BitMarketDataService, BitsoMarketDataService, BitstampMarketDataService, BittrexMarketDataService, BleutradeMarketDataService, Btc38MarketDataService, BTCCentralMarketDataService, BTCEMarketDataService, BTCTradeMarketDataService, BTERPollingMarketDataService, CampBXMarketDataService, CexIOMarketDataService, CleverCoinMarketDataService, CoinbaseExMarketDataService, CoinbaseMarketDataService, CoinmateMarketDataService, CointraderMarketDataService, CryptonitMarketDataService, CryptsyMarketDataService, CryptsyPublicMarketDataService, EmpoExMarketDataService, HitbtcMarketDataService, IndependentReserveMarketDataService, ItBitMarketDataService, JubiMarketDataService, KrakenMarketDataService, LakeBTCMarketDataService, LoyalbitMarketDataService, MercadoBitcoinMarketDataService, MeXBTMarketDataService, OERMarketDataService, OkCoinFuturesMarketDataService, OkCoinMarketDataService, PoloniexMarketDataService, QuoineMarketDataService, RippleMarketDataService, TaurusMarketDataService, TheRockMarketDataService, VircurexMarketDataService, VirtExMarketDataService, YacunaMarketDataService

public interface PollingMarketDataService
extends BasePollingService

Interface to provide the following to Exchange:

• Standard methods available to explore the market 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
OrderBook	getOrderBook(CurrencyPair currencyPair, Object... args) Get an order book representing the current offered exchange rates (market depth)
Ticker	getTicker(CurrencyPair currencyPair, Object... args) Get a ticker representing the current exchange rate
Trades	getTrades(CurrencyPair currencyPair, Object... args) Get the trades recently performed by the exchange

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

getExchangeSymbols

Method Detail

getTicker

Ticker getTicker(CurrencyPair currencyPair,
                 Object... args)
          throws ExchangeException,
                 NotAvailableFromExchangeException,
                 NotYetImplementedForExchangeException,
                 IOException

Get a ticker representing the current exchange rate

Parameters:

CurrencyPair - currencyPair (e.g. BTC/USD)

Returns:

The Ticker, 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

getOrderBook

OrderBook getOrderBook(CurrencyPair currencyPair,
                       Object... args)
                throws ExchangeException,
                       NotAvailableFromExchangeException,
                       NotYetImplementedForExchangeException,
                       IOException

Get an order book representing the current offered exchange rates (market depth)

Parameters:

CurrencyPair - currencyPair (e.g. BTC/USD)

args - Optional arguments. Exchange-specific

Returns:

The OrderBook, 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

getTrades

Trades getTrades(CurrencyPair currencyPair,
                 Object... args)
          throws ExchangeException,
                 NotAvailableFromExchangeException,
                 NotYetImplementedForExchangeException,
                 IOException

Get the trades recently performed by the exchange

Parameters:

CurrencyPair - currencyPair (e.g. BTC/USD)

args - Optional arguments. Exchange-specific

Returns:

The Trades, 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