FinancialData
=============



AlphaVantage gives access to time series data various types of equities, including stocks, currency, and cryptocurrency.
The intraday data is derived from the Securities Information Processor (SIP) market-aggregated data.
`Terms of service <https://www.alphavantage.co/terms_of_service/>`__.



.. toctree::
    :maxdepth: 2
    :titlesonly:
    :caption: RPC Categories





RPCS
----

.. function:: FinancialData.convertCurrency(fromSymbol: String, amount: Integer, toSymbol: String)

    Convert an ``amount`` of currency of type ``fromSymbol`` into the (current) equivalent amount of currency of type ``toSymbol``.
    To find currency symbol names, you can use :func:`AlphaVantage.currencySymbolSearch`.

    **Arguments:**

    - ``fromSymbol: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - Currency type to convert from.
    - ``amount: Integer`` (`Integer </docs/fundamentals/rpc-arg-types.html#Integer>`__) - Amount of currency to convert.
    - ``toSymbol: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - Currency type to convert to.

    **Returns:** ``Number`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - The converted amount of currency.


.. function:: FinancialData.currencySymbolSearch(search: BoundedString<2>)

    Search for a type of currency by name.

    **Arguments:**

    - ``search: BoundedString<2>`` (`BoundedString </docs/fundamentals/rpc-arg-types.html#BoundedString>`__) - String to search for matches.

    **Returns:** ``List<Tuple<String, String>>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Tuple </docs/fundamentals/rpc-arg-types.html#Tuple>`__ | `String </docs/fundamentals/rpc-arg-types.html#String>`__) - List of search results, which are pairs of ``name`` and ``symbol``.


.. function:: FinancialData.equitiesSymbolSearch(search: BoundedString<2>)

    Search for a type of equity (stock) by name.

    **Arguments:**

    - ``search: BoundedString<2>`` (`BoundedString </docs/fundamentals/rpc-arg-types.html#BoundedString>`__) - String to search for matches.

    **Returns:** ``List<Tuple<String, String>>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Tuple </docs/fundamentals/rpc-arg-types.html#Tuple>`__ | `String </docs/fundamentals/rpc-arg-types.html#String>`__) - List of search results, which are pairs of ``name`` and ``symbol``.


.. function:: FinancialData.getCryptoData(symbol: String, interval: TimePeriod, attributes: EquityField?, dateFormat: DateFormat?, startDate: Date?, endDate: Date?)

    Get time series data about the value of cryptocurrencies (digital currencies) in USD.
    To convert currency values, you can use :func:`AlphaVantage.convertCurrency`.

    **Arguments:**

    - ``symbol: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - The cryptocurrency symbol name.
    - ``interval: TimePeriod`` (`TimePeriod </docs/fundamentals/rpc-arg-types.html#TimePeriod>`__) - The interval of time series data to return.
    - ``attributes: EquityField?`` (`EquityField </docs/fundamentals/rpc-arg-types.html#EquityField>`__) - A specific attribute/field of data to return for each entry, or ``all`` to return all entries (default: ``all``).
    - ``dateFormat: DateFormat?`` (`DateFormat </docs/fundamentals/rpc-arg-types.html#DateFormat>`__) - The date format to return for each entry (default: ``traditional``).
    - ``startDate: Date?`` (`Date </docs/fundamentals/rpc-arg-types.html#Date>`__) - The first date of results to include (defaults to no cutoff).
    - ``endDate: Date?`` (`Date </docs/fundamentals/rpc-arg-types.html#Date>`__) - The last date of results to include (defaults to no cutoff).

    **Returns:** ``List<Tuple<Any, Any>>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Tuple </docs/fundamentals/rpc-arg-types.html#Tuple>`__ | `Any </docs/fundamentals/rpc-arg-types.html#Any>`__) - Array of time series results, which are pairs of ``time`` and ``data``.


.. function:: FinancialData.getEquityData(symbol: String, interval: TimePeriod, attributes: EquityField?, dateFormat: DateFormat?, startDate: Date?, endDate: Date?)

    Get time series data about the value of publicly traded equities (stocks).
    To find equity symbol names, you can use :func:`AlphaVantage.equitiesSymbolSearch`.

    **Arguments:**

    - ``symbol: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - The equity symbol name.
    - ``interval: TimePeriod`` (`TimePeriod </docs/fundamentals/rpc-arg-types.html#TimePeriod>`__) - The interval of time series data to return.
    - ``attributes: EquityField?`` (`EquityField </docs/fundamentals/rpc-arg-types.html#EquityField>`__) - A specific attribute/field of data to return for each entry, or ``all`` to return all entries (default: ``all``).
    - ``dateFormat: DateFormat?`` (`DateFormat </docs/fundamentals/rpc-arg-types.html#DateFormat>`__) - The date format to return for each entry (default: ``traditional``).
    - ``startDate: Date?`` (`Date </docs/fundamentals/rpc-arg-types.html#Date>`__) - The first date of results to include (defaults to no cutoff).
    - ``endDate: Date?`` (`Date </docs/fundamentals/rpc-arg-types.html#Date>`__) - The last date of results to include (defaults to no cutoff).

    **Returns:** ``List<Tuple<Any, Any>>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Tuple </docs/fundamentals/rpc-arg-types.html#Tuple>`__ | `Any </docs/fundamentals/rpc-arg-types.html#Any>`__) - Array of time series results, which are pairs of ``time`` and ``data``.


.. function:: FinancialData.getExchangeData(fromSymbol: String, toSymbol: String, interval: TimePeriod, attributes: EquityField?, dateFormat: DateFormat?, startDate: Date?, endDate: Date?)

    Get time series data from the foreign exchange about the conversion rate between two types of currency.
    To find currency symbol names, you can use :func:`AlphaVantage.currencySymbolSearch`.

    **Arguments:**

    - ``fromSymbol: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - The cryptocurrency symbol to convert from.
    - ``toSymbol: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - The cryptocurrency symbol to convert to.
    - ``interval: TimePeriod`` (`TimePeriod </docs/fundamentals/rpc-arg-types.html#TimePeriod>`__) - The interval of time series data to return.
    - ``attributes: EquityField?`` (`EquityField </docs/fundamentals/rpc-arg-types.html#EquityField>`__) - A specific attribute/field of data to return for each entry, or ``all`` to return all entries (default: ``all``).
    - ``dateFormat: DateFormat?`` (`DateFormat </docs/fundamentals/rpc-arg-types.html#DateFormat>`__) - The date format to return for each entry (default: ``traditional``).
    - ``startDate: Date?`` (`Date </docs/fundamentals/rpc-arg-types.html#Date>`__) - The first date of results to include (defaults to no cutoff).
    - ``endDate: Date?`` (`Date </docs/fundamentals/rpc-arg-types.html#Date>`__) - The last date of results to include (defaults to no cutoff).

    **Returns:** ``List<Tuple<Any, Any>>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Tuple </docs/fundamentals/rpc-arg-types.html#Tuple>`__ | `Any </docs/fundamentals/rpc-arg-types.html#Any>`__) - Array of time series results, which are pairs of ``time`` and ``data``.