Skip to main content

​
Prerequisites

Before you begin, ensure you have:
  • An API Key for authentication.
  • A running instance of the Breezee.

​
Authentication

All API requests must include the X-API-Key header. 
curl -H "X-API-Key: your_api_key" https://usebreezee.xyz/

​
First Steps

  1. Self custody : Request for your own instance.
  2. Check Health: Verify the API is running.
  3. Get instance Info: Check your instance’s balance.
  4. Receive Payment: Generate an invoice.
  5. Send Payment: Pay a Bolt11 invoice.
  6. Logs: Get real-time information about your instance’s logs.
  7. Funds Move: Get real-time information about your instance’s funds move.