Skip to main content

​
Prerequisites

Don’t have API dashboard access? Fill out this form to speak with our team and get set up.

​
Step 1: Get your credentials

  1. Log in to the Breet API Dashboard.
  2. Go to Settings → For Developer.
  3. Create or copy your App ID and App Secret (API Secret Key).
App ID and API Secret Key
Keep your App Secret safe. Never expose it in frontend code, mobile apps, or public repositories. Store it in environment variables or a secrets manager.

​
Step 2: Set required headers

Every API request must include:
HeaderDescription
x-app-idYour App ID
x-app-secretYour App Secret
X-Breet-Envdevelopment or production

​
Step 3: Make your first request

Base URL: https://api.breet.io/v1 Example 1: list supported assets. 
curl -X GET "https://api.breet.io/v1/trades/assets" \
  -H "x-app-id: YOUR_APP_ID" \
  -H "x-app-secret: YOUR_APP_SECRET" \
  -H "X-Breet-Env: development"
Example 2: generate a deposit wallet address (replace ASSET_ID with a valid asset ID from the assets list). 
curl -X POST "https://api.breet.io/v1/trades/sell/assets/ASSET_ID/generate-address" \
  -H "x-app-id: YOUR_APP_ID" \
  -H "x-app-secret: YOUR_APP_SECRET" \
  -H "X-Breet-Env: development" \
  -H "Content-Type: application/json" \
  -d '{"label": "my-first-wallet"}'

​
AI-powered docs

Connect our documentation to your AI coding tools via MCP so your assistant can search the Breet API docs while you build.

Cursor

Install in Cursor

VS Code

Install in VS Code

Other tools

Copy MCP URL
The Cursor and VS Code buttons open the app directly if installed. For other tools or manual setup, copy the MCP server URL: https://docs.breet.io/mcp

​
Next steps

  • Read the API overview for full authentication and security details.
  • Explore the API reference for all endpoints, request bodies, and responses.
  • Enable auto-settlement to automatically convert crypto deposits to local currency and pay out to a bank account.
  • Set up webhooks to receive real-time events when funds arrive or withdrawals complete.
  • Learn about pagination, error handling, and rate limiting.
  • Browse use cases to see how teams integrate Breet for fintech, e-commerce, payroll, and more.