Apps, API keys, and Rate Limits

​

Apps and API keys

​

Create an App

1. Sign in to the Relay Dashboard.
2. Open Apps in the sidebar.
3. Click Create an App, enter a name (e.g. Production, Staging), and click Create.

​

Add or rotate an API key

• If the App has no active key, click Create an API key under API keys.
• If the App has one active key, rotate it:
  1. Open Apps and select the App.
  2. Under API keys, open the actions menu on the key and select Rotate Key.
  3. Click Rotate API key, then optionally rename the new key and click Save.
  4. Change your integration to use the new key. When the old key’s in-progress requests are complete, deactivate the old key from the same menu.
• If the App has two active keys, deactivate one key first.

​

Tracking requests

• Requests — full history of quotes and intents for each App, with status, route, amounts, and timing.
• Advanced filtering — narrow the table by chain, currency, amount, status, time, and more, combining conditions with AND/OR logic to isolate exactly the requests you care about.
• Custom views — save any combination of filters, sort order, and columns as a reusable view for your team, each with its own name, icon, and color.
• Apps — create Apps, and rename, rotate, and deactivate their API keys.
• Webhooks — configure a per-App webhook endpoint so transaction status updates are pushed to your backend instead of polling.

​

Default Rate Limits

​

Elevated Rate Limits

​

How to Use an API key

​

HTTP requests

x-api-key: YOUR_API_KEY

​

SDK usage

// Set apiKey only when using the SDK server-side.
import {
  createClient,
  MAINNET_RELAY_API,
} from "@relayprotocol/relay-sdk";

createClient({
  baseApiUrl: MAINNET_RELAY_API,
  apiKey: "YOUR_API_KEY",
  // ...other parameters
});

// Or pass the key per-call via the headers parameter.
import { getClient } from "@relayprotocol/relay-sdk";

const quoteParams = { /* ... */ };

const quote = await getClient()?.actions.getQuote(quoteParams, undefined, {
  "x-api-key": "YOUR_API_KEY",
});

​

Proxy API

import {
  createClient,
  MAINNET_RELAY_API,
} from "@relayprotocol/relay-sdk";

createClient({
  baseApiUrl: "https://my-proxy.relay.link", // Replace with your proxy endpoint
  // ...other parameters
});

​

Keeping Your API key Secure

• Keep it server-side only — never expose it in client-side or frontend code. Use a proxy API if calling Relay from the browser.
• Use environment variables — store the key in environment variables, not hardcoded in source code.
• Don’t commit it to version control — add it to .gitignore or use a secrets manager.
• Restrict access — only share the key with team members who need it.
• Rotate keys — rotate a key on a regular schedule. Also rotate it immediately when a team member with access leaves.