call_report.fca.get_fca_domain_dataset#

call_report.fca.get_fca_domain_dataset(*, domain_dataset: FCADomainDataset | str) → DomainDataset[source]#

Return one curated domain dataset’s shipped definition.

Parsed from the packaged JSON on the first call for domain_dataset, then cached for the life of the process.

Parameters:

domain_datasetFCADomainDataset or str: The domain dataset to look up. A string is matched case-insensitively.

Returns:

DomainDataset: The dataset’s curated definition.

Raises:

DomainDatasetNotFoundError: If domain_dataset does not name a shipped dataset.

Examples

>>> from call_report.fca import get_fca_domain_dataset
>>> dataset = get_fca_domain_dataset(domain_dataset="loan_portfolio")
>>> dataset.code_column
'LOAN_PORTFOLIO'
>>> len(dataset.codes)
13