Package cryptos.historical

Class HistoricalMinute

java.lang.Object

cryptos.historical.HistoricalData

cryptos.historical.HistoricalMinute

All Implemented Interfaces:

CryptoBase, CryptoBaseExchange, HistoricalBase

public class HistoricalMinute
extends HistoricalData

Historical data class that is equivalent to the json object returned by the Historical Minute OHLCV end point.

Since:

Cryptos4J v1.0

Author:

Matt - mcfadd

See Also:

TimestampedData

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class cryptos.historical.HistoricalData

dataToString, generateHistoDaily, generateHistoHourly, generateHistoMinute, getAggregate, getConversionType, getCurrencyFrom, getCurrencyTo, getDataStream, getExchange, getLastUnixTimestamp, getLimit, getResponse, getTimeFrom, getTimeTo, getType, getURL, isAggregated, isFirstValueInArray, setAggregate, setCurrencyFrom, setCurrencyTo, setExchange, setLastUnixTimestamp, setLimit, update

Methods inherited from class java.lang.Object

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

Method Detail

getDataAtTime

public 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

Specified by:

getDataAtTime in class HistoricalData

Parameters:

timestamp - unix timestamp of TimestampedData to get

Returns:

TimestampedData with unix timestamp equal to or greater than unixTimestamp

Throws:

TimestampOutOfBoundsException

See Also:

TimestampedData