2
Save it as an environment variable
3
Make your first call
Send the key in the If you get back a list of markets (
x-api-key header, or pass it to the SDK. This call lists the Aave markets on Base: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 thex-api-keyheader.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.