Skip to main content

download.download_data_wrds()

Download data from WRDS.

Usage

Source

download.download_data_wrds(
    dataset=None, start_date=None, end_date=None, type=None, **kwargs
)

Acts as a wrapper to download data from various WRDS datasets including CRSP, Compustat, and CCM links based on the specified dataset. It is designed to handle different datasets by redirecting to the appropriate specific data download function.

Parameters

dataset: str = None

A string specifying the dataset to download. Supported values are ‘crsp_monthly’ and ‘crsp_daily’ for CRSP data, ‘compustat_annual’ and ‘compustat_quarterly’ for Compustat data, ‘ccm_links’ for CCM links data, ‘fisd’ for FISD data, or ‘trace_enhanced’ for TRACE data.

start_date: str = None

A character string or date in ‘YYYY-MM-DD’ format specifying the start date for the data. If not provided, a subset of the dataset is returned.

end_date: str = None

A character string or date in ‘YYYY-MM-DD’ format specifying the end date for the data. If not provided, a subset of the dataset is returned.

type: str = None

Deprecated. Use ‘dataset’ instead. If supplied, a leading ‘wrds_’ prefix is stripped and a DeprecationWarning is emitted.

**kwargs
Additional arguments passed to specific download functions depending on the ‘dataset’. For instance, ‘quiet=True’ suppresses the messages about the WRDS connection and the download progress.

Returns

pl.DataFrame
A data frame containing the requested data, with the structure and contents depending on the specified ‘dataset’.

Examples

from tidyfinance import download_data_wrds
crsp_monthly = download_data_wrds(
    'crsp_monthly', '2020-01-01', '2020-12-31'
)
compustat_annual = download_data_wrds(
    'compustat_annual', '2020-01-01', '2020-12-31'
)
ccm_links = download_data_wrds('ccm_links')
fisd = download_data_wrds('fisd')
trace_enhanced = download_data_wrds(
    'trace_enhanced', cusips=['00101JAH9']
)