Back to Worldmonitor

worldmonitor-sdk

sdk/python/README.md

2.10.02.3 KB
Original Source

worldmonitor-sdk

Official Python SDK for the World Monitor global-intelligence API — country briefs, risk scores, conflict / cyber / market / news feeds, and every MCP tool, without writing an HTTP integration.

Stdlib-only (zero dependencies), MCP-first: the same design as the official worldmonitor npm CLI. The MCP server is the live, documented agent surface; a small REST escape hatch rounds it out.

Install

sh
pip install worldmonitor-sdk

Quickstart

python
from worldmonitor_sdk import Client

client = Client(api_key="wm_...")  # or set WORLDMONITOR_API_KEY

client.list_tools()                          # public — no key needed
client.country_risk("IR")                    # curated helper
client.conflict_events(country="IR", limit=5)
client.call_tool("get_market_data", asset_class="crypto")  # any MCP tool
client.get("/api/health")                    # raw REST GET

Data calls (tools/call) need a user API key — get one at worldmonitor.app/pro. Listing tools, prompts, and resources is public.

Server-side projection

Every tool accepts an optional jmespath argument that projects the response server-side (typically an 80–95% size cut):

python
client.world_brief(jmespath="hotspots[].name")

See the JMESPath guide for worked examples.

Errors

  • worldmonitor_sdk.MCPError — the MCP server returned a JSON-RPC error (.code, auth failures carry a key hint).
  • worldmonitor_sdk.APIError — a REST/transport failure (.status, .body).

Both derive from worldmonitor_sdk.WorldMonitorError.

Configuration

Constructor argEnvironment variableDefault
api_keyWORLDMONITOR_API_KEY (or WM_API_KEY)
base_urlWORLDMONITOR_BASE_URLhttps://api.worldmonitor.app
mcp_urlWORLDMONITOR_MCP_URLhttps://worldmonitor.app/mcp
timeout30.0 seconds

The source lives in sdk/python/ in the main repository. Docs: worldmonitor.app/docs/sdks. License: MIT (thin client; the World Monitor platform itself remains AGPL-3.0).