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

A set of functions for key US economic indicators from Alpha Vantage.

Summary

Functions

Returns the monthly consumer sentiment and confidence data of the United States, as measured by the Surveys of Consumers by University of Michigan (Consumer Sentiment © [UMCSENT]), retrieved from FRED, Federal Reserve Bank of St. Louis.

Returns the monthly and semiannual consumer price index (CPI) of the United States.

Returns the monthly manufacturers' new orders of durable goods in the United States.

Returns the annual inflation rates (consumer prices) of the United States.

Returns the monthly inflation expectation data of the United States, as measured by the median expected price change next 12 months according to the Surveys of Consumers by University of Michigan (Inflation Expectation© [MICH]), retrieved from FRED, Federal Reserve Bank of St. Louis.

Returns the daily, weekly, and monthly federal funds rate (interest rate) of the United States.

Returns the monthly US All Employees: Total Nonfarm (commonly known as Total Nonfarm Payroll), a measure of the number of U.S. workers in the economy that excludes proprietors, private household employees, unpaid volunteers, farm employees, and the unincorporated self-employed.

Returns the annual and quarterly Real GDP of the United States.

Returns the quarterly Real GDP per Capita data of the United States.

Returns the monthly Advance Retail Sales: Retail Trade data of the United States.

Returns the daily, weekly, and monthly US treasury yield of a given maturity timeline (e.g., 5 year, 30 year, etc).

Returns the monthly unemployment data of the United States. The unemployment rate represents the number of unemployed as a percentage of the labor force. Labor force data are restricted to people 16 years of age and older, who currently reside in 1 of the 50 states or the District of Columbia, who do not reside in institutions (e.g., penal and mental facilities, homes for the aged), and who are not on active duty in the Armed Forces.

Functions

Link to this function

consumer_sentiment(opts \\ [])

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

Returns the monthly consumer sentiment and confidence data of the United States, as measured by the Surveys of Consumers by University of Michigan (Consumer Sentiment © [UMCSENT]), retrieved from FRED, Federal Reserve Bank of St. Louis.

Please reference https://www.alphavantage.co/documentation/#consumer-sentiment for more detail.

Parameters

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.
@spec cpi(Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the monthly and semiannual consumer price index (CPI) of the United States.

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

Parameters

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.
  • :interval

    • "monthly" (default)
    • "semiannual"
Link to this function

durable_goods(opts \\ [])

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

Returns the monthly manufacturers' new orders of durable goods in the United States.

Please reference https://www.alphavantage.co/documentation/#durable-goods for more detail.

Parameters

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.
@spec inflation(Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the annual inflation rates (consumer prices) of the United States.

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

Parameters

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

inflation_expectation(opts \\ [])

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

Returns the monthly inflation expectation data of the United States, as measured by the median expected price change next 12 months according to the Surveys of Consumers by University of Michigan (Inflation Expectation© [MICH]), retrieved from FRED, Federal Reserve Bank of St. Louis.

Please reference https://www.alphavantage.co/documentation/#inflation-expectation for more detail.

Parameters

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

interest_rate(opts \\ [])

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

Returns the daily, weekly, and monthly federal funds rate (interest rate) of the United States.

Please reference https://www.alphavantage.co/documentation/#interest-rate for more detail.

Parameters

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.
  • :interval

    • "daily"
    • "weekly"
    • "monthly" (default)
Link to this function

nonfarm_payroll(opts \\ [])

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

Returns the monthly US All Employees: Total Nonfarm (commonly known as Total Nonfarm Payroll), a measure of the number of U.S. workers in the economy that excludes proprietors, private household employees, unpaid volunteers, farm employees, and the unincorporated self-employed.

Please reference https://www.alphavantage.co/documentation/#nonfarm-payroll for more detail.

Parameters

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.
@spec real_gdp(Keyword.t()) :: AlphaVantage.Gateway.response()

Returns the annual and quarterly Real GDP of the United States.

Please reference https://www.alphavantage.co/documentation/#real-gdp for more detail.

Parameters

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.
  • :interval

    • "quarterly"
    • "annual" (default)
Link to this function

real_gdp_per_capita(opts \\ [])

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

Returns the quarterly Real GDP per Capita data of the United States.

Please reference https://www.alphavantage.co/documentation/#real-gdp-per-capita for more detail.

Parameters

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

retail_sales(opts \\ [])

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

Returns the monthly Advance Retail Sales: Retail Trade data of the United States.

Please reference https://www.alphavantage.co/documentation/#retail-sales for more detail.

Parameters

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

treasury_yield(opts \\ [])

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

Returns the daily, weekly, and monthly US treasury yield of a given maturity timeline (e.g., 5 year, 30 year, etc).

Please reference https://www.alphavantage.co/documentation/#treasury-yield for more detail.

Parameters

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.
  • :interval

    • "quarterly"
    • "annual" (default)
  • :maturity

    • "3month"
    • "5year"
    • "10year" (default)
    • "30year"
Link to this function

unemployment_rate(opts \\ [])

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

Returns the monthly unemployment data of the United States. The unemployment rate represents the number of unemployed as a percentage of the labor force. Labor force data are restricted to people 16 years of age and older, who currently reside in 1 of the 50 states or the District of Columbia, who do not reside in institutions (e.g., penal and mental facilities, homes for the aged), and who are not on active duty in the Armed Forces.

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

Parameters

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.