WeUltrarich SDK
We > Ultrarich API client, generated from the OpenAPI spec.
How much is billions or trillions of dollars?
Learn more about We > Ultrarich API at api.wegtultrarich.org/README.md.
This is an unofficial SDK for the We > Ultrarich public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.
Learn more about Voxgig SDKs at voxgig.com/sdk.
Metadata kindly supplied by www.freepublicapis.com.
TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.
Entities, not endpoints
This SDK exposes the API as a small set of semantic entities — Comparison, Discovery and WealthExpression — that you
call directly, instead of assembling URL paths and query strings. Entities are
Capitalised to mark them as the primary surface, each with the operations they
support (list, load):
const client = new WeUltrarichSDK()
const comparison = await client.Comparison().load()
Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.
Offline unit testing
Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:
TypeScript
const client = WeUltrarichSDK.test()
const comparison = await client.Comparison().load()
// comparison is a bare Comparison populated with mock data
console.log(comparison)
Python
client = WeUltrarichSDK.test()
comparison = client.Comparison().load()
print(comparison)
PHP
// Seed fixture data so offline calls resolve without a live server.
$client = WeUltrarichSDK::test([
"entity" => ["comparison" => ["test01" => []]],
]);
$comparison = $client->Comparison()->load();
Golang
client := sdk.Test()
result, err := client.Comparison(nil).Load(
nil, nil,
)
Ruby
# Seed fixture data so offline calls resolve without a live server.
client = WeUltrarichSDK.test({
"entity" => { "comparison" => { "test01" => {} } },
})
comparison = client.Comparison.load()
Lua
local client = sdk.test()
local result, err = client:Comparison():load()
Packages
| Language | Package | Install |
|---|---|---|
| TypeScript | @voxgig-sdk/we-ultrarich | publish pending — install from git tag |
| Python | voxgig-sdk-we-ultrarich | publish pending — install from git tag |
| PHP | voxgig-sdk/we-ultrarich | publish pending — install from git tag |
| Golang | github.com/voxgig-sdk/we-ultrarich-sdk/go | go get github.com/voxgig-sdk/we-ultrarich-sdk/go@latest |
| Ruby | voxgig-sdk-we-ultrarich | publish pending — install from git tag |
| Lua | voxgig-sdk-we-ultrarich | publish pending — install from git tag |
| Go CLI | github.com/voxgig-sdk/we-ultrarich-sdk/go-cli | go install github.com/voxgig-sdk/we-ultrarich-sdk/go-cli/cmd/we-ultrarich@latest |
| Go MCP server | github.com/voxgig-sdk/we-ultrarich-sdk/go-mcp | go get github.com/voxgig-sdk/we-ultrarich-sdk/go-mcp@latest |
Quickstart
TypeScript
import { WeUltrarichSDK } from '@voxgig-sdk/we-ultrarich'
const client = new WeUltrarichSDK()
// Load comparison data (returns a Comparison)
const comparison = await client.Comparison().load()
console.log(comparison)
See the TypeScript README for the full guide.
Surfaces
| Surface | Path |
|---|---|
| SDK (TypeScript, Python, PHP, Golang, Ruby, Lua) | ts/ py/ php/ go/ rb/ lua/ |
| CLI | go-cli/ |
| MCP server | go-mcp/ |
Use it from an AI agent (MCP)
The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:
cd go-mcp && go build -o we-ultrarich-mcp .
Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):
{
"mcpServers": {
"we-ultrarich": {
"command": "/abs/path/to/we-ultrarich-mcp"
}
}
}
Entities
The API exposes 3 entities:
| Entity | Description | API path |
|---|---|---|
| Comparison | The Comparison entity (load). | /comparison |
| Discovery | The Discovery entity (list). | /expressions |
| WealthExpression | The WealthExpression entity (load). | /growthOfCompoundInterest |
The operations available across these entities are load, list — see each entity’s own list above for exactly which it supports.
Quickstart in other languages
Python
from weultrarich_sdk import WeUltrarichSDK
client = WeUltrarichSDK()
# Load a specific comparison (returns the record, raises on error)
comparison = client.Comparison().load()
print(comparison)
PHP
<?php
require_once 'weultrarich_sdk.php';
$client = new WeUltrarichSDK();
// Load a specific comparison (returns the bare record; throws on error)
$comparison = $client->Comparison()->load();
print_r($comparison);
Golang
import sdk "github.com/voxgig-sdk/we-ultrarich-sdk/go"
client := sdk.New()
// Load comparison data
comparison, err := client.Comparison(nil).Load(nil, nil)
if err != nil {
panic(err)
}
fmt.Println(comparison)
Ruby
require_relative "WeUltrarich_sdk"
client = WeUltrarichSDK.new
# Load a specific comparison (returns the bare record; raises on error)
comparison = client.Comparison.load()
puts comparison
Lua
local sdk = require("we-ultrarich_sdk")
local client = sdk.new()
-- Load a specific comparison
local comparison, err = client:Comparison():load()
print(comparison)
Direct and prepare
For endpoints the entity model doesn’t cover, use the low-level methods:
direct(fetchargs)— build and send an HTTP request in one step.prepare(fetchargs)— build the request without sending it.
Both accept a map with path, method, params, query,
headers, and body. See the How-to guides below.
How-to guides
Make a direct API call
When the entity interface does not cover an endpoint, use direct:
TypeScript:
const result = await client.direct({
path: '/api/resource/{id}',
method: 'GET',
params: { id: 'example' },
})
if (result instanceof Error) {
throw result
}
console.log(result.data)
Python:
result = client.direct({
"path": "/api/resource/{id}",
"method": "GET",
"params": {"id": "example"},
})
PHP:
$result = $client->direct([
"path" => "/api/resource/{id}",
"method" => "GET",
"params" => ["id" => "example"],
]);
Go:
result, err := client.Direct(map[string]any{
"path": "/api/resource/{id}",
"method": "GET",
"params": map[string]any{"id": "example"},
})
if err != nil {
panic(err)
}
fmt.Println(result)
Ruby:
result = client.direct({
"path" => "/api/resource/{id}",
"method" => "GET",
"params" => { "id" => "example" },
})
Lua:
local result, err = client:direct({
path = "/api/resource/{id}",
method = "GET",
params = { id = "example" },
})
Advanced
Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.
Every SDK call runs the same five-stage pipeline:
- Point — resolve the API endpoint from the operation definition.
- Spec — build the HTTP specification (URL, method, headers, body).
- Request — send the HTTP request.
- Response — receive and parse the response.
- Result — extract the result data for the caller.
A feature hook fires at each stage (e.g. PrePoint, PreSpec,
PreRequest), so features can inspect or modify the pipeline without
forking the SDK.
Features
| Feature | Purpose |
|---|---|
| TestFeature | In-memory mock transport for testing without a live server |
Pass custom features via the extend option at construction time.
Per-language documentation
Upstream API
This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.
- Upstream API: https://wegtultrarich.org/faq.html
Security
Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.
Generated from the We > Ultrarich API OpenAPI spec by @voxgig/sdkgen.