> ## Documentation Index
> Fetch the complete documentation index at: https://developers.usebreezee.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the Breezee documentation

Breezee is a powerful platform infrastructure for integrating Bitcoin Lightning payments into your applications specially empowering the **amountless invoices** and your **ideas** while still remains on **self-custody**.

## Key Features

* **Send Payments**: Send Bolt11 - Lightning Address - **LNURL** payments easily.
* **Receive Payments**: Generate Lightning invoices to receive payments.
* **instance Info**: Get real-time information about your instance's balance.
* **Health Checks**: Monitor the status of the infra.
* **Logs**: Get real-time information about your instance's logs.
* **Funds Move**: Get real-time information about your instance's funds move.

## Security System

Breezee is built with security as a core principle, providing multiple layers of protection for your instance and data:

* **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 instance.
* **Action Logging**: All Infra interactions are logged with detailed information, including timestamps, client IPs, and request paths, allowing for comprehensive auditing and monitoring.
* **Real-time communication** : We use **Server-sent events (SSE)** to provide real-time updates (only available for invoices payments). Fort the LNURL - Lightning address we ensure fatest response through REST.
* **Adaptive Balance Monitoring** : Based on your funds move history, the system calculate the median balance needed to run gracefully and alert you when your balance is below this threshold. (**Available Soon**)
* **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 system acts as a bridge to your own Lightning instance, meaning your Bitcoin stays in your wallet, and transactions are signed locally.
* **Privacy**: Your transaction data and instance information are managed by your instance, providing a high level of privacy and sovereignty.

## Getting Started

To get started with Breezee, follow our [Quickstart](/docs/quickstart) guide.