Skip to main content

API Keys & Endpoints

Production integrations use authenticated endpoints with an API key. Get yours from Candide's Dashboard. No sales call required.

API keys and management keys are different

This page covers runtime Bundler and Paymaster API keys. The Platform API uses a separate team management key in an Authorization: Bearer header to create and maintain gas policies. Never expose a management key in client-side code.

Endpoint URL Format​

One URL serves both the Bundler and Paymaster APIs. Add the chain ID and your API key:

https://api.candide.dev/api/v3/{CHAIN_ID}/{API_KEY}

Example (Sepolia Testnet - Chain ID 11155111):

https://api.candide.dev/api/v3/11155111/YOUR_API_KEY

The API key is a path segment: there are no separate auth headers.

caution

The older per-service URL formats (/bundler/v3/ and /paymaster/v3/ with chain names) are deprecated. Use the unified format above.

Example Request​

curl https://api.candide.dev/api/v3/11155111/YOUR_API_KEY \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc": "2.0", "id": 1, "method": "eth_supportedEntryPoints", "params": []}'
{
"jsonrpc": "2.0",
"id": 1,
"result": [
"0x433709009B8330FDa32311DF1C2AFA402eD8D009",
"0x4337084D9E255Ff0702461CF8895CE9E3b5Ff108",
"0x0000000071727De22E5E9d8BAf0edAc6f37da032",
"0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"
]
}

Using with AbstractionKit​

Pass the same URL wherever the SDK expects a bundler or paymaster endpoint:

import { Bundler, CandidePaymaster } from "abstractionkit";

const endpoint = `https://api.candide.dev/api/v3/${chainId}/${apiKey}`;

const bundler = new Bundler(endpoint);
const paymaster = new CandidePaymaster(endpoint);

Supported Methods & Networks​

The full Bundler API and Paymaster API are available on every supported network.

Rate Limits​

Authenticated endpoints have higher rate limits than the public endpoints, scaled to your plan. Allowances per plan are listed on the pricing page, and billing and usage explains what happens when you reach them. If you hit a Too Many Requests error in production, reach out and we will look at your usage pattern together.

Key Safety​

An API key and a private gas policy ID carry different risks:

  • API key: a leaked key lets others use the API on your plan, so the cost is API usage billed to you. It can't move funds or spend your gas tank on its own. Prefer calling Candide from a backend in production, which also protects your usage. A key in frontend code is acceptable for prototypes and client-only apps.
  • Private gas policy ID: whoever holds it gets gas sponsored under that policy, paid from your gas tank. Keep it on a backend, so paymaster requests that carry it come from your server, and add rules to the policy (allowed domains, accounts, calls) to limit what it pays for. A backend that attaches the ID to every request makes the policy usable by anyone, within its rules. The rules are your limit, so set per-account caps, allowed calls, or an account allowlist. To sponsor only your own users, keep the allowlist in sync with their addresses through the Platform API.

Either way:

  • Don't commit the full endpoint URL or a policy ID to a repository.
  • If a key leaks, issue a new one from the dashboard, update your deployments, and remove the old key.