Choose Your Integration

Pick what you want to build. Each guide lists the exact endpoints you need and walks you through step by step.

Cross-Chain Swap

Swap tokens between any two blockchains (ETH, USDC, SOL, BTC, and more).Endpoints: quote → execute → statusDifficulty: Easy · 3 endpoints · 5 min setup

PulseChain Swap

Swap any token to/from PulseChain (PLS, HEX, PLSX).Endpoints: quote → execute → statusDifficulty: Easy · 3 endpoints · 5 min setup

Fiat On-Ramp

Let users buy crypto with credit card, bank transfer, or Apple Pay.Endpoints: onramp/config → onramp/quote → onramp/checkout → onramp/statusDifficulty: Easy · 4 endpoints · 10 min setup

Drop-in Widget

Pre-built swap UI. Embed in your app with one line of code. Zero backend.Endpoints: None — the widget handles everythingDifficulty: Easiest · 0 endpoints · 2 min setup

Webhooks

Get real-time notifications when swaps complete, fail, or need attention.Endpoints: webhooks/create → webhooks/listDifficulty: Easy · 2 endpoints · 5 min setup

Partner Analytics

Track swap volumes, revenue, and transaction history.Endpoints: partner/me · partner/stats · partner/transactionsDifficulty: Easy · 3 endpoints · 5 min setup

Quick Example: Your First Swap in 30 Seconds

Don’t want to read a guide? Here’s the fastest path:

# 1. Get a quote (what will I receive?)
curl "https://api.hypermid.io/v1/quote?\
fromChain=8453&toChain=42161&\
fromToken=0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913&\
toToken=0xaf88d065e77c8cC2239327C5EDb3A432268e5831&\
fromAmount=5000000&\
fromAddress=0xYourWallet&\
slippage=0.03"

# 2. Sign the transactionRequest from the response with your wallet

# 3. Check status (is it done?)
curl "https://api.hypermid.io/v1/status?\
txHash=0xYourTxHash&fromChain=8453&toChain=42161"

That’s it. Three API calls. Every swap follows this pattern.

Authentication

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

// Anonymous — works immediately, no signup
const client = new Hypermid();

// With a partner API key — higher rate limits + analytics
const client = new Hypermid({ apiKey: process.env.HYPERMID_API_KEY });

# Anonymous — no header needed
curl "https://api.hypermid.io/v1/chains"

# With API key
curl "https://api.hypermid.io/v1/chains" \
  -H "X-API-Key: your-api-key"

Rate limits depend on tier and endpoint type. Anonymous: 30 req/min on heavy endpoints (quote, execute, status) and 240 req/min on cache-friendly reads (chains, tokens, balances, etc.). Partner: 2,000 req/min heavy and 6,000 req/min reads. See the Authentication page for the full table. Get your API key from the Partner Dashboard.

Install an SDK

Official SDKs ship in TypeScript, Python, Go, and Rust — same method surface across all four. Pick whichever fits your stack:

npm install @hypermid/sdk
# or: pnpm add @hypermid/sdk
# or: yarn add @hypermid/sdk
# or: bun add @hypermid/sdk

pip install hypermid

go get github.com/Hypermid/hypermid-sdk-go@latest

cargo add hypermid-sdk

See the SDK overview for per-language guides. Or skip the SDK entirely and use the REST API directly with any HTTP client — every endpoint is plain HTTP + JSON.

Getting Started

Guides

Resources

Quickstart

Choose Your Integration

Cross-Chain Swap

PulseChain Swap

Fiat On-Ramp

Drop-in Widget

Webhooks

Partner Analytics

Quick Example: Your First Swap in 30 Seconds

Authentication

Install an SDK

​Choose Your Integration

Cross-Chain Swap

PulseChain Swap

Fiat On-Ramp

Drop-in Widget

Webhooks

Partner Analytics

​Quick Example: Your First Swap in 30 Seconds

​Authentication

​Install an SDK

Choose Your Integration

Quick Example: Your First Swap in 30 Seconds

Authentication

Install an SDK