Package cryptos.historical

Class HistoricalData

java.lang.Object

cryptos.historical.HistoricalData

All Implemented Interfaces:

CryptoBase, CryptoBaseExchange, HistoricalBase

Direct Known Subclasses:

HistoricalDaily, HistoricalHourly, HistoricalMinute

public abstract class HistoricalData
extends java.lang.Object
implements CryptoBaseExchange, HistoricalBase

Historical data super/factory class for HistoricalDaily, HistoricalHourly, and HistoricalMinute.

Since:

Cryptos4J v1.0

Author:

Matt - mcfadd

See Also:

TimestampedData

Method Summary

Modifier and Type	Method	Description
java.lang.String	dataToString()	returns a string representation of the historical data retrieved from the Historical OHLCV end point.
static HistoricalDaily	generateHistoDaily(java.lang.String currencyTo, java.lang.String currencyFrom, ExchangeStreamer.exchanges exchange)	gets a new instance of HistoricalDaily with the following parameters
static HistoricalHourly	generateHistoHourly(java.lang.String currencyTo, java.lang.String currencyFrom, ExchangeStreamer.exchanges exchange)	gets a new instance of HistoricalHourly with the following parameters
static HistoricalMinute	generateHistoMinute(java.lang.String currencyTo, java.lang.String currencyFrom, ExchangeStreamer.exchanges exchange)	gets a new instance of HistoricalMinute with the following parameters
int	getAggregate()	gets the aggregate parameter this object uses for the CryptoCompare API
ConversionType	getConversionType()	gets the ConversionType for this object
java.lang.String	getCurrencyFrom()	gets the fsym(s) parameter this object uses for the CryptoCompare API
java.lang.String	getCurrencyTo()	gets the tsym(s) parameter this object uses for the CryptoCompare API
abstract TimestampedData	getDataAtTime(long timestamp)	gets the TimestampedData with unix timestamp equal to unixTimestamp. If the unixTimestamp is in between two unix timestamps then the latter TimestampedData is returned.
java.util.stream.Stream<TimestampedData>	getDataStream()	streams TimestampedData from this Historical object
ExchangeStreamer.exchanges	getExchange()	gets the e parameter this object uses for the CryptoCompare API
long	getLastUnixTimestamp()	gets the toTs parameter this object uses for the CryptoCompare API
int	getLimit()	gets the limit parameter this object uses for the CryptoCompare API
java.lang.String	getResponse()
long	getTimeFrom()
long	getTimeTo()
float	getType()
java.net.URL	getURL()	gets the https://min-api.cryptocompare.com/data/histo end point url with parameters currencyTo, currencyFrom, exchange, lastUnixTimestamp, limit, aggregate, and apiKey (if any)
boolean	isAggregated()
boolean	isFirstValueInArray()
void	setAggregate(int aggregate)	sets the aggregate parameter this object uses for the CryptoCompare API
void	setCurrencyFrom(java.lang.String currencyFrom)	sets the fsym(s) parameter this object uses for the CryptoCompare API
void	setCurrencyTo(java.lang.String currencyTo)	sets the tsym(s) parameter this object uses for the CryptoCompare API
void	setExchange(ExchangeStreamer.exchanges exchange)	sets the e parameter this object uses for the CryptoCompare API
void	setLastUnixTimestamp(long time)	sets the toTs parameter this object uses for the CryptoCompare API
void	setLimit(int limit)	sets the limit parameter this object uses for the CryptoCompare API
void	update()	updates url with parameters, then connects and updates this objects fields with the returned json.

Methods inherited from class java.lang.Object

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

Method Detail

generateHistoDaily

public static HistoricalDaily generateHistoDaily(java.lang.String currencyTo,
                                                 java.lang.String currencyFrom,
                                                 ExchangeStreamer.exchanges exchange)

gets a new instance of HistoricalDaily with the following parameters

Parameters:

currencyTo - currency symbol to convert to

currencyFrom - currency symbol to convert from

exchange - exchange to get data from

Returns:

new instance of HistoricalDaily

Since:

Cryptos4J v1.0

generateHistoHourly

public static HistoricalHourly generateHistoHourly(java.lang.String currencyTo,
                                                   java.lang.String currencyFrom,
                                                   ExchangeStreamer.exchanges exchange)

gets a new instance of HistoricalHourly with the following parameters

Parameters:

currencyTo - currency symbol to convert to

currencyFrom - currency symbol to convert from

exchange - exchange to get data from

Returns:

new instance of HistoricalHourly

Since:

Cryptos4J v1.0

generateHistoMinute

public static HistoricalMinute generateHistoMinute(java.lang.String currencyTo,
                                                   java.lang.String currencyFrom,
                                                   ExchangeStreamer.exchanges exchange)

gets a new instance of HistoricalMinute with the following parameters

Parameters:

currencyTo - currency symbol to convert to

currencyFrom - currency symbol to convert from

exchange - exchange to get data from

Returns:

new instance of HistoricalMinute

Since:

Cryptos4J v1.0

getLastUnixTimestamp

public long getLastUnixTimestamp()

Description copied from interface: HistoricalBase

gets the toTs parameter this object uses for the CryptoCompare API

Specified by:

getLastUnixTimestamp in interface HistoricalBase

Returns:

lastUnixTimestap - the last unix timestamp to get data for

setLastUnixTimestamp

public void setLastUnixTimestamp(long time)

Description copied from interface: HistoricalBase

sets the toTs parameter this object uses for the CryptoCompare API

Specified by:

setLastUnixTimestamp in interface HistoricalBase

Parameters:

time - the last unix timestamp to get data for

getAggregate

public int getAggregate()

Description copied from interface: HistoricalBase

gets the aggregate parameter this object uses for the CryptoCompare API

Specified by:

getAggregate in interface HistoricalBase

Returns:

aggregate time period to aggregate the data over

setAggregate

public void setAggregate(int aggregate)

Description copied from interface: HistoricalBase

sets the aggregate parameter this object uses for the CryptoCompare API

Specified by:

setAggregate in interface HistoricalBase

Parameters:

aggregate - time period to aggregate the data over

getLimit

public int getLimit()

Description copied from interface: HistoricalBase

gets the limit parameter this object uses for the CryptoCompare API

Specified by:

getLimit in interface HistoricalBase

Returns:

limit the number of TimestampedData to return

setLimit

public void setLimit(int limit)

Description copied from interface: HistoricalBase

sets the limit parameter this object uses for the CryptoCompare API

Specified by:

setLimit in interface HistoricalBase

Parameters:

limit - The number of TimestampedData to return

getExchange

public ExchangeStreamer.exchanges getExchange()

Description copied from interface: CryptoBaseExchange

gets the e parameter this object uses for the CryptoCompare API

Specified by:

getExchange in interface CryptoBaseExchange

Returns:

exchange exchange to get data from

setExchange

public void setExchange(ExchangeStreamer.exchanges exchange)

Description copied from interface: CryptoBaseExchange

sets the e parameter this object uses for the CryptoCompare API

Specified by:

setExchange in interface CryptoBaseExchange

Parameters:

exchange - exchange to get data from

getCurrencyFrom

public java.lang.String getCurrencyFrom()

Description copied from interface: CryptoBase

gets the fsym(s) parameter this object uses for the CryptoCompare API

Specified by:

getCurrencyFrom in interface CryptoBase

Returns:

currencyFrom - currency symbol to convert from

setCurrencyFrom

public void setCurrencyFrom(java.lang.String currencyFrom)

Description copied from interface: CryptoBase

sets the fsym(s) parameter this object uses for the CryptoCompare API

Specified by:

setCurrencyFrom in interface CryptoBase

Parameters:

currencyFrom - currency symbol to convert from

getCurrencyTo

public java.lang.String getCurrencyTo()

Description copied from interface: CryptoBase

gets the tsym(s) parameter this object uses for the CryptoCompare API

Specified by:

getCurrencyTo in interface CryptoBase

Returns:

currencyTo currency symbol to convert to

setCurrencyTo

public void setCurrencyTo(java.lang.String currencyTo)

Description copied from interface: CryptoBase

sets the tsym(s) parameter this object uses for the CryptoCompare API

Specified by:

setCurrencyTo in interface CryptoBase

Parameters:

currencyTo - currency symbol to convert to

getURL

public java.net.URL getURL()

gets the https://min-api.cryptocompare.com/data/histo end point url with parameters currencyTo, currencyFrom, exchange, lastUnixTimestamp, limit, aggregate, and apiKey (if any)

Specified by:

getURL in interface CryptoBase

Returns:

URL end point this object connects to

getResponse

public java.lang.String getResponse()

Specified by:

getResponse in interface HistoricalBase

Returns:

response message
Example: "Success" if data was successfully retrieved

getType

public float getType()

Specified by:

getType in interface HistoricalBase

Returns:

type

isAggregated

public boolean isAggregated()

Specified by:

isAggregated in interface HistoricalBase

Returns:

true if data is aggregated

getTimeTo

public long getTimeTo()

Specified by:

getTimeTo in interface HistoricalBase

Returns:

unix timestamp to for this Historical object

getTimeFrom

public long getTimeFrom()

Specified by:

getTimeFrom in interface HistoricalBase

Returns:

unix timestamp from for this Historical object

isFirstValueInArray

public boolean isFirstValueInArray()

Specified by:

isFirstValueInArray in interface HistoricalBase

Returns:

true if there is a first value in the array of TimestampedData

getConversionType

public ConversionType getConversionType()

Description copied from interface: HistoricalBase

gets the ConversionType for this object

Specified by:

getConversionType in interface HistoricalBase

Returns:

ConversionType

See Also:

ConversionType

getDataStream

public java.util.stream.Stream<TimestampedData> getDataStream()

Description copied from interface: HistoricalBase

streams TimestampedData from this Historical object

Specified by:

getDataStream in interface HistoricalBase

Returns:

data stream

See Also:

TimestampedData

getDataAtTime

public abstract TimestampedData getDataAtTime(long timestamp)
                                       throws TimestampOutOfBoundsException

Description copied from interface: HistoricalBase

gets the TimestampedData with unix timestamp equal to unixTimestamp.
If the unixTimestamp is in between two unix timestamps then the latter TimestampedData is returned.

Note: this method expects the unixTimestamp parameter to be in GMT time zone

Specified by:

getDataAtTime in interface HistoricalBase

Parameters:

timestamp - unix timestamp of TimestampedData to get

Returns:

TimestampedData with unix timestamp equal to or greater than unixTimestamp

Throws:

TimestampOutOfBoundsException

See Also:

TimestampedData

update

public void update()
            throws InvalidArgumentException

updates url with parameters, then connects and updates this objects fields with the returned json.

Specified by:

update in interface CryptoBase

Throws:

InvalidArgumentException

Since:

Cryptos4J v1.0

dataToString

public java.lang.String dataToString()

returns a string representation of the historical data retrieved from the Historical OHLCV end point.

Specified by:

dataToString in interface CryptoBase

Returns:

dataToString

Since:

Cryptos4J v1.0

See Also:

TimestampedData.datatoString(), ConversionType.datatoString()