wealthschema (Python)
Official Python SDK for WealthSchema — the data layer for building and testing financial software. Zero dependencies (standard library only).
It wraps WealthSchema's public, free surfaces:
- Rule Sets — cited, current U.S. planning figures (IRS, SSA, CMS, Treasury) with issuer, document, section, and effective date.
- Evaluation samples — one deliberately-insufficient synthetic household per archetype.
- Free Planning Benchmark — tasks with ground-truth answers for evaluating AI financial-advisor agents.
- Catalog — the product catalog.
The full synthetic-household corpus is a one-time purchase, delivered as files after checkout — not a metered API. This SDK intentionally has no method to download it. Samples are banded and truncated for evaluation only.
Install
pip install wealthschema
Quickstart
from wealthschema import WealthSchema
ws = WealthSchema() # or WealthSchema(api_key="...") ; falls back to WEALTHSCHEMA_API_KEY
# A cited planning figure, with its source and effective date:
fact = ws.get_fact("us-federal-2026", "retirement.401k.elective_deferral.under_50")
print(fact["value"], fact["source"]) # 24500 {'issuer': 'IRS', 'document': 'Notice 2025-67', ...}
# A sample synthetic household (evaluation only):
sample = ws.get_sample_household("young-family-first-home")
# The free Planning Benchmark for agent evals:
bench = ws.get_benchmark(withhold_answers=True) # omit for the answer key
Get a free API key at https://www.wealthschema.com/account/api-keys. The free tier works without a key.
API
| Method | Returns |
|---|---|
list_reference_datasets() |
Reference index + tier matrix |
get_reference_dataset(id) |
All cited facts for a dataset |
get_fact(id, key) |
One cited fact by key, or None |
get_manifest() |
Archetype/bundle taxonomy + sample links |
get_sample_household(archetype_id) |
One insufficient sample household |
get_catalog() |
Product catalog |
get_benchmark(withhold_answers=False) |
Free Planning Benchmark tasks |
Requests raise WealthSchemaError with .status and .code (e.g. code="rate_limited" on HTTP 429).
MCP
Rule Sets is also an MCP server:
{ "mcpServers": { "wealthschema": { "url": "https://www.wealthschema.com/api/mcp" } } }
License
MIT. Data and API use are governed by the feed terms and per-purchase license.
Metadata
Release files for wealthschema 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| wealthschema-0.1.0.tar.gz | 3.8 kB | Without provenance | Details for wealthschema-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| wealthschema-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for wealthschema-0.1.0-py3-none-any.whl |
Total release size: 8.2 kB
Release files / wealthschema-0.1.0.tar.gz
| Download URL | wealthschema-0.1.0.tar.gz |
|---|---|
| Size | 3.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dd9d6da4eb3c4eab11af6e7567304283d0bc563b034a2e12427ac27267fe5f55
|
|
BLAKE2b-256 checksum How to use checksums |
b8ef8a553d0716a9b1942766083b2de1f6dbaf9f030959873be896ce7a89bed4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
Release files / wealthschema-0.1.0-py3-none-any.whl
| Download URL | wealthschema-0.1.0-py3-none-any.whl |
|---|---|
| Size | 4.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4969516d9f58bf1e9ced23386c22059c66d59c89f4bf49601d68b1c2d2cbf462
|
|
BLAKE2b-256 checksum How to use checksums |
ea02bb51456b239cc783d32de30fdb64c1e8e7c354a7fd1930d2fdff98c2f7d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
Security for wealthschema 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.