alphavantage/com.crazzyghost.alphavantage

Package-level declarations

Entry point for the Alpha Vantage Java client library.

A caller builds a com.crazzyghost.alphavantage.Config with an Alpha Vantage API key, passes it to init, and reaches every endpoint through the shared singleton returned by api. From there, one facade method per domain — timeSeries(), forex(), exchangeRate(), crypto(), technicalIndicator(), sector(), fundamentalData(), economicIndicator(), marketStatus() and search() — hands off to that domain's subpackage, where a request is built fluently and then fetched. indicator() also exists but is deprecated in favor of technicalIndicator().

Every domain facade implements com.crazzyghost.alphavantage.Fetcher, resolves its built request to a URL through com.crazzyghost.alphavantage.UrlExtractor, and reports failure as an com.crazzyghost.alphavantage.AlphaVantageException.

Types

AlphaVantage

public class AlphaVantage

Client interface of library.

AlphaVantageException

public class AlphaVantageException extends RuntimeException

The unchecked exception every failure in this library surfaces as, whether the request could not be made, the response could not be read, or the API itself returned an error message.

Config

public class Config

Holds the library configuration parameters: the api key every request is signed with, and the http client and timeout used to make those requests.

Fetcher

public interface Fetcher

Defines an interface for pulling data from the API source.

UrlExtractor

public class UrlExtractor

Extracts a valid url from a request object.