Quickstart

Pick a feature and start building in 5 minutes

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 → status

Difficulty: Easy · 3 endpoints · 5 min setup

PulseChain Swap

Swap any token to/from PulseChain (PLS, HEX, PLSX).

Endpoints: quote → execute → status

Difficulty: 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/status

Difficulty: 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 everything

Difficulty: Easiest · 0 endpoints · 2 min setup

Webhooks

Get real-time notifications when swaps complete, fail, or need attention.

Endpoints: webhooks/create → webhooks/list

Difficulty: Easy · 2 endpoints · 5 min setup

Partner Analytics

Track swap volumes, revenue, and transaction history.

Endpoints: partner/me · partner/stats · partner/transactions

Difficulty: 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

SDK

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

// Anonymous (100 req/min)
const client = new Hypermid();

// With API key (2,000 req/min + analytics)
const client = new Hypermid({ apiKey: "your-api-key" });

Get your API key from the Partner Dashboard.

Install the SDK

npm

npm install @hypermid/sdk

Or use the API directly with any HTTP client — no SDK required.