View Source AlphaVantage.FundamentalData (Alpha Vantage v0.3.0)

A set of functions for fetching various temporal dimensions covering key financial metrics, income statements, balance sheets, cash flow, and other fundamental data points from Alpha Vantage.

Summary

Functions

Returns the annual and quarterly balance sheets for the company of interest, with normalized fields mapped to GAAP and IFRS taxonomies of the SEC. Data is generally refreshed on the same day a company reports its latest earnings and financials.

Returns This API returns the annual and quarterly cash flow for the company of interest, with normalized fields mapped to GAAP and IFRS taxonomies of the SEC. Data is generally refreshed on the same day a company reports its latest earnings and financials.

Returns the company information, financial ratios, and other key metrics for the equity specified. Data is generally refreshed on the same day a company reports its latest earnings and financials.

Returns the annual and quarterly earnings (EPS) for the company of interest. Quarterly data also includes analyst estimates and surprise metrics.

Returns a list of company earnings expected in the next 3, 6, or 12 months.

Returns the annual and quarterly income statements for the company of interest, with normalized fields mapped to GAAP and IFRS taxonomies of the SEC. Data is generally refreshed on the same day a company reports its latest earnings and financials.

Returns a list of IPOs expected in the next 3 months.

Returns a list of active or delisted US stocks and ETFs, either as of the latest trading day or at a specific time in history. The endpoint is positioned to facilitate equity research on asset lifecycle and survivorship.

Functions

Link to this function

balance_sheet(symbol, opts \\ [])

View Source
@spec balance_sheet(String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the annual and quarterly balance sheets for the company of interest, with normalized fields mapped to GAAP and IFRS taxonomies of the SEC. Data is generally refreshed on the same day a company reports its latest earnings and financials.

Please reference https://www.alphavantage.co/documentation/#balance-sheet for more detail.

Parameters

Required

  • :symbol

    The name of the security of your choice, provided as a string. For example: "MSFT"

Optional (accepted as a keyword list)

  • :datatype
    • "map" returns a map (default);
    • "json" returns JSON format;
    • "csv" returns a CSV (comma separated value) file string.
Link to this function

cash_flow(symbol, opts \\ [])

View Source
@spec cash_flow(String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns This API returns the annual and quarterly cash flow for the company of interest, with normalized fields mapped to GAAP and IFRS taxonomies of the SEC. Data is generally refreshed on the same day a company reports its latest earnings and financials.

Please reference https://www.alphavantage.co/documentation/#cash-flow for more detail.

Parameters

Required

  • :symbol

    The name of the security of your choice, provided as a string. For example: "MSFT"

Optional (accepted as a keyword list)

  • :datatype
    • "map" returns a map (default);
    • "json" returns JSON format;
    • "csv" returns a CSV (comma separated value) file string.
Link to this function

company_overview(symbol, opts \\ [])

View Source
@spec company_overview(String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the company information, financial ratios, and other key metrics for the equity specified. Data is generally refreshed on the same day a company reports its latest earnings and financials.

Please reference https://www.alphavantage.co/documentation/#company-overview for more detail.

Parameters

Required

  • :symbol

    The name of the security of your choice, provided as a string. For example: "MSFT"

Optional (accepted as a keyword list)

  • :datatype
    • "map" returns a map (default);
    • "json" returns JSON format;
    • "csv" returns a CSV (comma separated value) file string.
Link to this function

earnings(symbol, opts \\ [])

View Source
@spec earnings(String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the annual and quarterly earnings (EPS) for the company of interest. Quarterly data also includes analyst estimates and surprise metrics.

Please reference https://www.alphavantage.co/documentation/#earnings for more detail.

Parameters

Required

  • :symbol

    The name of the security of your choice, provided as a string. For example: "MSFT"

Optional (accepted as a keyword list)

  • :datatype
    • "map" returns a map (default);
    • "json" returns JSON format;
    • "csv" returns a CSV (comma separated value) file string.
Link to this function

earnings_calendar(opts \\ [])

View Source
@spec earnings_calendar(Keyword.t()) :: AlphaVantage.Gateway.response()

Returns a list of company earnings expected in the next 3, 6, or 12 months.

Please reference https://www.alphavantage.co/documentation/#earnings-calendar for more detail.

Note: To ensure optimal API response time, this endpoint uses the CSV format which is more memory-efficient than JSON.

Parameters

Optional (accepted as a keyword list)

  • :symbol

    The name of the security of your choice, provided as a string. For example: "MSFT"

  • :horizon

    By default, horizon: "3month" and the API will return a list of expected company earnings in the next 3 months. You may set horizon: "6month" or horizon: "12month" to query the earnings scheduled for the next 6 months or 12 months, respectively.

Link to this function

income_statement(symbol, opts \\ [])

View Source
@spec income_statement(String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the annual and quarterly income statements for the company of interest, with normalized fields mapped to GAAP and IFRS taxonomies of the SEC. Data is generally refreshed on the same day a company reports its latest earnings and financials.

Please reference https://www.alphavantage.co/documentation/#income-statement for more detail.

Parameters

Required

  • :symbol

    The name of the security of your choice, provided as a string. For example: "MSFT"

Optional (accepted as a keyword list)

  • :datatype
    • "map" returns a map (default);
    • "json" returns JSON format;
    • "csv" returns a CSV (comma separated value) file string.
Link to this function

ipo_calendar(opts \\ [])

View Source
@spec ipo_calendar(Keyword.t()) :: AlphaVantage.Gateway.response()

Returns a list of IPOs expected in the next 3 months.

Please reference https://www.alphavantage.co/documentation/#ipo-calendar for more detail.

Note: To ensure optimal API response time, this endpoint uses the CSV format which is more memory-efficient than JSON.

Link to this function

listing_status(symbol, opts \\ [])

View Source
@spec listing_status(String.t(), Keyword.t()) :: AlphaVantage.Gateway.response()

Returns a list of active or delisted US stocks and ETFs, either as of the latest trading day or at a specific time in history. The endpoint is positioned to facilitate equity research on asset lifecycle and survivorship.

Please reference https://www.alphavantage.co/documentation/#listing-status for more detail.

Note: To ensure optimal API response time, this endpoint uses the CSV format which is more memory-efficient than JSON.

Parameters

Required

  • :symbol

    The name of the security of your choice, provided as a string. For example: "MSFT"

Optional (accepted as a keyword list)

  • :date

    If no date is set, the API endpoint will return a list of active or delisted symbols as of the latest trading day. If a date is set, the API endpoint will "travel back" in time and return a list of active or delisted symbols on that particular date in history. Any YYYY-MM-DD date later than 2010-01-01 is supported. For example, date: "2013-08-03".

  • :state

    By default, state: "active" and the API will return a list of actively traded stocks and ETFs. Set state: "delisted" to query a list of delisted assets.