What is Breeze API?
Breeze API provides a simple and fast way to integrate Breeze’s risk-managed yield functionality into your application, offering the same familiar
experience as traditional web2 APIs. With straightforward https endpoints and JSON responses, you can completely integrate Breeze into your existing
app without requiring significant code rewrites or blockchain expertise from your development team. The API abstracts away the complexity of Solana
blockchain interactions, allowing you to focus on building your user experience while leveraging Breeze’s sophisticated risk management and yield
optimization features.
API Methods Overview
Portfolio Analytics
GET /user-yield/{user_id} - Get real-time portfolio value with optional currency conversion and filtering by balance or base asset.GET /user-balances/{user_id} - Retrieve data about the earned yield by the user.GET /breeze-balances/{user_id} - Get detailed balance information including strategy details, position values, deposits, yield earned, and APY.
Transaction Generation
POST /deposit/ix - Generate Solana instructions for depositing funds into a strategy.POST /deposit/tx - Generate a complete, versioned serialized unsigned transaction for depositing funds.POST /withdraw/ix - Generate Solana instructions for withdrawing from a strategy.POST /withdraw/tx - Generate a complete, versioned serialized unsigned transaction for withdrawing funds.
Best Practice: Always check current portfolio value before making transactions to ensure accurate calculations and optimal timing.
