alphavantage/com.crazzyghost.alphavantage.forex.response/ForexResponse

ForexResponse

public class ForexResponse

A currency pair's exchange rate series, or the message Alpha Vantage returned in place of one.

All four forex cadences answer with this same type; what differs is the span each ForexUnit covers and how much of the MetaData is filled in.

A response carries results or an error, never both. On success getErrorMessage is null, getMetaData describes the series and getForexUnits holds its bars. On failure the message is set, the bar list is empty, and the metadata is the empty placeholder whose fields are all null — so checking the error message is what tells the two apart, not checking for nulls.

Author

Sylvester Sefa-Yeboah

Since

1.0.0

Types

public class ForexParser extends DefaultParser<ForexResponse>

Turns a decoded forex payload into a ForexResponse.

Properties

public String errorMessage

public List<ForexUnit> forexUnits

public MetaData metaData

Functions

getErrorMessage

public String getErrorMessage()

Gets the reason no series was returned, as reported by the API.

public List<ForexUnit> getForexUnits()

Gets the exchange rate bars making up the series, each carrying its own timestamp in getDate.

public MetaData getMetaData()

Gets the header describing the series: its currency pair, freshness and sampling.

public static ForexResponse of(Map<String, Object> stringObjectMap)

Builds a response from a decoded forex payload, whichever cadence produced it.

public String toString()