Skip to content

A free RESTful API for Regular Show characters, episodes, and locations.

License

Notifications You must be signed in to change notification settings

oguzhan18/regularshow-api

Repository files navigation

Regular Show API

A free RESTful API for Regular Show characters, episodes, and locations.

Features

  • Characters: 252 characters with images, categories, and detailed info
  • Episodes: 274 episodes across 8 seasons + shorts
  • Locations: 58 locations with descriptions
  • Pagination: Full pagination support
  • Search: Search by name, slug, or category
  • Static Images: Optimized image delivery

API Endpoints

Endpoint Description
GET /api API information
GET /api/character List all characters
GET /api/character/:id Get character by ID or slug
GET /api/episode List all episodes
GET /api/episode/:id Get episode by ID or slug
GET /api/season List all seasons
GET /api/season/:id Get season details
GET /api/location List all locations
GET /api/location/:id Get location by ID or slug
GET /api/stats Get API statistics

Query Parameters

All list endpoints support:

  • page - Page number (default: 1)
  • limit - Items per page (default: 20)
  • name - Search by name
  • slug - Filter by slug
  • category - Filter by category

Local Development

# Install dependencies
npm install

# Run development server
npm run dev

Project Structure

api/
├── api/
│   └── index.ts      # API route handler
├── public/
│   └── images/        # Static images
│       ├── characters/
│       ├── episodes/
│       └── locations/
├── src/
│   ├── data/          # JSON data files
│   └── types.ts       # TypeScript types
├── vercel.json        # Vercel configuration
└── package.json

License

MIT License - See LICENSE file for details.

About

A free RESTful API for Regular Show characters, episodes, and locations.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published