Quick start

Three steps to your first integration on building on top of Merkl API.

1. Get an API key

Anonymous requests work at a default rate limit of 10 req/sec. For production, generate an API key and send it as the X-API-Key header for higher quotas, attribution, and support.

curl https://api.merkl.xyz/v4/opportunities \
  -H "X-API-Key: YOUR_API_KEY"

See Auth & rate limits for details.

2. Make your first call

Use the @merkl/api TypeScript SDK for type-safe access:

import { MerklApi } from "@merkl/api";

const api = MerklApi("https://api.merkl.xyz");
const { data: opportunities } = await api.v4.opportunities.get();
console.log(`${opportunities?.length ?? 0} active opportunities`);

Or call any endpoint directly — see the API Reference for the full surface.

3. Pick your path

Most integrators land here for one of these jobs:

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

Reference

• API Reference — every endpoint, with examples
• Postman collection — try endpoints interactively
• Status page — uptime and incidents
• llms.txt — AI-friendly index of the developer portal