Metadata-Version: 2.4
Name: calcfidata
Version: 0.1.0
Summary: Python client for CalcFi Open Data — 34 CC-BY financial and macroeconomic time series mirrored from primary sources (FRED, BLS, Freddie Mac, US Treasury, BEA, World Bank)
Author-email: Jere Salmisto <jere.salmisto@gmail.com>
License: CC-BY-4.0
Project-URL: Homepage, https://calcfi.app
Project-URL: Documentation, https://calcfi-open-data-4a2bc1.gitlab.io/
Project-URL: Repository, https://gitlab.com/jere.salmisto/calcfi-open-data
Project-URL: Bug Tracker, https://gitlab.com/jere.salmisto/calcfi-open-data/-/issues
Project-URL: Hugging Face Dataset, https://huggingface.co/datasets/iizy/calcfi-open-data
Project-URL: Permanent DOI, https://doi.org/10.6084/m9.figshare.32332290
Keywords: finance,economics,macroeconomics,open-data,fred,bls,time-series,mortgage,treasury,cpi,calcfi
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: pandas>=2.0.0
Requires-Dist: requests>=2.28.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"

# calcfidata

Python client for [**CalcFi Open Data**](https://huggingface.co/datasets/iizy/calcfi-open-data) — 34 free CC-BY financial and macroeconomic time series mirrored from primary sources (FRED, BLS, Freddie Mac, US Treasury, BEA, World Bank, Federal Reserve).

[![PyPI](https://img.shields.io/pypi/v/calcfidata)](https://pypi.org/project/calcfidata/)
[![Dataset DOI](https://img.shields.io/badge/Dataset%20DOI-10.6084%2Fm9.figshare.32332290-blue)](https://doi.org/10.6084/m9.figshare.32332290)
[![License](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey)](https://creativecommons.org/licenses/by/4.0/)

## Install

```bash
pip install calcfidata
```

## Quick start

```python
import calcfidata as cf

# load a single series
df = cf.load("30-year-fixed")
print(df.tail())

# list every available series
catalog = cf.list_series()
print(catalog.head())

# load several series joined on date
inflation = cf.multi(["cpi", "pce"], align_on="inner")
print(inflation.tail())

# get the Frictionless datapackage metadata for any series
meta = cf.metadata("cpi")
print(meta["sources"][0]["title"])
```

## What's included

34 time series across:

- **Mortgage rates** — 30-year, 15-year fixed (Freddie Mac PMMS)
- **Treasury yields** — 2Y, 10Y constant maturity (US Treasury)
- **Fed Funds + Prime + credit-card APR** (Federal Reserve)
- **Inflation** — CPI-U, PCE, world inflation (BLS, BEA, World Bank)
- **Employment** — unemployment rate, labor-force participation, hourly earnings (BLS)
- **Energy** — WTI, Brent crude, US regular gasoline (EIA)
- **FX** — USD/EUR, USD/GBP, USD/JPY (Federal Reserve H.10)
- **Commodities** — copper, corn (World Bank)
- **Macro** — US + Eurozone GDP per capita, world unemployment (World Bank)
- **Consumer credit** — credit card APR, personal loan, auto loan rates (Fed G.19)
- **Crypto** — Bitcoin, Ethereum, Solana (CoinGecko — snapshot-only currently)
- **Deposit rates** — savings, money-market, CDs (FDIC — snapshot-only currently)

Each series carries primary-source provenance in the `# Source:` and `# Primary URL:` comment headers of its CSV.

## Methodology + citation

- **Methodology paper:** under review at SSRN, published as a working paper at <https://calcfi-open-data-4a2bc1.gitlab.io/methodology.html>
- **Mirrors:** [Hugging Face](https://huggingface.co/datasets/iizy/calcfi-open-data) · [GitHub](https://github.com/jerehere/calcfi-open-data) · [GitLab](https://gitlab.com/jere.salmisto/calcfi-open-data)
- **Permanent DOIs:** [Figshare](https://doi.org/10.6084/m9.figshare.32332290) · [Zenodo](https://doi.org/10.5281/zenodo.20302283) · [OSF](https://doi.org/10.17605/OSF.IO/PUMKT) · [Kaggle](https://doi.org/10.34740/kaggle/dsv/16356447) · [Mendeley](https://doi.org/10.17632/jsnwhy6vjn.1)
- **Companion visualizations:** [10 Hugging Face Spaces](https://huggingface.co/iizy) · [3 Observable notebooks](https://observablehq.com/@iizy) · [6 CodePen demos](https://codepen.io/collection/BawbdB) · [Live SQL Datasette](https://calcfi-open-data.fly.dev/)

## Citation

```bibtex
@dataset{salmisto_2026_calcfi_open_data,
  author       = {Salmisto, Jere},
  title        = {CalcFi Open Data: 34 Free CC-BY Financial and Macro Time Series Mirrored from Primary Sources},
  year         = 2026,
  publisher    = {Figshare},
  doi          = {10.6084/m9.figshare.32332290},
  url          = {https://doi.org/10.6084/m9.figshare.32332290},
  orcid        = {0009-0000-0916-8684},
  license      = {CC-BY-4.0}
}
```

> Salmisto, J. (2026). *CalcFi Open Data: 34 Free CC-BY Financial and Macro Time Series Mirrored from Primary Sources* [Dataset]. Figshare. <https://doi.org/10.6084/m9.figshare.32332290>

## License

- **Package code:** MIT
- **Underlying data:** CC BY 4.0 — attribution to CalcFi and the named primary source for each series

## Live tools

For 300+ free personal-finance calculators built on the same primary-source data layer, see [calcfi.app](https://calcfi.app).
