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.1.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.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: moneyfeel_mri-1.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 d5a3d7e0a05d444ff71c2022d2eb04c1958aca62b638181ed9d1df68f6efdb20
MD5 ee435a060e4981369ba8308f9cf8a7c9
BLAKE2b-256 a602319a10607ba0600e2d531beae5803aaec227594e5552f22dff72d3b74a05

See more details on using hashes here.

File details

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

File metadata

  • Download URL: moneyfeel_mri-1.0.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c7aba229b21741d5b1eb163f456e155e353e5e0e1667b6b744e52a92785fa9ca
MD5 ed32650dd6b736be1df1365f73bbf753
BLAKE2b-256 4a8908f8cc4778bef803b077300f6585a76f144cf46f8c3421b4e45590e5b9e3

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