Indicator - finflux.indicator()#

The indicator() class does not require any input.

Functions#

gdp(display='table', type='n', period='5y', figure='yoy', show=True, save=False)#
Parameters:

  • display (str) – Specifies the output format; VALID VALUES: 'json' , 'table' , 'line' , 'bar'

  • type (str) – Type of gross domestic product; VALID VALUES: 'n' (nominal) , 'r' (real) , 'n_pc' (nominal per capita) , 'r_pc' (real per capita) , 'd' (deflator)

  • period (str) – The duration of the timeseries; VALID VALUES: '1y' , '2y' , '5y' , '10y' , 'max' , 'ytd' ,

  • figure (str) – Data interpretation; VALID VALUES: 'raw' , 'yoy' , 'pop'

  • show (bool) – Display the chart as an output if display in ('line', 'bar'); VALID VALUES: True , False

  • save (bool) – Download the figure as a png if display in ('line', 'bar'); VALID VALUES: True , False

Returns:

A pandas DataFrame, row oriented JSON formatted output, or simple matplotlib graph of a quarterly timeseries for specified US gross domestic product data

Source:

Bureau of Economic Analysis

price_index(display='table', type='c', period='5y', figure='yoy', show=True, save=False)#
Parameters:

  • display (str) – Specifies the output format; VALID VALUES: 'json' , 'table' , 'line' , 'bar'

  • type (str) – Type of price index; VALID VALUES: 'c' (consumer) , 'p' (producer) , 'cc' (core consumer) , 'cp' (core producer)

  • period (str) – The duration of the timeseries; VALID VALUES: '1y' , '2y' , '5y' , '10y' , 'max' , 'ytd'

  • figure (str) – Data interpretation; VALID VALUES: 'raw' , 'yoy' , 'pop'

  • show (bool) – Display the chart as an output if display in ('line', 'bar'); VALID VALUES: True , False

  • save (bool) – Download the figure as a png if display in ('line', 'bar'); VALID VALUES: True , False

Returns:

A pandas DataFrame, row oriented JSON formatted output, or simple matplotlib graph of a monthly timeseries for specified US price index data

Source:

Bureau of Labor Statistics

pce(display='table', type='raw', period='5y', figure='yoy', show=True, save=False)#
Parameters:

  • display (str) – Specifies the output format; VALID VALUES: 'json' , 'table' , 'line' , 'bar'

  • type (str) – Type of personal consumption expenditure; VALID VALUES: 'raw' , 'core'

  • period (str) – The duration of the timeseries; VALID VALUES: '1y' , '2y' , '5y' , '10y' , 'max' , 'ytd'

  • figure (str) – Data interpretation; VALID VALUES: 'raw' , 'yoy' , 'pop'

  • show (bool) – Display the chart as an output if display in ('line', 'bar'); VALID VALUES: True , False

  • save (bool) – Download the figure as a png if display in ('line', 'bar'); VALID VALUES: True , False

Returns:

A pandas DataFrame, row oriented JSON formatted output, or simple matplotlib graph of a monthly timeseries for specified US personal consumption expenditure data

Source:

Bureau of Economic Analysis

unemployment(display='table', type='U-3', period='5y', show=True, save=False)#
Parameters:

  • display (str) – Specifies the output format; VALID VALUES: 'json' , 'table' , 'line' , 'bar'

  • type (str) – Type of unemployment; VALID VALUES: 'U-3' (unemployment) , 'U-6' (underemployment) , 'g=male' , 'g=female' , 'r=white' , 'r=black' , 'r=asian' , 'r=hispanic' , 'e<hs' (less than HS education) , 'e=hs' , 'e<bach' (less than bachelor’s degree) , 'e>=bach'

  • period (str) – The duration of the timeseries; VALID VALUES: '1y' , '2y' , '5y' , '10y' , 'max' , 'ytd'

  • show (bool) – Display the chart as an output if display in ('line', 'bar'); VALID VALUES: True , False

  • save (bool) – Download the figure as a png if display in ('line', 'bar'); VALID VALUES: True , False

Returns:

A pandas DataFrame, row oriented JSON formatted output, or simple matplotlib graph of a monthly timeseries for specified US unemployment data

Source:

Bureau of Labor Statistics

labor(display='table', type='participation', period='5y', show=True, save=False)#
Parameters:

  • display (str) – Specifies the output format; VALID VALUES: 'json' , 'table' , 'line' , 'bar'

  • type (str) – Type of labor metric; VALID VALUES: 'participation' (Labor Force Participation Rate) , 'payroll' (Nonfarm Payrolls) , 'quits' (Quits Rate) , 'openings' (Job Openings Rate) , 'earnings' (Average Hourly Earnings) , 'claims' (Initial Claims)

  • period (str) – The duration of the timeseries; VALID VALUES: '1y' , '2y' , '5y' , '10y' , 'max' , 'ytd'

  • show (bool) – Display the chart as an output if display in ('line', 'bar'); VALID VALUES: True , False

  • save (bool) – Download the figure as a png if display in ('line', 'bar'); VALID VALUES: True , False

Returns:

A pandas DataFrame, row oriented JSON formatted output, or simple matplotlib graph of a monthly or weekly timeseries for specified US labor metric data

Source:

Bureau of Labor Statistics, FRED (U.S. Employment and Training Administration)

sentiment(display='table', type='c_msci', period='5y', show=True, save=False)#
Parameters:

  • display (str) – Specifies the output format; VALID VALUES: 'json' , 'table' , 'line' , 'bar'

  • type (str) – Type of sentiment indicator; VALID VALUES: 'c_mcsi' (University of Michigan Consumer Sentiment) , 'c_mcie' (University of Michigan Consumer Inflation Expecations) , 'c_oecd' (OECD Composite Consumer Confidence for US) , 'b_oecd' (OECD Business Tendency Surveys Indicator for US Manufacturing)

  • period (str) – The duration of the timeseries; VALID VALUES: '1y' , '2y' , '5y' , '10y' , 'max' , 'ytd'

  • show (bool) – Display the chart as an output if display in ('line', 'bar'); VALID VALUES: True , False

  • save (bool) – Download the figure as a png if display in ('line', 'bar'); VALID VALUES: True , False

Returns:

A pandas DataFrame, row oriented JSON formatted output, or simple matplotlib graph of a monthly timeseries for specified US sentiment data

Source:

FRED (University of Michigan, Organization for Economic Co-operation and Development)

fed_rate(display='table', interval='1d', period='5y', show=True, save=False)#
Parameters:

  • display (str) – Specifies the output format; VALID VALUES: 'json' , 'table' , 'line' , 'bar'

  • interval (str) – Data frequency; VALID VALUES: '1d' , '1wk' , '2wk' , '1mo'

  • period (str) – The duration of the timeseries; VALID VALUES: '1y' , '2y' , '5y' , '10y' , 'max' , 'ytd'

Returns:

A pandas DataFrame, row oriented JSON formatted output, or simple matplotlib graph of a timeseries for the US federal funds rate

Source:

FRED (Board of Governors of the Federal Reserve System)

housing(display='table', type='starts', period='5y', figure='raw', show=True, save=False)#
Parameters:

  • display (str) – Specifies the output format; VALID VALUES: 'json' , 'table' , 'line' , 'bar'

  • type (str) – Type of housing metric; VALID VALUES: 'starts' (Housing Starts) , 'nsales' (New Housing Sales) , 'esales' (Existing Housing Sales) , '30y_rate' (30 Year Mortgage Rate) , '15y_rate' (15 Year Mortgage Rate)

  • period (str) – The duration of the timeseries; VALID VALUES: '1y' , '2y' , '5y' , '10y' , 'max' , 'ytd'

  • figure (str) – Data interpretation; VALID VALUES: 'raw' , 'yoy' , 'pop'

  • show (bool) – Display the chart as an output if display in ('line', 'bar'); VALID VALUES: True , False

  • save (bool) – Download the figure as a png if display in ('line', 'bar'); VALID VALUES: True , False

Returns:

A pandas DataFrame, row oriented JSON formatted output, or simple matplotlib graph of a monthly or weekly timeseries for specified US housing metric data

Source:

FRED (US Census Bureau, National Association of Realtors, Freddie Mac)

vix(display='table', period='5y', start=None, end=None, interval='1d', data='all', show=True, save=False)#
Parameters:

  • display (str) – Specifies the output format; VALID VALUES: 'json' , 'table' , 'line'

  • period (str) – The duration of the timeseries (used if start and end parameters are not provided); VALID VALUES: '1mo' , '6mo' , '1y' , '2y' , '5y' , '10y' , 'ytd' , 'max'

  • start (None or str) – Optional start date in 'YYYY-MM-DD' format. Overrides period parameter if both start and end parameters are set.

  • end (None or str) – Optional end date in 'YYYY-MM-DD' format. Overrides period parameter if both start and end parameters are set.

  • interval (str) – Data frequency; VALID VALUES: '1d' , '1wk' , '1mo' , '3mo'

  • data (str) – Type of OHLC data to retrieve; VALID VALUES: 'open' , 'high' , 'low' , 'close' , 'all'

  • show (bool) – Display the chart as an output if display in ('line', 'bar'); VALID VALUES: True , False

  • save (bool) – Download the figure as a png if display in ('line', 'bar'); VALID VALUES: True , False

Returns:

A pandas DataFrame, row oriented JSON formatted output, or simple matplotlib graph of timeseries data for the CBOE Volatility Index (VIX).

Source:

Yahoo Finance (yfinance)

dollar_index(display='table', period='5y', start=None, end=None, interval='1d', data='all', show=True, save=False)#
Parameters:

  • display (str) – Specifies the output format; VALID VALUES: 'json' , 'table' , 'line'

  • period (str) – The duration of the timeseries (used if start and end parameters are not provided); VALID VALUES: '1mo' , '6mo' , '1y' , '2y' , '5y' , '10y' , 'ytd' , 'max'

  • start (None or str) – Optional start date in 'YYYY-MM-DD' format. Overrides period parameter if both start and end parameters are set.

  • end (None or str) – Optional end date in 'YYYY-MM-DD' format. Overrides period parameter if both start and end parameters are set.

  • interval (str) – Data frequency; VALID VALUES: '1d' , '1wk' , '1mo' , '3mo'

  • data (str) – Type of OHLC data to retrieve; VALID VALUES: 'open' , 'high' , 'low' , 'close' , 'all'

  • show (bool) – Display the chart as an output if display in ('line', 'bar'); VALID VALUES: True , False

  • save (bool) – Download the figure as a png if display in ('line', 'bar'); VALID VALUES: True , False

Returns:

A pandas DataFrame, row oriented JSON formatted output, or simple matplotlib graph of timeseries data for the Dollar Index.

Source:

Yahoo Finance (yfinance)