alphavantage/com.crazzyghost.alphavantage.search.response/Match

Match

public class Match

One instrument matched by a SYMBOL_SEARCH keyword, together with the trading-venue details and the relevance score that decided its rank.

Alpha Vantage returns every field of a match as a string, and this class keeps them that way — nothing here is parsed into a number or a time. Callers that need getMatchScore or getMarketOpen as a typed value convert it themselves.

Author

Sylvester Sefa-Yeboah

Since

1.8.0

Constructors

Match

public void Match()

Properties

currency

@Json(name = "8. currency")

public String currency

marketClose

@Json(name = "6. marketClose")

public String marketClose

marketOpen

@Json(name = "5. marketOpen")

public String marketOpen

matchScore

@Json(name = "9. matchScore")

public String matchScore

name

@Json(name = "2. name")

public String name

region

@Json(name = "4. region")

public String region

symbol

@Json(name = "1. symbol")

public String symbol

timezone

@Json(name = "7. timezone")

public String timezone

type

@Json(name = "3. type")

public String type

Functions

getCurrency

public String getCurrency()

Gets the currency the instrument trades in, as a three-letter code such as GBP.

getMarketClose

public String getMarketClose()

Gets the time the listing venue closes, as HH:mm in the timezone reported by getTimezone.

getMarketOpen

public String getMarketOpen()

Gets the time the listing venue opens, as HH:mm in the timezone reported by getTimezone.

getMatchScore

public String getMatchScore()

Gets how closely this instrument matched the searched keywords.

getName

public String getName()

Gets the full name of the instrument, as in Tesco PLC.

getRegion

public String getRegion()

Gets the market the instrument is listed on, named as a place rather than an exchange code, as in United States or United Kingdom.

getSymbol

public String getSymbol()

Gets the ticker symbol to pass to the other endpoints when requesting data for this instrument.

getTimezone

public String getTimezone()

Gets the timezone the opening and closing times are expressed in, as a UTC offset such as UTC-04 rather than a region name.

getType

public String getType()

Gets the kind of instrument this is, such as Equity, ETF or Mutual Fund.

toString

public String toString()