Welcome to the NeuroInfoApi documentation repository! This API provides comprehensive access to Neuro-sama stream data, including schedules, VODs, Twitch information, and subathon details.
This repository contains documentation for all public API areas:
- Quick Reference - Quick overview of all endpoints
- Authentication Guide - Endpoints requiring API tokens
- Error Documentation - Error codes and troubleshooting
- Schedule API - Weekly stream schedules
- Twitch API - Stream status and VOD data
- Subathon API - Subathon goals and progress
- WebSocket API - Real-time events and WebSocket authentication
- Prebuild Clients - ready-to-use clients for your project
- Access weekly stream schedules
- Get the latest schedule without authentication
- Query specific weeks and years
- Calendar week support (ISO 8601)
- Real-time stream status updates
- Complete VOD archive access
- Cached data for optimal performance
- Direct Twitch API integration
- Real-time event stream via WebSocket
- Secure browser auth via one-time ticket endpoint
- Event subscriptions for stream, schedule, and subathon updates
- Automatic reconnect support in the TypeScript client
- Current subathon progress
- Goal tracking and completion status
- Historical subathon data
- Real-time subscriber counts
- Browse the documentation - Start with quickInfo.md for a quick overview
- Get an API token - Visit the API Dashboard if you need access to protected endpoints
- Test endpoints - Use the examples in each documentation file
- Check authentication - Review needsAuth.md to see which endpoints require tokens
- Handle errors - Read errors.md for error codes and troubleshooting
- Base URL:
https://neuro.appstun.net/api/v1/ - WebSocket URL:
wss://neuro.appstun.net/api/ws - HTTP Methods: GET only
- Response Format: JSON
- Content-Type:
application/json - Authentication: Bearer token in Authorization header
- Public endpoints: 300 requests per minute (generous)
- Protected endpoints: 100 requests per minute (standard)
- Burst protection: 10 requests per 10 seconds
- Rate limits are applied per API token
- All timestamps are in Unix milliseconds
- Data is cached for optimal performance
- Manual updates may cause slight delays in data availability
- The API uses calendar week numbers (ISO 8601 standard)
- Error responses follow
{error: {...}}; success responses are endpoint-specific (object, array, or{data: {...}})
📝 Contributing: Found an error in the docs or the API? Want to improve something?
Feel free to open an issue or start a discussion!