DOCS & QUICKSTARTS

Build on WealthSchema in five minutes.

Three task-based quickstarts. Pull a cited planning figure, grab a synthetic household sample, or evaluate an agent against the free benchmark. Official JS and Python SDKs, or plain HTTP.

INSTALL THE SDK

One client for the public surfaces.

The SDK wraps the free surfaces only. It has no method to download the corpus, which is a one-time purchase, not an API.

npm install wealthschema
pip install wealthschema
QUICKSTART 1

Pull a cited planning figure.

Every value carries its issuer, document, section, and effective date, over the API or an MCP server. Try it on the free sample of 10 headline figures; a paid key unlocks every figure.

import { WealthSchema } from "wealthschema";
const ws = new WealthSchema(); // free sample without a key; pass { apiKey } for every figure

const fact = await ws.getFact(
  "us-federal-2026",
  "retirement.401k.elective_deferral.under_50"
);
console.log(fact.value, fact.source);
// 24500  { issuer: "IRS", document: "Notice 2025-67", section: "402(g)(1)" }

Or plain HTTP:

curl https://www.wealthschema.com/api/reference/v1/us-federal-2026

Or over MCP (Claude, Cursor, your app):

{ "mcpServers": { "wealthschema": { "url": "https://www.wealthschema.com/api/mcp" } } }
Rule Sets details
QUICKSTART 2

Grab a synthetic household sample.

A small free sample: 8 deliberately insufficient households (PII removed, amounts banded, trajectory truncated) to prove fidelity. The full validated corpus is a one-time purchase.

const manifest = await ws.getManifest();        // archetypes + bundle taxonomy
const sample = await ws.getSampleHousehold("young-family-first-home");
// evaluation-only: banded amounts, 12 of 96 months, projections withheld
Browse the Data Sets
QUICKSTART 3

Evaluate an agent against the free benchmark.

Tasks with source-grounded, deterministic ground-truth answers. Pull them blind, run your agent, then score against the answer key.

const blind = await ws.getBenchmark({ withholdAnswers: true }); // no answers
// ... run your agent over blind.tasks ...
const key = await ws.getBenchmark();                            // full answer key
DecisionSynth details
FAQ

Frequently asked questions

Do I need an API key?+

Not for the free sample: without a key you get 10 headline federal figures. Every figure (federal and state) comes with a paid Rule Sets plan from $49/month; subscribe at /account/api-keys, then pass the key to the SDK as apiKey, or set WEALTHSCHEMA_API_KEY.

Is there an API to download the full household corpus?+

No. The corpus is a one-time purchase delivered as files after checkout, not a metered API. The sample endpoints are deliberately insufficient (banded amounts, truncated trajectories) for evaluation only.

Can an AI agent use the cited figures directly?+

Yes, over MCP. Point Claude, Cursor, or your app at https://www.wealthschema.com/api/mcp and it can look up a cited figure on demand with the source attached.