Relay

Docs

• App Fees: Add App Fees on any route and collect in stablecoins
• Deposit Addresses: Bridge assets by sending funds to a deposit address — no wallet connection or signing required.
• Fast Fill: Accelerate the destination fill of a cross-chain request
• Fee Sponsorship: Sponsor your users' transaction fees to improve UX and reduce friction
• Gas Top-Up: Include destination-chain native gas in bridged fills so recipients can transact immediately.
• Gasless Execution: Submit arbitrary transactions for gasless execution
• Gasless Swaps: Remove gas friction from swaps so users only pay with the input token
• Price Stabilization: Deliver consistent stablecoin pricing across chains
• Advanced
• API keys and Rate Limits: Create API keys in the Relay Dashboard to authenticate requests and raise your rate limits
• Contract Compatibility: How to make your contract compatible with Relay
• Handling Execution Errors: Interpret fill and refund failure reasons returned after a request has been submitted
• Fee Structure: Learn about Relay's fee structure
• Handling Quote Errors: Interpret and recover from quote errors in your integration
• Input Validation: Perform optional onchain validation of requests
• Refunds: Learn how Relay handles refunds.
• Understanding Step Execution: How step execution works when driving Relay directly from the API
• Surplus & Shortage: Learn how Relay handles surpluses or shortages.
• Trade Types: Learn trade types Relay supports.
• Wallet Detection: How to detect wallet types and set the explicitDeposit parameter for optimal user experience
• Bitcoin Support: How to deposit and withdraw on Bitcoin from any Relay chain
• Bridging Integration Guide: How to integrate the Relay API for bridging and onboarding
• Base Builder Codes: Attribute onchain activity by appending builder codes to your Relay transactions
• Call Execution Integration Guide: How to execute cross-chain calls using Relay
• Deep Linking: How to deep link to the Relay App
• Hyperliquid Support: How to deposit and withdraw from Hyperliquid to any Relay chain
• Lighter Support: How to deposit to and withdraw from Lighter using the Relay API
• Smart Accounts in Relay: How Relay uses ERC-4337 and EIP-7702 to enable smart wallet features like gas sponsorship, batching, and cross-chain execution
• Solana Support: How to Deposit or Withdraw on Solana from an EVM Chain
• Testnet Support: How to Utilize Testnets on Relay
• Transaction Indexing: How to integrate Relay’s transaction indexing APIs
• Webhooks: Simplify your Integration with Low-Latency Relay Webhooks
• Websockets: Remove Indexing Latency from your App using Relay Websockets
• Contract Addresses
• Supported Chains
• Supported Tokens & Routes: Relay currently supports multiple cross-chain routes across 69+ blockchain networks. This guide explains how to determine if a particular route and token pair are supported by Relay
• Claim App Fees: This API claims app fees for a specific wallet.
• Core
• Deposit Address Reindex: Reindex transactions for a deposit address
• Execute Gasless Txs: This API executes gasless transactions
• Submit Permit: This API is used to submit a permit from the quote API.
• Fast Fill: This API accelerates the destination fill
• Get App Fee Balances: This API returns app fee balances for a specific wallet.
• Get Chains: This API returns all possible chains available.
• Get Chains Liquidity: Returns solver liquidity balances per currency on a specified chain.
• Get Config: This API returns solver capacity data & user data.
• Get Currencies: This api returns currency metadata from a curated list
• Get Currencies: This api returns currency metadata from a curated list
• Get Execution Status: This API returns current status of intent.
• Get Status: This API returns current status of intent.
• Get Price: This API returns a lightweight quote without calldata or steps.
• Get Quote: This API returns an executable quote for swapping, bridging and calling
• Get Quote: This API returns an executable quote for swapping, bridging and calling
• Get Requests: This API returns all the cross-chain transactions.
• Get Swap Sources: This API returns all the available swap sources that can be either included or excluded for routing.
• Get Token Price: This API returns the price of a token on a specific chain.
• API Overview: Overview of the Relay API surface
• Quickstart: Execute your first cross-chain transaction in under 5 minutes.
• Transactions Index: Notify the backend in order to fetch the traces and detect any internal deposits
• Transactions Single: Notify the backend to index transfers, wraps and unwraps.
• Troubleshooting: Troubleshooting tips and tricks for debugging issues with Relay.
• Utilities
• Addresses: Contract addresses for the Relay Settlement Protocol
• Allocator: The component that authorizes crosschain withdrawals
• Deposit Addresses: Deterministic deposit addresses using counterfactual smart contracts
• Depository: The escrow contract deployed on every supported chain
• Hub: The central ledger tracking all token ownership on the Relay Chain
• Oracle: The oracle service and onchain verifier that process settlement attestations
• The Relay Chain: A purpose-built settlement chain for crosschain intent processing
• Security Council: The multisig governance body that protects the protocol
• EVM Depository Reference: Solidity API reference for the EVM Relay Depository contract
• SVM Depository Reference: Anchor API reference for the Solana Relay Depository program
• For Apps: How application integrators interact with the settlement protocol
• For Solvers: How solvers interact with the settlement protocol
• Operate a Third-Party Relay Oracle: How to deploy and run a Relay Oracle outside Relay's internal infrastructure
• How It Works: End-to-end walkthrough of the settlement protocol flows
• Relay Settlement: A crosschain settlement protocol optimized for speed, cost, and reliability
• Security & Audits: Trust model, security architecture, and audit history
• Architecture: Architecture of Relay Vaults
• Relay Vaults Backend: The Relay Vaults backend service is a GraphQL API that allows developers to query vault data.
• RelayBridge
• RelayBridgeFactory
• RelayPool
• RelayPoolFactory
• RelayPoolNativeGateway
• Bridging: In this guide, we will learn how to successfully bridge funds from an origin to a vault.
• Interacting with Relay Vaults: How to interact with Relay Vaults
• Overview: Introducing Relay Vaults
• Security
• Installation: Installing and Configuring RelayKit Hooks
• useExecutionStatus: Fetch the execution status of a quote
• useQuote: Fetch a quote and then execute it with this convenient hook
• useRelayChains: Fetch all relay supported chains
• useRequests: Fetch cross-chain Relay transactions
• useTokenList: Curated token searching
• useTokenPrice: Fetch the USD price for a token on a specific chain.
• Overview: Introducing RelayKit
• claimAppFees: Claim app fees for a wallet
• execute: Execute a quote and get updates on its progress
• executeGaslessBatch: Execute a gasless batch transaction using EIP-7702 delegation
• fastFill: Fast fill a request to accelerate the destination fill
• getAppFees: Retrieve app fee balances for a specific wallet
• getQuote: Get a quote for a cross-chain relay (bridge, swap, call, etc)
• Adapters: An introduction to adapters and how to use them
• Typescript API Typings: Typescript API Typings Typescript Types that facilitate API interaction
• Chain Utils: Utility functions for configuring chains in the Relay SDK
• createClient: Create the global Relay client used by every SDK action
• Installation: Setup the Relay SDK in your application
• Installation: Installing and Configuring RelayKit UI
• RelayKitProvider: The provider to setup RelayKit UI
• SwapWidget: Swap Cross-Chain Instantly
• Theming: Customize the ui theme to fit your app
• Troubleshooting: Having trouble? Start here
• Intent Status: Stream transaction statuses for Relay transactions.
• Brand Assets: Logos, guidelines, and assets for presenting the Relay brand clearly and consistently
• Integrating using AI: Use AI coding assistants to build with Relay faster
• Support
• Supported Chains
• Bug Bounty Program: How Relay classifies and rewards vulnerability reports.
• Community Support
• Compliance
• Contract Audits
• MEV protection: Learn how Relay handles MEV protection.
• Unsupported Exchanges: Exchanges that are not supported by Relay
• Chains: Get Instant Onboarding & Swaps on your Chain
• Commerce & Payments: Use Relay to facilitate seamless payments between users and merchants across any chain
• Multichain Apps: Leverage Relay in your App for Onboarding, Best-in-Class Swaps, and Checkout
• Payment Service Providers: Accept and disburse any asset, on any chain, settled to the currency you run on
• Wallets & Wallet Providers: Learn how Wallets and Wallet Providers can best use Relay
• Bridging & Onboarding: Instant Bridging and Onboarding via Relay
• Call Execution: Execute transactions across any chain, pay with any token
• Swaps: Instant Same-chain and Cross-chain Swaps at the Best Possible Price
• What is Relay?: The fastest and cheapest way to bridge & transact across chains

OpenAPI Specs

• json
• openapi

AsyncAPI Specs

• websocket-reference