Read client - Hypermid

import { Hypermid } from "@hypermid/sdk";

const hypermid = new Hypermid();          // anonymous works
// const hypermid = new Hypermid({ apiKey: process.env.HYPERMID_PUBLISHABLE_KEY });

Method	Returns
`getChains()`	Supported chains that currently have routable tokens
`getTokens(params?)`	Token catalog with inline USD prices
`getStatus(params)`	State of a submitted transfer
`getBalances(params)`	A wallet’s token balances

Hypermid.getQuote() is a deprecated compatibility adapter. Use quoteSwap() for new integrations; it returns a discriminated transaction-or-deposit result and cannot expose inert placeholder calldata.

Building a picker

const { chains } = await hypermid.getChains();
const { tokens } = await hypermid.getTokens({ chains: [8453, 42161] });

Filter by chain. The full catalog spans every supported chain and is large enough to be worth not fetching in a dropdown.

These endpoints are environment-aware. With a sandbox key they return only testnets and testnet tokens, even if you ask for mainnet — so a picker built on them is automatically right in both environments with no branching on your side. See Environments.

Balances

const balances = await hypermid.getBalances({ address: userAddress });

cacheHit and cachedAt tell you whether the answer came from cache. Balances are cached briefly, so a freshly-landed transfer may take a moment to appear — do not treat a stale balance as a failed transfer.

About the API key

interface HypermidConfig {
  apiKey?: string;   // sent as X-API-Key. Optional — anonymous traffic is served fully.
  baseUrl?: string;
}

Do not bake a key into a browser bundle. A key set at build time is extractable by every visitor. These endpoints serve anonymous traffic completely, so a browser needs no key at all — attach yours server-side when you want your negotiated rates applied.

Prices are indicative

priceUSD, balanceUSD and the catalog’s inline prices are for display. They are cached and approximate. Never settle, invoice or reconcile against them — quote the route instead.

​Building a picker

​Balances

​About the API key

​Prices are indicative

Building a picker

Balances

About the API key

Prices are indicative