Skip to main content
Prepare the requirements for the integration you chose. Each guide below contains its installation and first-run steps; you only need the path that matches your project. If you are still deciding, choose an integration first.

Check your prerequisites

An RPC endpoint lets your tools read blockchain state and submit transactions. The Routes CLI and Sauce CLI include public endpoint defaults. Their respective guides explain how to use your own endpoint. For transactions you submit, allow for the tokens you want to transfer and the native currency needed for gas. Check the selected guide for approvals, execution fees, and supported gasless funding methods.

Choose the right API service

If you are integrating an HTTP API, use the service and schema for your workflow: Use Eco API v1 for the Routes API integration guide. Routes CLI 1.0.5 uses the legacy quoting service by default. These interfaces have different request and response formats.

Get API access

For Eco API v1, send your key in the x-api-key header. The /v1/circle-gateway/* endpoints allow requests without a key. Request an API key for the other v1 endpoints and confirm access to the operations you need. Keep the key in your backend environment. Use dappId to identify your application in v1 quote requests. The Open quoting service uses the distinct field dAppID. See API conventions for amount formats, identifiers, and rate limits.

Check the environment

Use supported chains and tokens and the discovery endpoints to check Routes mainnet coverage. For Circle Gateway testing, follow the dedicated testnet guide, which uses a different host and path scheme. Confirm access with Eco if you need another test environment. The Sauce SDK has its own chain support and simulation workflow. Follow the Sauce quickstart before submitting a program onchain.

Troubleshooting

  • API key rejected: check the header name, service hostname, and key’s v1 access. Keep the key out of query strings and client-side code.
  • Insufficient balance: check the source-token balance and the gas needed for approvals and funding.
  • RPC request fails: confirm the endpoint serves the selected chain. If a submission times out, inspect the transaction hash before retrying.
  • Sauce SDK installation or simulation fails: use the installation guide and troubleshooting reference.

Next steps