Merkl Developer Portal logo

Quick start

Integrate Merkl in 5 minutes: get an API key, make your first call, pick a path.

Three steps to your first integration with the Merkl API.

1. Get an API key

Generate an API key and send it in the X-API-Key header. Anonymous requests also work, at a lower rate limit. See Auth & rate limits.

2. Make your first call

Call any endpoint directly over HTTPS, with no SDK required:

const res = await fetch("https://api.merkl.xyz/v4/opportunities", {
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
const opportunities = await res.json();
console.log(`${opportunities?.length ?? 0} active opportunities`);

See the API Reference for the full surface.

3. Pick your path

Most integrators land here for one of these jobs:

Display rewardsShow users their claimable rewards in your app
Read campaignsList active campaigns, APRs, and TVL
Push native APRSend your protocol's APR to Merkl for unified display

The next pages walk you through in more detail how to integrate with the Merkl API.

Reference