Skip to main content
Breezee is a powerful API for integrating Bitcoin Lightning payments into your applications specially empowering the amountless invoices.

Key Features

  • Send Payments: Send Bolt11 payments easily.
  • Receive Payments: Generate Lightning invoices to receive payments.
  • Node Info: Get real-time information about your node’s balance.
  • Health Checks: Monitor the status of your API.
  • Logs: Get real-time information about your node’s logs.
  • Funds Move: Get real-time information about your node’s funds move.

Security System

Breezee is built with security as a core principle, providing multiple layers of protection for your node and data:
  • API Key Authentication: Every request to the Breezee API must be authenticated using the X-API-Key header.
  • Domain - IP Whitelisting: You can restrict API access to specific IP addresses, specific cors domain, ensuring that only authorized servers can interact with your node.
  • Action Logging: All Infra interactions are logged with detailed information, including timestamps, client IPs, and request paths, allowing for comprehensive auditing and monitoring.
  • Secure Communication: We recommend always using HTTPS to encrypt data in transit between your application and the Breezee Infra.

Self-Custody

Breezee is a non-custodial solution. By leveraging the Lightning & Spark Network, it ensures that:
  • Full Control: You retain complete ownership and control of your private keys. Breezee never has access to your funds.
  • Direct Interaction: The API acts as a bridge to your own Lightning node, meaning your Bitcoin stays in your wallet, and transactions are signed locally.
  • Privacy: Your transaction data and node information are managed by your instance, providing a high level of privacy and sovereignty.

Getting Started

To get started with Breezee, follow our Quickstart guide.