Alpha Vantage v0.1.0 AlphaVantage.Cryptocurrencies View Source

A set of functions for fetching cryptocurrency data from Alpha Vantage.

Link to this section Summary

Functions

Returns the daily historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD. Please reference https://www.alphavantage.co/documentation/#currency-daily for more detail.

Returns the realtime exchange rate for any pair of digital currency (e.g., Bitcoin) and physical currency (e.g., USD). Data returned for physical currency (Forex) pairs also include realtime bid and ask prices. Please reference https://www.alphavantage.co/documentation/#crypto-exchange for more detail.

Returns the monthly historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD. Please reference https://www.alphavantage.co/documentation/#currency-monthly for more detail.

Returns the weekly historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD. Please reference https://www.alphavantage.co/documentation/#currency-weekly for more detail.

Link to this section Functions

Link to this function

daily(symbol, market, opts \\ [])

View Source
daily(String.t(), String.t(), list()) ::
  {:atom, map()} | {:atom, list()} | {:atom, String.t()}

Returns the daily historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD. Please reference https://www.alphavantage.co/documentation/#currency-daily for more detail.

Parameters

Required

  • :symbol

    The digital/crypto currency of your choice. It can be any of the currencies in the digital currency list. For example: "BTC"

  • :market

    The exchange market of your choice. It can be any of the market in the market list. For example: "CNY"

Optional (accepted as a keyword list)

  • :datatype

    By default, datatype: "map". Strings "map", lists, "json", and "csv" are accepted with the following specifications:

    • "map" returns a map;
    • "lists" returns a list of lists;
    • "json" returns JSON format;
    • "csv" returns a CSV (comma separated value) file.

    *Please note that "map" and "lists" will both return unsorted.

Link to this function

exchange_rate(from_currency, to_currency, opts \\ [])

View Source
exchange_rate(String.t(), String.t(), list()) ::
  {:atom, map()} | {:atom, list()} | {:atom, String.t()}

Returns the realtime exchange rate for any pair of digital currency (e.g., Bitcoin) and physical currency (e.g., USD). Data returned for physical currency (Forex) pairs also include realtime bid and ask prices. Please reference https://www.alphavantage.co/documentation/#crypto-exchange for more detail.

Parameters

Required

  • :from_currency

    The currency you would like to get the exchange rate for. It can either be a physical currency or digital/crypto currency. For example: "USD", "EUR", or "BTC"

  • :to_currency

    The destination currency for the exchange rate. It can either be a physical currency or digital/crypto currency. For example: "USD", "EUR", or "BTC"

Optional (accepted as a keyword list)

  • :datatype

    By default, datatype: "map". Strings "map" and "json" are accepted with the following specifications:

    • "map" returns a map;
    • "json" returns JSON format;

    *Please note that "map" will return unsorted. Also, "csv" and thus, "lists", are not yet supported by Alpha Vantage for this function.

Link to this function

monthly(symbol, market, opts \\ [])

View Source
monthly(String.t(), String.t(), list()) ::
  {:atom, map()} | {:atom, list()} | {:atom, String.t()}

Returns the monthly historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD. Please reference https://www.alphavantage.co/documentation/#currency-monthly for more detail.

Parameters

Required

  • :symbol

    The digital/crypto currency of your choice. It can be any of the currencies in the digital currency list. For example: "BTC"

  • :market

    The exchange market of your choice. It can be any of the market in the market list. For example: "CNY"

Optional (accepted as a keyword list)

  • :datatype

    By default, datatype: "map". Strings "map", lists, "json", and "csv" are accepted with the following specifications:

    • "map" returns a map;
    • "lists" returns a list of lists;
    • "json" returns JSON format;
    • "csv" returns a CSV (comma separated value) file.

    *Please note that "map" and "lists" will both return unsorted.

Link to this function

weekly(symbol, market, opts \\ [])

View Source
weekly(String.t(), String.t(), list()) ::
  {:atom, map()} | {:atom, list()} | {:atom, String.t()}

Returns the weekly historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD. Please reference https://www.alphavantage.co/documentation/#currency-weekly for more detail.

Parameters

Required

  • :symbol

    The digital/crypto currency of your choice. It can be any of the currencies in the digital currency list. For example: "BTC"

  • :market

    The exchange market of your choice. It can be any of the market in the market list. For example: "CNY"

Optional (accepted as a keyword list)

  • :datatype

    By default, datatype: "map". Strings "map", lists, "json", and "csv" are accepted with the following specifications:

    • "map" returns a map;
    • "lists" returns a list of lists;
    • "json" returns JSON format;
    • "csv" returns a CSV (comma separated value) file.

    *Please note that "map" and "lists" will both return unsorted.