Skip to main content

​
API Reference

The Hypermid API provides programmatic access to cross-chain swaps, bridges, fiat on-ramp, and partner management functionality.

​
Base URL

https://api.hypermid.io
All endpoints are versioned under /v1/.

​
Authentication

Include your API key in the X-API-Key header. See Authentication for details. 
curl https://api.hypermid.io/v1/chains \
  -H "X-API-Key: your-api-key"

​
Response Format

All responses use the standard envelope format: 
{
  "data": { ... },
  "error": null,
  "meta": {
    "requestId": "uuid",
    "timestamp": 1711234567,
    "rateLimit": { "limit": 2000, "remaining": 1999, "reset": 1711234627 }
  }
}

​
Endpoint Groups

Swap

Chains, tokens, quotes, routes, and status tracking for cross-chain swaps.

Execute

Execute swaps and manage deposits.

On-Ramp

Fiat-to-crypto quotes, checkout sessions, and order tracking.

Partner

Partner profile, analytics, transaction history, and webhook management.

System

Health checks and system status.

​
Quick Reference

EndpointMethodDescription
/v1/chainsGETList supported blockchains
/v1/tokensGETList tokens for specified chains
/v1/connectionsGETList available chain-to-chain connections
/v1/toolsGETList available swap/bridge tools
/v1/gas-pricesGETGet current gas prices
/v1/quoteGETGet a swap quote
/v1/routesGET/POSTGet multiple swap routes
/v1/statusGETCheck swap transaction status
/v1/executePOSTExecute a swap
/v1/execute/deposit/submitPOSTSubmit a manual deposit
/v1/execute/deposit/statusGETCheck deposit status
/v1/onramp/quotePOSTGet fiat-to-crypto quote
/v1/onramp/checkoutPOSTCreate checkout session
/v1/onramp/statusGETCheck on-ramp order status
/v1/onramp/configGETGet on-ramp configuration
/v1/onramp/assetsGETList purchasable assets
/v1/partner/meGETGet partner profile
/v1/partner/statsGETGet partner statistics
/v1/partner/transactionsGETList partner transactions
/v1/partner/webhooksPOSTCreate a webhook
/v1/partner/webhooksGETList webhooks
/v1/partner/webhooks/{id}DELETEDelete a webhook
/v1/swap-eventPOSTSubmit a swap event
/v1/pingGETHealth check