alphavantage/com.crazzyghost.alphavantage.cryptocurrency.response/MetaData

MetaData

public class MetaData

The header block Alpha Vantage returns alongside a digital currency time series: which currency and market the data covers, when it was last refreshed, and the time zone, interval and output size it was served under. Fields that do not apply to the requested endpoint come back empty rather than absent.

Author

Sylvester Sefa-Yeboah

Since

1.0.0

Types

public class Builder

Collects a digital currency time series' header fields and assembles them into a MetaData.

Properties

digitalCurrencyCode

public final String digitalCurrencyCode

The digital currency's symbol, for example BTC.

digitalCurrencyName

public final String digitalCurrencyName

The digital currency's full name, for example Bitcoin.

public final String information

A human-readable description of the endpoint that produced this response.

public final String interval

The interval between data points.

public final String lastRefreshed

The date the series was last refreshed.

public final String marketCode

The market currency's code, for example USD.

public final String marketName

The market currency's full name, for example

United States
Dollar

.

public final String outputSize

The amount of historical data returned.

public final String timeZone

The time zone lastRefreshed is expressed in.

Functions

public static MetaData.Builder builder()

Creates a new builder for assembling a MetaData instance.

public static MetaData empty()

Returns a MetaData with every field unset, used when the API response carries an error instead of a real time series.

getDigitalCurrencyCode

public String getDigitalCurrencyCode()

Returns the digital currency's symbol.

getDigitalCurrencyName

public String getDigitalCurrencyName()

Returns the digital currency's full name.

public String getInformation()

Returns a human-readable description of the endpoint that produced this response.

public String getInterval()

Returns the interval between data points.

getLastRefreshed

public String getLastRefreshed()

Returns the date the series was last refreshed.

public String getMarketCode()

Returns the market currency's code.

public String getMarketName()

Returns the market currency's full name.

public String getOutputSize()

Returns the amount of historical data returned.

public String getTimeZone()

Returns the time zone getLastRefreshed is expressed in.

public String toString()