Skip to content

quickInfo.md

Latest commit

 

History

History
144 lines (90 loc) · 3.47 KB

quickInfo.md

File metadata and controls

144 lines (90 loc) · 3.47 KB

⤴️ Back to the README

NeuroInfoApi - Quick Reference

Base URL

https://neuro.appstun.net/api/v1/

Schedule API

Full docs of endpoint: schedule.md

Specific Weekly Schedule

GET /schedule

  • Purpose: Weekly schedule for Neuro-sama streams
  • Parameters: week (required), year (optional)
  • Public: No (Auth required)
  • Example: /schedule?week=25&year=2024

Latest Weekly Schedule

GET /schedule/latest

  • Purpose: Latest weekly schedule in database
  • Parameters: None
  • Public: Yes

Search Weekly Schedules

GET /schedule/search

  • Purpose: Search schedule messages with cursor-based pagination
  • Parameters: query (required), year (optional), limit (optional), sort (optional), type (optional), cursorYear + cursorWeek (optional pair)
  • Public: No (Auth required)
  • Example: /schedule/search?query=karaoke&limit=10&sort=desc

Devstream Times

GET /schedule/devstreamtimes

  • Purpose: Scheduled times for devstreams
  • Parameters: None
  • Public: Yes

Schedule Weeks Index

GET /schedule/weeks

  • Purpose: Available schedule week numbers grouped by year
  • Parameters: None
  • Public: Yes

Twitch API

Full docs of endpoint: twitch.md

Current Stream Status

GET /twitch/stream

  • Purpose: Current stream information
  • Parameters: None
  • Public: Yes

All VODs

GET /twitch/vods

  • Purpose: All VODs
  • Parameters: None
  • Public: No (Auth required)

Specific VOD

GET /twitch/vod

  • Purpose: Latest or specific VOD
  • Purpose: Specific VOD by stream ID
  • Parameters: streamId (required)
  • Public: No (Auth required)
  • Example: /twitch/vod?streamId=324052648700

Subathon API

Full docs of endpoint: subathon.md

Current Subathon

GET /subathon/current

  • Purpose: Current active subathon data with goals
  • Parameters: None
  • Public: Yes

Subathon Years

GET /subathon/years

  • Purpose: List all subathon years (or year-to-name map in detailed mode)
  • Parameters: detailed (optional, if present returns { "year": "subathon name" })
  • Public: Yes
  • Example: /subathon/years?detailed

Subathon Data (Specific Year)

GET /subathon

  • Purpose: Subathon data for specific year
  • Parameters: year (required)
  • Public: No (Auth required)
  • Example: /subathon?year=2024

WebSocket API

Full docs of endpoint: websocket.md

WebSocket Ticket

GET /api/ws/ticket

  • Purpose: Generate one-time ticket for secure WebSocket authentication
  • Parameters: None
  • Public: No (Auth required)

WebSocket Connection

WSS /api/ws

  • Purpose: Receive real-time stream/schedule/subathon events
  • Authentication: Required (ticket query param or Authorization header)
  • Event Types: scheduleUpdate, subathonUpdate, subathonGoalUpdate, streamOnline, streamUpdate, streamOffline, streamRaidIncoming, streamRaidOutgoing
  • Example: /api/ws?ticket=YOUR_ONE_TIME_TICKET

Authentication

In Header: Authorization: Bearer YOUR_API_TOKEN

Note

To access non-public API endpoints, you need an API token.
Visit the API Dashboard, connect with your Twitch account, and click the Generate API Token button to create one.

For a quick overview of endpoints requiring authentication, refer to needsAuth.md.