Overview
Read Breeze data and generate Solana transactions through a server-side REST API.
The Breeze API is available at https://api.breeze.baby. Call it from a trusted
backend; API keys must not be exposed to browsers or mobile clients.
Authentication
Send your API key with every request:
x-api-key: YOUR_API_KEYStart with strategy data
Fetch the assets and current APY data configured for a strategy:
curl "https://api.breeze.baby/strategy-info/YOUR_STRATEGY_ID" \
-H "x-api-key: YOUR_API_KEY"Core operations
| Need | Endpoint |
|---|---|
| Check API health | GET /health |
| Read supported assets and APY | GET /strategy-info/{strategy_id} |
| Read a user's Breeze positions | GET /breeze-balances/{user_id} |
| Generate a deposit transaction | POST /deposit/tx |
| Generate a withdrawal transaction | POST /withdraw/tx |
| Close a user account | POST /close-user-account/tx |
The Endpoints section contains the complete request and response reference, including instruction-building variants for advanced integrations.
Transaction lifecycle
Transaction endpoints return a JSON string containing a base64-encoded, unsigned Solana versioned transaction.
Generate
Call a transaction endpoint with the strategy ID, base asset, raw amount, user public key, and payer public key.
Deserialize
Base64-decode the JSON string response into a Solana versioned transaction.
Sign
Present the transaction to the user's wallet or approved signer.
Submit
Send the signed transaction to Solana and wait for confirmation.
Amounts use raw token units
Account for each mint's decimals. For example, one USDC is 1_000_000 raw
units and one SOL is 1_000_000_000 lamports.