> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hypermid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<CardGroup cols={2}>
  <Card title="Cross-Chain Swap" icon="arrows-rotate" href="/guides/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
  </Card>

  <Card title="PulseChain Swap" icon="bolt" href="/guides/superswap">
    Swap any token to/from PulseChain (PLS, HEX, PLSX).

    **Endpoints:** `quote` → `execute` → `status`

    **Difficulty:** Easy · 3 endpoints · 5 min setup
  </Card>

  <Card title="Fiat On-Ramp" icon="credit-card" href="/guides/fiat-onramp">
    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
  </Card>

  <Card title="Drop-in Widget" icon="browser" href="/widget/overview">
    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
  </Card>

  <Card title="Webhooks" icon="bell" href="/guides/webhooks">
    Get real-time notifications when swaps complete, fail, or need attention.

    **Endpoints:** `webhooks/create` → `webhooks/list`

    **Difficulty:** Easy · 2 endpoints · 5 min setup
  </Card>

  <Card title="Partner Analytics" icon="chart-line" href="/api-reference/partner-me">
    Track swap volumes, revenue, and transaction history.

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

    **Difficulty:** Easy · 3 endpoints · 5 min setup
  </Card>
</CardGroup>

***

## Quick Example: Your First Swap in 30 Seconds

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

```bash theme={"system"}
# 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

<CodeGroup>
  ```typescript SDK theme={"system"}
  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 });
  ```

  ```bash cURL theme={"system"}
  # 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"
  ```
</CodeGroup>

**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](/authentication) page for the full table.

Get your API key from the [Partner Dashboard](https://partner.hypermid.io/login).

## Install an SDK

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

<CodeGroup>
  ```bash TypeScript / JS theme={"system"}
  npm install @hypermid/sdk
  # or: pnpm add @hypermid/sdk
  # or: yarn add @hypermid/sdk
  # or: bun add @hypermid/sdk
  ```

  ```bash Python theme={"system"}
  pip install hypermid
  ```

  ```bash Go theme={"system"}
  go get github.com/Hypermid/hypermid-sdk-go@latest
  ```

  ```bash Rust theme={"system"}
  cargo add hypermid-sdk
  ```
</CodeGroup>

See the [SDK overview](/sdks/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.