BananaJS API Reference 🍌

The complete reference for BananaJS core functionality. For CLI commands, see the CLI Reference.

Core API

🍌 BananaJS Public API (Coming Soon!)

🚧 API Availability Notice

We're currently preparing the BananaJS public API for official release. Our team is working hard to deliver a robust, well-documented API that meets our quality standards.

+ Expected Release: by may 2025 (subject to change)

What to Expect
While we finalize development, here's what we can share about the upcoming API:

## 📡 Planned API Features

| Feature Category       | Status            | Details                                                                 | Early Access Available |
|------------------------|-------------------|-------------------------------------------------------------------------|------------------------|
| **Authentication**     | ✅ Yes            | JWT & API key support<br>• OAuth 2.0 providers<br>• Session management  | Yes (Alpha)            |
| **Real-time Updates**  | ✅ Yes            | WebSocket connections<br>• Presence tracking<br>• Message queues        | Yes (Beta)             |
| **SDK Packages**       | ✅ Yes            | • JavaScript/TypeScript<br>• Python<br>• Ruby<br>• (More coming)       | JS/TS Only             |
| **Rate Limits**        | ⚠️ TBD           | Tier-based limits:<br>• Free: 1000 req/hr<br>• Pro: 10,000 req/hr      | No                     |
| **Webhooks**           | ✅ Yes            | 12+ configurable events<br>• Retry logic<br>• Payload validation       | Yes (Beta)             |
| **GraphQL Endpoint**   | 🚧 In Development | Full schema support<br>• Apollo-compatible                             | Private Beta           |
| **File Storage**       | ✅ Yes            | S3-compatible API<br>• 5GB free tier                                  | Yes (Alpha)            |

### Status Key:
- ✅ Yes - Fully implemented
- ⚠️ TBD - Finalizing details
- 🚧 In Development - Active work in progress

### Early Access Notes:
1. **Alpha**: Basic functionality, may change
2. **Beta**: Stable but minor adjustments possible
3. **Request Access**: [Join waitlist](mailto:[email protected])

🔍 Stay Updated
To get notified when the API launches:

Watch this repository ⭐
Join our Facebook
Follow @bananajs on Twitter