Skip to main content

Python client for the MoneyFeel Macro & Geopolitical Risk Index API

Project description

moneyfeel-mri

Python client for the moneyfeel Macro & Geopolitical Risk Index.

PyPI version Python 3.8+ License: CC BY-NC 4.0

Free programmatic access to the moneyfeel MRI — an institutional-grade macro regime classifier covering 5 regions (GLOBAL, US, EU, ASIA, EM) across 3 timeframes (Daily, Weekly, Monthly), updated daily.


Installation

pip install moneyfeel-mri

# With pandas support (recommended)
pip install moneyfeel-mri[pandas]

Get a Free API Key

  1. Register at moneyfeel.it — free, no credit card
  2. Go to your account page
  3. Find the MRI API Access section → Generate API Key

Quick Start

from moneyfeel import MRI

client = MRI("mf_live_YOUR_KEY")

# Current regime — no auth required
current = client.current()
for region in current:
    print(region["region"], region["regime_weekly"], region["score_weekly"])

# Historical data as pandas DataFrame
df = client.history_df("US", "WEEKLY", from_date="2020-01-01")
print(df.tail())

# Latest regime
latest = client.latest("EU", "WEEKLY")
print(f"EU: {latest['regime']} | score={latest['mri_score']}")

# Performance metrics
m = client.metrics("US", "WEEKLY")[0]
print(f"Sharpe: {m['sharpe']} | CAGR: {m['cagr_strategy']}% | MaxDD: {m['max_dd']}%")

# Full CSV download
df_full = client.download("US", "WEEKLY")           # returns DataFrame
client.download("US", "WEEKLY", "us_weekly.csv")    # saves to file

All Methods

Method Auth Description
current() No Current regime for all 5 regions
status() No API health check
regions() No Available regions and timeframes
history(region, tf, from_date, to_date) Yes Historical regime data
history_df(region, tf, from_date, to_date) Yes Same, as pandas DataFrame
latest(region, tf) Yes Most recent regime record
metrics(region, tf) Yes Strategy performance KPIs
timeseries(region, tf, from_date) Yes Daily return series
timeseries_df(region, tf, from_date) Yes Same, as pandas DataFrame
eoy(region, tf) Yes Year-by-year returns
drawdowns(region, tf) Yes Top 10 drawdown periods
download(region, tf, output_path) Yes Full CSV dataset

Error Handling

from moneyfeel import MRI, MRIAuthError, MRIRateLimitError
import time

client = MRI("mf_live_YOUR_KEY")

try:
    data = client.history("US", "WEEKLY")
except MRIAuthError:
    print("Invalid or revoked key — get a new one at moneyfeel.it/account")
except MRIRateLimitError as e:
    print(f"Rate limited — retry after {e.retry_after}s")
    time.sleep(e.retry_after)

Data Coverage

  • Regions: GLOBAL · US · EU · ASIA · EM
  • Timeframes: DAILY · WEEKLY · MONTHLY
  • History: 2007-01-04 to present
  • Updated: daily at market close

Rate Limits

Limit Value
Requests/minute 30
Requests/day 2,000
History Full (2007+)
Cost Free

Links

License

CC BY-NC 4.0 — free for research and non-commercial use.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

moneyfeel_mri-1.0.2.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

moneyfeel_mri-1.0.2-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file moneyfeel_mri-1.0.2.tar.gz.

File metadata

  • Download URL: moneyfeel_mri-1.0.2.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for moneyfeel_mri-1.0.2.tar.gz
Algorithm Hash digest
SHA256 a4967f2e6199a52e5beef3fc3e3823a6b3e337bc42e123f12f46f2e9454f5e99
MD5 e8a304cb27683ef2e2263ae783467a05
BLAKE2b-256 9386823bce80ef46fd43d3ab75cc8d591399a1039c903595d5cb8ec794d03b67

See more details on using hashes here.

File details

Details for the file moneyfeel_mri-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: moneyfeel_mri-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for moneyfeel_mri-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bc9dfe78b617aa14c8788d976d02c4090801c5b81f23c7b74add9d04fa3b85af
MD5 c9521507ff446192f28826322d5e9536
BLAKE2b-256 4e5dfeefdd91c8197a91e850e5254371e31aaa939ceee65125db35376cca39a8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page