Bridge Endpoints
Move HYPE between HyperEVM and Elysium, both ways, from the wallet's address on one chain to the same address on the other. Only HYPE bridges, and only the wallet itself: to bridge another wallet, use Kinetiq's bridge.
Endpoints
POST /wallet/bridge-quote
POST /wallet/bridge/deposit # HyperEVM → Elysium
POST /wallet/bridge/withdraw # Elysium → HyperEVM
GET /wallet/bridge/pending
Quote
{ "direction": "deposit", "amount": "1.5" }
direction is deposit (HyperEVM → Elysium) or withdraw (Elysium → HyperEVM), and amount is the decimal HYPE that arrives. The quote runs every check a send makes except the wallet's pause and spend limits, and moves nothing.
{
"direction": "deposit",
"fromChain": "hyperevm",
"toChain": "elysium",
"symbol": "HYPE",
"amount": "1.5",
"value": "1.5012",
"maxBridgeFee": "0.0012",
"gasReserve": "0.0004",
"usdValue": 61.2
}
| Field | Description |
|---|---|
value | HYPE the bridge transaction carries: a deposit adds its bridge fees to amount |
maxBridgeFee | The most a deposit's bridge fees can cost; the unused part is refunded on Elysium. "0" for a withdrawal |
gasReserve | HYPE the wallet also needs on the source chain for its own gas |
usdValue | The USD value the per-bridge limit was checked against |
claimableAt | Withdrawals only: when the HYPE is expected on HyperEVM (ISO 8601) |
Deposit and withdraw
{ "amount": "1.5", "idempotencyKey": "6f1c2d4e-8b1a-4c3e-9f2d-1a2b3c4d5e6f" }
Send the quoted amount and an optional idempotencyKey, a UUID minted once per quote. A repeat with the same key replays the answer to a bridge that was sent, and one sent while the first is still running gets 409 duplicate_request. A refusal sends nothing and frees the key, so retrying with it is safe. Without a key, never resend a bridge that may have gone out: check the pending list and the wallet's HYPE first.
| Status | status | Meaning |
|---|---|---|
200 | pending | The transaction confirmed and the bridge is moving the HYPE |
202 | submitted | Broadcast; its receipt is still coming |
202 | unknown | It may have gone out. Don't send it again: check the pending list |
400 | failed | The transaction reverted (error: bridge_reverted), so nothing was bridged |
Each answer carries direction, amount and a message, plus txHash once there is one and a withdrawal's claimableAt. A deposit lands on Elysium once its bridge ticket redeems there. A withdrawal reaches HyperEVM after Elysium's challenge period, about 6 days, and Bankr claims it for you.
Pending bridges
GET /wallet/bridge/pending returns { "transfers": [...] }, the wallet's bridges still moving, newest first. Here direction is deposit or withdrawal, txHash is the wallet's own transaction (on HyperEVM for a deposit, on Elysium for a withdrawal), and status is pending, stuck (a deposit whose automatic redeem on Elysium failed) or claimable (a withdrawal Bankr is about to claim).
Access Control and Errors
- All four need Wallet API (
walletApiEnabled) on an API key, or a signed-in bankr.bot session. The quote and the pending list are reads, so read-only keys can use them; deposit and withdraw reject read-only keys with403. - One bridge moves at most $5,000 of HYPE. A larger one is refused, never split: bridge it in parts.
- Wallet security settings: a paused wallet answers
403, and a send over a spend limit answers403with the limit's code inerror. 400 bridge_refusedmeans nothing was sent, and itsmessagesays why, for example too little HYPE for the amount plus its fees and gas, a bridge over the limit, or a price Bankr couldn't read to check the limit.- Signing errors answer with a stable
errorcode and amessage, such as400 simulation_reverted. - Deposit and withdraw count toward the wallet-write rate limit. The quote allows 60 requests per minute per IP, and the pending list 60 per minute per wallet.
Example
# 1. Quote a deposit of 1.5 HYPE into Elysium
curl -X POST https://api.bankr.bot/wallet/bridge-quote \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{"direction": "deposit", "amount": "1.5"}'
# 2. Send it, with one idempotency key for this quote
curl -X POST https://api.bankr.bot/wallet/bridge/deposit \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{"amount": "1.5", "idempotencyKey": "6f1c2d4e-8b1a-4c3e-9f2d-1a2b3c4d5e6f"}'
# 3. Follow it
curl https://api.bankr.bot/wallet/bridge/pending \
-H "X-API-Key: your_api_key_here"