Skip to main content
The Breet API lets you accept crypto deposits, convert between assets, manage bank payouts, and track transactions programmatically. This page covers authentication, required headers, and response format.

​
Authentication

All requests to our API must be authenticated. We use a secure, header-based authentication method built around the following credentials:
  • x-app-id
  • x-app-secret
These credentials uniquely identify your application and authorize access to protected endpoints. Additionally, you must specify the environment you want to interact with by including:
  • X-Breet-Env
This header determines whether your requests are routed to the development or production environment.

​
Accepted values for X-Breet-Env

  • development
  • production
If this header is missing or invalid, your request will be rejected.
The API base URL: https://api.breet.io/v1

​
Obtaining your credentials

You can generate and manage your API credentials directly from the Developers section of your dashboard:
  1. Log in to your dashboard
  2. Navigate to Developers → API Credentials
  3. Generate or copy your:
    • App ID
    • App Secret
Your App Secret is extremely sensitive. Treat it like a password or private key. For a step-by-step walkthrough, see the quickstart.

​
Keeping your credentials secure

To maintain the security of your integration:
  • Never expose your App Secret in frontend code, mobile applications, GitHub repositories, or client-side logs
  • Store secrets in a secure storage system (e.g., environment variables, Vault, AWS Secrets Manager, GCP Secret Manager)
  • Rotate your credentials periodically as part of your security best practices
  • If you suspect a leak or unauthorized access:
    • Immediately regenerate your App Secret from the dashboard.
    • The previous secret will be invalidated automatically.
This ensures only authorized systems can access the Breet API.

​
Authentication best practices

  • Use server-to-server communication whenever possible
  • Avoid logging secrets in plaintext
  • Ensure all requests are made over HTTPS
  • Always include the correct X-Breet-Env header in every request

​
Response format

All API responses follow a consistent JSON structure: 
{
  "success": true,
  "message": "Description of the result",
  "data": { ... },
  "meta": { ... }
}
  • success: true for successful requests, false for errors.
  • message: A human-readable description of the result.
  • data: The response payload (object, array, or empty).
  • meta: Metadata such as pagination info.
For full details on error handling, see the Error handling guide.

​
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

​
Further reading

  • Supported assets: See which cryptocurrencies and stablecoins are available for deposits and withdrawals.
  • Auto-settlement: Automatically convert crypto deposits to local currency and pay out to a bank account.
  • Webhooks: Receive real-time notifications for crypto transactions and withdrawal events.
  • Pagination: Navigate large result sets with page-based pagination.
  • Error handling: Understand the standard response format and common error scenarios.
  • Rate limiting: Understand API rate limits and how to handle them.
  • Use cases: See real integration examples for fintech, e-commerce, payroll, and more.
  • API status: Check real-time uptime and incident history.