Bridge Integration
This guide covers the HyperFlow Bridge API endpoints for generating bridge quotes (/quote) and constructing transactions (/encode), with the simplest path to fetch and execute a bridge. For advanced use cases, see the OpenAPI spec (open it in the viewer of your choice, e.g. Swagger UI — a third-party viewer).
Base URL: https://bridge-ag-api.hyperflow.fun/v1 — all endpoints serve mainnet only; there is no public testnet environment. No API key is required; for partner access, contact the team on Discord.
Bridge flow
Generate a quote
Submit a request to /quote with:
Required parameters
Optional (recommended)
Protocol ids
The app’s “HyperFlow Prefunding” route is an app-level rail and has no public protocol id.
Chain identifiers (lowercase): ethereum, arbitrum, optimism, base, unichain, hypercore, flare, plasma, hyperevm.
When sender and receiver are provided, /quote returns both the quote details and a requestId, which is required to assemble the transaction with /encode. Without them, /quote can still be used purely to fetch rates before a wallet is connected.
Example output:
Assemble the transaction
The HyperFlow API assembles the on-chain transaction — manual construction is not supported. Submit the requestId and your chosen quote index to /encode.
The requestId expires 30 seconds after the quote is generated.
/encode returns the transaction under data:
data contains only to, value, and data — set the chain via your provider (connect to the source-chain RPC) and let your wallet estimate gas. Note that /encode returns a new requestId, distinct from the quote’s.
Errors
Errors are returned as {"error": "<message>"}:
Need help?
- OpenAPI spec for all endpoints and parameters.
- Bridging into HyperCore? See the CoreWriter Integration.
- Swapping on HyperEVM only? See the DEX Aggregator API.
- Join the developer community on Discord.