alphavantage/com.crazzyghost.alphavantage.technicalindicator.response.htsine/HTSINEResponse

HTSINEResponse

public class HTSINEResponse

Response for the Hilbert transform sine wave (HT_SINE), which plots the Sine and Lead Sine lines derived from the price series' dominant cycle to help spot cycle turning points.

HT_SINE does not extend one of the package's shared response bases: its two-line reading needs HTSINEIndicatorUnit rather than the single-value SimpleTechnicalIndicatorUnit the shared bases use.

Author

Sylvester Sefa-Yeboah

Since

1.1.0

Types

public class HTSINEParser extends DefaultParser<HTSINEResponse>

Parser for HTSINEResponse.

public class MetaData

Metadata describing the request that produced an HTSINEResponse, echoed back by the API alongside the indicator values themselves.

Properties

public String errorMessage

The API's error message, or null if the request succeeded.

public List<HTSINEIndicatorUnit> indicatorUnits

The indicator's Sine/Lead Sine readings, one unit per date in the requested series.

public HTSINEResponse.MetaData metaData

The response's metadata, echoing the request's parameters.

Functions

getErrorMessage

public String getErrorMessage()

Returns the API's error message.

getIndicatorUnits

public List<HTSINEIndicatorUnit> getIndicatorUnits()

Returns the indicator's Sine/Lead Sine readings.

public HTSINEResponse.MetaData getMetaData()

Returns the response's metadata.

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

Parses a raw API response into an HTSINEResponse.

public String toString()