Skip to main content
1

Get an API key

Sign up for free, then get your key from the API keys page in your dashboard.
2

Save it as an environment variable

Keep the key on your server. Don’t put it in browser or mobile app code, where anyone can read it.
3

Make your first call

Send the key in the x-api-key header, or pass it to the SDK. This call lists the Aave markets on Base:
If you get back a list of markets (WETH, USDC, cbBTC and more), your key works.The guides name fields the way the API and the Python SDK do, in snake_case. The TypeScript SDK uses camelCase for the same fields: vault_address becomes vaultAddress.

Common errors

  • 401: no key was sent. Check the x-api-key header.
  • 403: the key isn’t valid. Copy it again from the API keys page.
  • 429: you’re over your plan’s limit. The free plan allows 1,000 calls a month and 10 requests a second.

Next steps

How Compass Works

See how requests, signing and product accounts fit together.

Account Lifecycle

Create, fund, track and withdraw from a user’s product account.

Earn

Offer variable yield on stablecoins and crypto from Aave, Morpho and Euler.

Build with AI

Point Claude Code, Cursor or Copilot at our docs and let it write the integration.
Need help? Ask on Discord or email contact@compasslabs.ai.