tq_index: Get all stocks in a stock index or stock exchange in 'tibble'...

View source: R/tq_stock_list.R

tq_indexR Documentation

Get all stocks in a stock index or stock exchange in tibble format

Description

Get all stocks in a stock index or stock exchange in tibble format

Usage

tq_index(x, use_fallback = FALSE)

tq_index_options()

tq_exchange(x)

tq_exchange_options()

tq_fund_holdings(x, source = "SSGA")

tq_fund_source_options()

Arguments

x

A single character string, a character vector or tibble representing a single stock index or multiple stock indexes.

use_fallback

A boolean that can be used to return a fallback data set last downloaded when the package was updated. Useful if the website is down. Set to FALSE by default.

source

The API source to use.

Details

tq_index() returns the stock symbol, company name, weight, and sector of every stock in an index.

tq_index_options() returns a list of stock indexes you can choose from.

tq_exchange() returns the stock symbol, company, last sale price, market capitalization, sector and industry of every stock in an exchange. Three stock exchanges are available (AMEX, NASDAQ, and NYSE).

tq_exchange_options() returns a list of stock exchanges you can choose from. The options are AMEX, NASDAQ and NYSE.

tq_fund_holdings() returns the the stock symbol, company name, weight, and sector of every stock in an fund. The source parameter specifies which investment management company to use. Example: source = "SSGA" connects to State Street Global Advisors (SSGA). If x = "SPY", then SPDR SPY ETF holdings will be returned.

tq_fund_source_options(): returns the options that can be used for the source API for tq_fund_holdings().

Value

Returns data in the form of a tibble object.

See Also

tq_get() to get stock prices, financials, key stats, etc using the stock symbols.

Examples


# Stock Indexes:

# Get the list of stock index options
tq_index_options()

# Get all stock symbols in a stock index
## Not run: 
tq_index("DOW")

## End(Not run)

# Stock Exchanges:

# Get the list of stock exchange options
tq_exchange_options()

# Get all stocks in a stock exchange
## Not run: 
tq_exchange("NYSE")

## End(Not run)

# Mutual Funds and ETFs:

# Get the list of stock exchange options
tq_fund_source_options()

# Get all stocks in a fund
## Not run: 
tq_fund_holdings("SPY", source = "SSGA")

## End(Not run)


business-science/tidyquant documentation built on Sept. 2, 2024, 11:06 p.m.