Metadata-Version: 2.4
Name: mostlyrightmd-economy
Version: 4.1.0
Summary: Economic-indicator data for Python — CPI, PPI, nonfarm payrolls, unemployment, GDP, jobless claims, Fed decisions — from FRED/ALFRED, BLS, BEA, DOL, Federal Reserve. First-print vintage discipline for prediction-market settlement. Imports as `mostlyright.economy`.
Project-URL: Homepage, https://mostlyright.md
Project-URL: Documentation, https://mostlyright.md/docs/sdk/
Project-URL: Repository, https://github.com/mostlyrightmd/mostlyright-sdk
Project-URL: Issues, https://github.com/mostlyrightmd/mostlyright-sdk/issues
Project-URL: Changelog, https://github.com/mostlyrightmd/mostlyright-sdk/blob/main/CHANGELOG.md
Author-email: Robert Tarabcak <tarabcakr@gmail.com>
License-Expression: MIT
Keywords: alfred,backtesting,bea,bls,cpi,economic-data,economic-indicators,fed,first-print,fomc,fred,gdp,jobless-claims,kalshi,macro,ml-training-data,nonfarm-payrolls,polymarket,ppi,prediction-markets,settlement,unemployment,vintage
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Requires-Dist: filelock>=3.12
Requires-Dist: httpx>=0.27
Requires-Dist: jsonschema>=4.21
Requires-Dist: mostlyrightmd-core<4.2.0,>=4.1.0
Requires-Dist: pyarrow<24.0,>=17.0
Requires-Dist: tzdata; sys_platform == 'win32'
Description-Content-Type: text/markdown

# mostlyrightmd-economy

Economic-indicator data for the `mostlyright` Python SDK — CPI, PPI, nonfarm payrolls (NFP), unemployment, GDP, jobless claims, and Fed decisions — sourced from FRED/ALFRED, BLS, BEA, DOL, and the Federal Reserve, joined to Kalshi and Polymarket economy markets with publication vintages attached. Agency sources are fetched directly; their addresses resolve through the hosted manifest catalog, which requires `MOSTLYRIGHT_API_KEY` (subscriptions at <https://app.mostlyright.md>). Imports as `mostlyright.economy`.

The public API includes `economy.series()` for historical releases,
`economy.snapshot()` for the settlement-grade value knowable at a cutoff (the
first print, never a later revision), `economy.releases()` for the release
calendar, and `economy.training_table()` for joined market and release rows.
`series()` and `snapshot()` exclude revisions published after the requested
cutoff; `training_table(as_of=...)` instead raises `LeakageError` when a
later-published row would enter the join. See
[`docs/economy-vertical.md`](../../docs/economy-vertical.md) for every method and
parameter.

## Install

```bash
pip install mostlyrightmd-economy          # brings mostlyrightmd transitively
```

## Data sources & required notices

This product uses the FRED® API but is not endorsed or certified by the Federal
Reserve Bank of St. Louis. This product uses the Bureau of Economic Analysis
(BEA) Data API but is not endorsed or certified by BEA. BLS, BEA, DOL, and
Federal Reserve Board data are US-government works in the public domain;
citations to the source agencies are appreciated. Per the
[BLS Terms of Service](https://www.bls.gov/developers/termsOfService.htm), when
you publish results derived from BLS data retrieved via this SDK, cite the
retrieval date and state: "BLS.gov cannot vouch for the data or analyses derived
from these data after the data have been retrieved from BLS.gov." Nothing in this package is
endorsed by, or implies endorsement by, any source agency or Reserve Bank.

The **default path makes no FRED call** (the agency sources need no key of
their own; the SDK's `MOSTLYRIGHT_API_KEY` addresses only the manifest
catalog). The FRED/ALFRED vintage path is
opt-in via your own free `FRED_API_KEY` and is governed by the
[FRED® API Terms of Use](https://fred.stlouisfed.org/docs/api/terms_of_use.html)
(which, among other things, prohibits storing/caching FRED content and using it
in ML training) — your key, your acceptance. The weekly jobless-claims fetcher
also transports its bytes through FRED (`ICSA`/`ICNSA`) because DOL's
machine-readable path is bot-walled. See the
[data-sources & licensing section](../../docs/economy-vertical.md#data-sources-licensing--required-notices)
for the per-source table.

## Docs

See <https://mostlyright.md/docs/sdk/> for quickstart and the full API reference.
