Mattheus TypeScript SDK
Use the legacy @mattheus/sdk package identifier for typed Mattheus current-launch reads, portfolio data, and gated execution helpers in Node or web services.
Short answer
The target npm package is @mattheus/sdk@0.1.1 as a legacy package identifier, but public npm publishing is pending. During controlled beta, build from this monorepo and start with read-only methods.
Package status
Public npm publishing is pending. During controlled beta, build from this monorepo and start with read-only methods. The @mattheus/sdk package name is a legacy compatibility identifier until the namespace migration is approved.
Stable reference IDs
Production integrations should pass stable referenceId values. Interactive approvals bind that ID and the exact instruction, user wallet, and execution account; any change requires a new approval.
Who This Is For
TypeScript developers building backend services, agent tools, dashboards, and workflow integrations.
Before You Begin
- Node 18+
- An mt_ API key
- Local repository checkout until npm publication passes smoke tests
- Wallet address only for portfolio methods
Answer engine brief
Mattheus overview
Mattheus is a private AI trading workspace for researching markets, testing reproducible strategies, reviewing portfolio context, and preparing governed actions. Developers can connect through REST APIs, SDKs, and MCP while account authority, policy checks, and approvals remain separate.
Does Mattheus require approval before execution?
Yes. An interactive request requires an exact short-lived one-time approval confirmed with fresh wallet reauthentication. API-key automation requires a separately activated, scoped agent session. Both paths still require wallet or signing readiness and policy checks.
Which markets are documented?
The active launch documentation covers Hyperliquid market data, paper trading, and gated Live workflows. Each page states whether an example is read-only, simulated, paper, or eligible for approval-gated Live execution.
How does policy-gated execution work?
Execution-capable requests are preview-first and must pass wallet readiness, protocol certification, feature gates, idempotency, configured policy controls, and either an exact interactive approval or a bounded API-key agent session before any live action.
Can users revoke permissions?
Users should be able to revoke supported scoped permissions and API keys. Documentation should keep stop, cancel, revoke, and policy rejection paths clear before users approve live execution.
Example
What this example does
Follow this example in order. Read the expected result below before connecting it to a live account or execution-capable workflow.
// Public npm package publishing is pending.
// Build from the repository checkout during controlled beta:
// pnpm --filter @mattheus/sdk build
import { MattheusClient } from "@mattheus/sdk";
const client = new MattheusClient({
apiKey: process.env.MATTHEUS_API_KEY!,
});
const [price, funding] = await Promise.all([
client.getPrice("HYPE"),
client.getFundingRate("HYPE"),
]);
console.log(price.midPx, funding.fundingRate);Common errors
- 401 Unauthorized: the mt_ API key is missing, malformed, revoked, or not scoped to the request.
- 429 Too Many Requests: back off and retry after the rate limit window.
- 502 or 5xx: the control plane or upstream market data adapter is unavailable. Retry with jitter and do not treat stale data as a trade signal.
Safety note
Production services should pass stable referenceId values. Access-token clients use createExecutionApproval, decideExecutionApproval with wallet reauthentication, then execute with the one-time approvalId. API-key clients require an active scoped agent session; all modes retain certification and policy gates.