API Documentation

This section covers the API endpoints available in the Newsloom project. NewLoom provides both RESTful HTTP endpoints and WebSocket connections for real-time updates.

API Reference

• Authentication
  • Registration
  • Login
  • Using the Token
  • JavaScript Example
  • CORS Support
  • Error Handling
  • Security Considerations
• REST API Endpoints
  • Authentication
  • Common Headers
  • Pagination
  • Sources API
  • Streams API
  • News API
  • Error Responses
  • Rate Limiting
• WebSocket API
  • Authentication
  • Connection URLs
  • Error Handling
  • Connection Management
  • Best Practices
  • Example Usage
  • Security Considerations

Quick Start

1. Authentication - See Authentication for obtaining API tokens - Required for both REST and WebSocket endpoints

2. REST API - RESTful endpoints using Django REST Framework - JSON request/response format - Token or session authentication - See REST API Endpoints for detailed documentation

3. WebSocket API - Real-time updates using Django Channels - JSON message format - Supports chat and stream status updates - See WebSocket API for detailed documentation

API Versioning

The current API version is v1. All endpoints are prefixed with /api/v1/.

Rate Limiting

• REST API: 1000 requests per hour for authenticated users

• WebSocket: No strict message limit, but implement reasonable client-side throttling