alphavantage/com.crazzyghost.alphavantage.forex.response/MetaData

MetaData

public class MetaData

The header Alpha Vantage returns above a foreign exchange series: which pair it covers, how recently it was refreshed, and how it was sampled.

How much of this is filled in depends on the cadence requested, because the API only echoes back the parameters that cadence accepts — an interval means nothing to a monthly series, so no interval comes back. Only getInformation, getFromSymbol, getToSymbol and getLastRefreshed are populated for every cadence; the rest document their own gaps.

Author

Sylvester Sefa-Yeboah

Since

1.0.0

Constructors

public void MetaData(String information, String fromSymbol, String toSymbol, String lastRefreshed, String interval, String outputSize, String timeZone)

Creates a metadata header from the values a response carried.

Properties

public String fromSymbol

public String information

public String interval

public String lastRefreshed

public String outputSize

public String timeZone

public String toSymbol

Functions

public static MetaData empty()

Creates a placeholder header with every field null.

public String getFromSymbol()

Gets the base currency of the pair — the one being priced.

public String getInformation()

Gets Alpha Vantage's own description of what the series contains, as in Forex Daily Prices (open, high, low, close).

public String getInterval()

Gets how much time each bar in the series covers.

getLastRefreshed

public String getLastRefreshed()

Gets the timestamp of the newest data point in the series, which is how fresh the data is rather than when the request was made.

public String getOutputSize()

Gets how much of the pair's history the series spans, echoing back the requested com.crazzyghost.alphavantage.parameters.OutputSize.

public String getTimeZone()

Gets the timezone that getLastRefreshed and every getDate in the series are expressed in.

public String getToSymbol()

Gets the quote currency of the pair — the one the rates are expressed in.

public String toString()