Commands Reference
i8
i8 Terminal - Modern Market Research powered by the Command-Line
Copyright © 2020-2022 Investoreight | https://investoreight.com/
Usage:
i8 [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 browse
Open company detail page in investoreight.com
Examples:
`i8 browse --ticker MSFT`
Usage:
i8 browse [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--ticker, -k |
ticker | Ticker or company name. | required |
--help |
boolean | Show this message and exit. | False |
i8 clear
Clear the console screen.
Usage:
i8 clear [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--all, -a |
boolean | Clear entire screen. | False |
--help |
boolean | Show this message and exit. | False |
i8 company
Get information about all U.S companies and securities listed in the main U.S exchanges.
Usage:
i8 company [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 company compare
Compare details of the given companies. TICKERS is a comma-separated list of tickers.
Examples:
`i8 company compare --tickers MSFT,AAPL`
Usage:
i8 company compare [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--tickers, -k |
ticker | Comma-separated list of tickers. | required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 company details
Get details for a given company.
Examples:
`i8 company details --ticker MSFT`
Usage:
i8 company details [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--ticker, -k |
ticker | Ticker or company name. | required |
--help |
boolean | Show this message and exit. | False |
i8 company search
Searches and shows all securities that match with the given KEYWORD.
Examples:
`i8 company search --keyword apl`
Usage:
i8 company search [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--keyword, -k |
text | Keyword can be ticker or company name. | required |
--help |
boolean | Show this message and exit. | False |
i8 earnings
Get information about company earnings.
Usage:
i8 earnings [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 earnings list
Lists upcoming company earnings.
Examples:
`i8 earnings list --ticker AAPL`
Usage:
i8 earnings list [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--ticker, -k |
ticker | Company ticker. | required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 earnings plot
Compare and plot earning metrics of given companies. TICKERS is a comma-separated list of tickers.
Examples:
`i8 earnings plot --metric net_ppe --tickers AMD,INTC,QCOM`
Usage:
i8 earnings plot [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--metric, -m |
metric | Metric name. | basiceps |
--tickers, -k |
ticker | Comma-separated list of tickers. | required |
--help |
boolean | Show this message and exit. | False |
i8 earnings recent
Lists recent company earnings.
Examples:
`i8 earnings recent`
Usage:
i8 earnings recent [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 earnings upcoming
Lists upcoming company earnings.
Examples:
`i8 earnings upcoming`
`i8 earnings upcoming --tickers AAPL,MSFT`
Usage:
i8 earnings upcoming [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--tickers, -k |
ticker | Comma-separated list of tickers. | required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 exit
Exit the terminal.
Usage:
i8 exit [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 financials
Get information about company financials.
Usage:
i8 financials [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 financials compare
Compare financial metrics of given companies. IDENTIFIERS is a comma-separated list of identifiers.
Examples:
`i8 financials compare --period_type FY --statement income --identifiers AAPL-2020-FY,MSFT-2020-FY`
Usage:
i8 financials compare [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--identifiers, -i |
financials | Comma-separated list of identifiers. | required |
--statement, -s |
financialstatement | Type of financial statement. | income |
--period_type, -m |
periodtype | Period by which you want to view the report. Possible values are FY for yearly, Q for quarterly, and TTM for TTM reports. |
required |
--plot |
boolean | Plot results on the browser. | False |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 financials coverage
Shows available financial statements of the given company.
Examples:
`i8 financials coverage --ticker AAPL`
Usage:
i8 financials coverage [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--ticker, -k |
ticker | Company ticker. | required |
--help |
boolean | Show this message and exit. | False |
i8 financials list
Lists financial metrics of a given company.
Examples:
`i8 financials list --period_type FY --statement income --identifier AAPL-2020-FY`
Usage:
i8 financials list [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--identifier, -i |
financials | Financial identifier (e.g. MSFT-2023-Q2) | required |
--statement, -s |
financialstatement | Type of financial statement. | income |
--period_type, -m |
periodtype | Period by which you want to view the report. Possible values are FY for yearly, Q for quarterly, and TTM for TTM reports. |
required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 financials plot
Compare and plot financial metrics of given companies. TICKERS is a comma-separated list of tickers.
Examples:
`i8 financials plot --period_type Q --metrics net_ppe --from_date 2020-05-01 --to_date 2022-05-01 --tickers AMD,INTC,QCOM --chart_type line`
Usage:
i8 financials plot [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--tickers, -k |
ticker | Comma-separated list of tickers. | required |
--period_type, -m |
periodtype | Period by which you want to view the report. Possible values are FY for yearly, Q for quarterly, and TTM for TTM reports. |
FY |
--metrics, -m |
metric | Comma-separated list of metrics. | basic_eps |
--from_date, -f |
datetime (%Y-%m-%d | %Y-%m-%dT%H:%M:%S | %Y-%m-%d %H:%M:%S) |
Histotical financials from date. | required |
--to_date, -t |
datetime (%Y-%m-%d | %Y-%m-%dT%H:%M:%S | %Y-%m-%d %H:%M:%S) |
Histotical financials to date. | required |
--chart_type, -c |
charttype | Chart can be bar or line chart. | bar |
--help |
boolean | Show this message and exit. | False |
i8 market
Get information about market.
Usage:
i8 market [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 market summary
Shows a summary of the market information.
Examples:
`i8 market summary`
Usage:
i8 market summary [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--live |
boolean | Print live results of market summary on terminal. | False |
--help |
boolean | Show this message and exit. | False |
i8 metrics
Get information about company metrics.
Usage:
i8 metrics [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 metrics current
Lists the given metrics for a given list of companies. TICKERS is a comma-separated list of tickers.
METRICS can be in the below format:
{metric}.{optional period}
Available periods:
q = most recent quarter,
fy = most recent fiscal year,
ttm = trailing 12 months,
ytd = year to date,
p = default period type
Examples:
`i8 metrics current --metrics total_revenue.q,net_income.fy,close.d,total_revenue --tickers AMD,INTC,QCOM`
Usage:
i8 metrics current [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--tickers, -k |
ticker | Comma-separated list of tickers. | required |
--metrics, -m |
metricidentifier | Comma-separated list of daily metrics. | required |
--view_name, -v |
metricview | Metric view name in configuration file. | required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 metrics describe
Describe the metric information.
Examples:
`i8 metrics describe --name basic_eps`
Usage:
i8 metrics describe [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
metric | Metric name. | required |
--help |
boolean | Show this message and exit. | False |
i8 metrics historical
Lists, compares and plots metrics of given companies. TICKERS is a comma-separated list of tickers.
Examples:
`i8 metrics historical --metrics net_income --tickers AMD,INTC,QCOM --output plot --plot_type bar --period_type Q`
`i8 metrics historical --metrics total_revenue,total_assets --tickers AMD,INTC,QCOM --output terminal --period_type FY --pivot`
Usage:
i8 metrics historical [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--tickers, -k |
ticker | Comma-separated list of tickers. | required |
--metrics, -m |
metric | Comma-separated list of daily metrics. | pe_ratio_ttm |
--output, -o |
outputtype | Output can be terminal or plot. | terminal |
--plot_type, -p |
charttype | Plot can be bar or line chart. | required |
--pivot, -pv |
boolean | Output will be pivot table. | False |
--period_type, -t |
periodtype | Period by which you want to view the report. Possible values are D for daily, FY for yearly, Q for quarterly, TTM for TTM reports, YTD for YTD reports. |
required |
--from_date, -f |
datetime (%Y-%m-%d | %Y-%m-%dT%H:%M:%S | %Y-%m-%d %H:%M:%S) |
Histotical metrics from date. | required |
--to_date, -t |
datetime (%Y-%m-%d | %Y-%m-%dT%H:%M:%S | %Y-%m-%d %H:%M:%S) |
Histotical metrics to date. | required |
--help |
boolean | Show this message and exit. | False |
i8 metrics search
Searches and shows all metrics that match with the given KEYWORD.
Examples:
`i8 metrics search --keyword return`
Usage:
i8 metrics search [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--keyword, -k |
text | Keyword can be metric name. | required |
--help |
boolean | Show this message and exit. | False |
i8 news
Get the latest financial markets news.
Usage:
i8 news [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 news list
Lists the latest market news for a given ticker.
Examples:
`i8 news list --ticker AAPL`
Usage:
i8 news list [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--ticker, -k |
ticker | Ticker or company name. | required |
--help |
boolean | Show this message and exit. | False |
i8 notebook
Run notebook commands.
Usage:
i8 notebook [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 notebook launch
Launches jupyter notebook.
Examples:
`i8 notebook launch --name mynotebook`
Usage:
i8 notebook launch [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
text | Notebook file name. | required |
--help |
boolean | Show this message and exit. | False |
i8 price
Get the latest and historical security prices.
Usage:
i8 price [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 price compare
Compares historical prices of given companies. TICKERS is a comma-separated list of tickers.
Examples:
`i8 price compare --period 3Y --tickers AMD,INTC,QCOM`
Usage:
i8 price compare [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--period, -p |
priceperiod | Historical price period. | 1M |
--from_date, -f |
datetime (%Y-%m-%d | %Y-%m-%dT%H:%M:%S | %Y-%m-%d %H:%M:%S) |
Histotical price from date. | required |
--to_date, -t |
datetime (%Y-%m-%d | %Y-%m-%dT%H:%M:%S | %Y-%m-%d %H:%M:%S) |
Histotical price to date. | required |
--tickers, -k |
ticker | Comma-separated list of tickers. | required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 price list
Lists historical prices for a given TICKER.
Examples:
`i8 price list --period 3M --ticker AAPL`
Usage:
i8 price list [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--ticker, -k |
ticker | Company ticker. | required |
--period, -p |
priceperiod | Historical price period. | 1M |
--from_date, -f |
datetime (%Y-%m-%d | %Y-%m-%dT%H:%M:%S | %Y-%m-%d %H:%M:%S) |
Histotical price from date. | required |
--to_date, -t |
datetime (%Y-%m-%d | %Y-%m-%dT%H:%M:%S | %Y-%m-%d %H:%M:%S) |
Histotical price to date. | required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 price plot
Plots historical prices of a given company.
Examples:
`i8 price plot --period 1M --indicators volume --ticker MSFT --chart_type candlestick`
Usage:
i8 price plot [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--ticker, -k |
ticker | Company ticker. | required |
--period, -p |
priceperiod | Historical price period. | 1M |
--indicators, -i |
indicator | Optional technical indicators to enrich the chart. | required |
--from_date, -f |
datetime (%Y-%m-%d | %Y-%m-%dT%H:%M:%S | %Y-%m-%d %H:%M:%S) |
Histotical price from date. | required |
--to_date, -t |
datetime (%Y-%m-%d | %Y-%m-%dT%H:%M:%S | %Y-%m-%d %H:%M:%S) |
Histotical price to date. | required |
--chart_type, -c |
charttype | Chart can be candlestick or line chart. | line |
--help |
boolean | Show this message and exit. | False |
i8 screen
Screen the market to find stocks that match your criteria.
Usage:
i8 screen [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 screen gainers
Lists today winner companies.
Examples:
`i8 screen gainers --index $SPX`
Usage:
i8 screen gainers [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--index, -i |
marketindice | Index of market. | $SPX |
--view_name, -v |
metricview | Metric view name in configuration file. | required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 screen list
Usage:
i8 screen list [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 screen losers
Lists today loser companies.
Examples:
`i8 screen losers --index $SPX`
Usage:
i8 screen losers [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--index, -i |
marketindice | Index of market. | $SPX |
--view_name, -v |
metricview | Metric view name in configuration file. | required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 screen search
Usage:
i8 screen search [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--profile, -p |
screeningprofile | Screening profile name. | required |
--condition, -c |
screeningcondition | Condition of metric. | required |
--view_name, -v |
metricview | Metric view name. | required |
--metrics, -m |
metricidentifier | Comma-separated list of daily metrics. | required |
--export, -e |
text | Filename to export the output to. | required |
--sort_by, -sb |
metricidentifier | Metric to sort the output by. | required |
--sort_order, -so |
sortordertype | Order to sort the output by. | required |
--include_period, -ip |
boolean | Output will contain the periods. | False |
--help |
boolean | Show this message and exit. | False |
i8 shell
Open i8-shell.
Usage:
i8 shell [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 user
Users commands.
Usage:
i8 user [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 user login
Usage:
i8 user login [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--terminal |
boolean | Login with your credentials in the console (Only applicable if you have a local Investoreight account). | False |
--help |
boolean | Show this message and exit. | False |
i8 user logout
Usage:
i8 user logout [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 version
Get i8-terminal version.
Usage:
i8 version [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 watchlist
Get information about user watchlists.
Usage:
i8 watchlist [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 watchlist add
Adds given tickers to a given watchlist.
Examples:
`i8 watchlist add --name MyWatchlist --tickers AAPL,MSFT`
Usage:
i8 watchlist add [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
userwatchlists | Name of the watchlist. | required |
--tickers, -k |
ticker | Comma-separated list of tickers. | required |
--help |
boolean | Show this message and exit. | False |
i8 watchlist create
Creates new watchlist with given name and tickers.
Examples:
`i8 watchlist create --name MyWatchlist --tickers AAPL,MSFT`
Usage:
i8 watchlist create [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
text | Name of the watchlist you want to create. | required |
--tickers, -k |
ticker | Comma-separated list of tickers. | required |
--help |
boolean | Show this message and exit. | False |
i8 watchlist export
Exports a given watchlist to an excel file.
Examples:
`i8 watchlist export --name MyWatchlist --path MyWatchlist.xlsx`
Usage:
i8 watchlist export [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
userwatchlists | Name of the watchlist. | required |
--path, -p |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 watchlist financials
Lists financial metrics for a given watchlist.
Examples:
`i8 watchlist financials --name MyWatchlist`
Usage:
i8 watchlist financials [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
userwatchlists | Name of the watchlist. | required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |
i8 watchlist list
Lists user watchlists.
Examples:
`i8 watchlist list`
Usage:
i8 watchlist list [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
i8 watchlist metrics
Lists and compares watchlist companies based on a given list of metrics.
Examples:
`i8 watchlist metrics --name MyWatchlist --metrics total_revenue,net_income,price_to_earnings`
Usage:
i8 watchlist metrics [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
userwatchlists | Name of the watchlist. | required |
--metrics, -m |
metric | Comma-separated list of daily metrics. | required |
--export, -e |
text | Filename to export the output to. | required |
--view_name, -v |
metricview | Metric view name in configuration file. | required |
--help |
boolean | Show this message and exit. | False |
i8 watchlist rm
Removes given tickers from a given watchlist.
Examples:
`i8 watchlist rm --name MyWatchlist --tickers AAPL,MSFT`
Usage:
i8 watchlist rm [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
userwatchlists | Name of the watchlist. | required |
--tickers, -k |
userwatchlisttickers | Comma-separated list of tickers. | required |
--help |
boolean | Show this message and exit. | False |
i8 watchlist summary
Lists a summary of the companies added to a watchlist.
Examples:
`i8 watchlist summary --name MyWatchlist`
Usage:
i8 watchlist summary [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name, -n |
userwatchlists | Name of the watchlist. | required |
--export, -e |
text | Filename to export the output to. | required |
--help |
boolean | Show this message and exit. | False |