Important
v2 is now available. v1 will be turned off on 2026-11-01.
If you're still using /api/v1/, please update/migrate to /api/v2/.
See the v1 -> v2 migration guide for endpoint, response, and WebSocket changes.
If you still need the v1 docs ... i guess they are here.
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
- Blog API - Neuro-sama blog feed and entry content
- WebSocket API - Real-time events and WebSocket authentication
- Prebuild Clients - ready-to-use clients for your project
- v1 → v2 Migration Guide - upgrade paths for REST, WebSocket, and responses
- 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, subathon, and blog updates
- Automatic reconnect support in the TypeScript client
- Current subathon progress
- Goal tracking and completion status
- Historical subathon data
- Real-time subscriber counts
- Cached Neuro-sama blog feed access (refreshes every 15 minutes)
- Parsed entry content or raw HTML content
- Authentication required for JSON endpoint
- Real-time update event for changed feed entries
- 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/v2/ - WebSocket URL:
wss://neuro.appstun.net/api/v2/ws - WebSocket Ticket URL:
https://neuro.appstun.net/api/v2/ws/ticket - HTTP Methods: GET only
- Response Format: JSON — v2 REST success always
{"data": ...}, v2 REST errors{"error": {"code": "...", "message": "...", "timestamp": ..., "path": "..."}} - Content-Type:
application/json - Authentication: Bearer token in Authorization header
- Default public/anonymous v2 endpoints: 30 requests per minute
- Authenticated v2 endpoints: 100 requests per minute per API token
- Generous endpoints: 300 requests per minute where explicitly documented (for example
GET /api/info) - Endpoint-specific limits: Some routes have stricter limits, such as schedule search (
6/minplus2/10s) and blog feed (16/min) - Rate limits are applied per API token when authenticated, otherwise per client IP
- 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)
- All v2 REST success responses follow
{"data": ...}; all v2 REST error responses follow{"error": {"code": "...", "message": "...", "timestamp": ..., "path": "..."}}
📝 Contributing: Found an error in the docs or the API? Want to improve something?
Feel free to open an issue or start a discussion!