MyDramaList Unofficial API Docs
An unofficial, serverless web scraper for MyDramaList.com, designed for educational purposes and deployed on Vercel.
Quick Start Guide
Choose a section below to learn more about the API features, setup process, and deployment options.
Core Features
Discover the powerful capabilities and design principles behind this comprehensive API.
Getting Started
Set up your local development environment and understand the technology stack.
Deployment
Deploy your own instance on Vercel and contribute to the project development.
API Overview & Features
Comprehensive guide to the API capabilities
This API provides a serverless, RESTful interface for scraping public data. It is built for educational use, emphasizing responsible data retrieval. The API includes built-in rate-limiting and a modular design.
Comprehensive API
9 endpoints covering search, details, cast, reviews, people, and user lists.
Serverless on Vercel
Optimized for fast, scalable, and cost-effective serverless deployment.
Respectful Rate Limiting
A built-in 1-second delay per request protects the source website.
Consistent Error Handling
Predictable JSON error responses with proper HTTP status codes.
Response Formats
Success (Search)
{
"results": [{"title": "My Demon", "slug": "..."}],
"total": 1
}
Error (404)
{
"code": 404,
"error": true,
"description": "404 Not Found"
}
Local Development Setup
Get started with local development and testing
To run the API on your local machine for testing or development, follow these steps.
Technology Stack
Core Technologies
- Python 3.12, FastAPI, Uvicorn
- BeautifulSoup4, Requests
Project Structure
project_root/
├── main.py & scraper.py
└── requirements.txt ...
Setup Commands
# 1. Clone the repository
git clone https://github.com/B1PL0B/MyDramaList-Unofficial-API.git
cd MyDramaList-Unofficial-API
# 2. Install dependencies
pip install -r requirements.txt
# 3. Run the development server
uvicorn main:app --reload
Deployment & Contribution
Deploy on Vercel and contribute to the project
This project is optimized for deployment on Vercel. For heavy usage, please fork the repository and deploy your own instance.
Usage & Contribution Notice
Please deploy your own instance from the GitHub repo for personal use. If you discover bugs or have improvements, submit a pull request.
Fork on GitHubVercel Deployment Guide
# 1. Install Vercel CLI globally
npm install -g vercel
# 2. Navigate to project root and deploy
vercel --prod
Follow the CLI prompts to link and deploy the project. Vercel will automatically handle the Python serverless environment configuration from vercel.json.