mirror of
https://github.com/Shineii86/MiruroAPI.git
synced 2026-10-22 02:05:10 +00:00
docs: update README, endpoints, streaming, and contributing docs
- Updated version to 2.3.3, endpoints 46→49, providers 12→14 - Added Direct Embed Providers section to README (megavid, anixo) - Updated streaming status table with embed alternative - Updated mermaid architecture diagram with embed flow - Updated health/stats sample responses with new fields - Added embed endpoint docs to docs/endpoints.md - Added Direct Embed section to docs/streaming.md - Updated CONTRIBUTING.md with embed provider notes - Added FAQ about direct embed providers - Updated roadmap with completed items
This commit is contained in:
+50
-1
@@ -1,6 +1,6 @@
|
||||
# API Endpoints Reference
|
||||
|
||||
Complete documentation for all 45 MiruroAPI v2.3.0 endpoints.
|
||||
Complete documentation for all 49 MiruroAPI v2.3.3 endpoints.
|
||||
|
||||
---
|
||||
|
||||
@@ -57,6 +57,11 @@ Complete documentation for all 45 MiruroAPI v2.3.0 endpoints.
|
||||
- [Download URL](#download-url)
|
||||
- [Watch (Streaming)](#watch-streaming)
|
||||
|
||||
### Direct Embed (no scraping)
|
||||
- [Embed All Providers](#embed-all-providers)
|
||||
- [Embed Specific Provider](#embed-specific-provider)
|
||||
- [Embed Providers List](#embed-providers-list)
|
||||
|
||||
### Utility
|
||||
- [Compare](#compare)
|
||||
- [Genre Stats](#genre-stats)
|
||||
@@ -576,6 +581,50 @@ Anime release timeline with prequels, sequels, spin-offs.
|
||||
|
||||
---
|
||||
|
||||
## Embed All Providers
|
||||
|
||||
```
|
||||
GET /api/embed/:anilistId/:episode
|
||||
```
|
||||
|
||||
Returns iframe-ready embed URLs for all available providers. No scraping required.
|
||||
|
||||
| Param | Type | Default | Description |
|
||||
|-------|------|---------|-------------|
|
||||
| anilistId | int | required | AniList anime ID |
|
||||
| episode | int | required | Episode number |
|
||||
| lang | string | sub | Language: `sub` or `dub` |
|
||||
| malId | int | optional | MAL ID (uses MAL-based URLs if provided) |
|
||||
|
||||
---
|
||||
|
||||
## Embed Specific Provider
|
||||
|
||||
```
|
||||
GET /api/embed/:anilistId/:episode/:provider
|
||||
```
|
||||
|
||||
Returns embed URL for a specific provider.
|
||||
|
||||
| Param | Type | Default | Description |
|
||||
|-------|------|---------|-------------|
|
||||
| anilistId | int | required | AniList anime ID |
|
||||
| episode | int | required | Episode number |
|
||||
| provider | string | required | Provider ID: `megavid` or `anixo` |
|
||||
| lang | string | sub | Language: `sub` or `dub` |
|
||||
|
||||
---
|
||||
|
||||
## Embed Providers List
|
||||
|
||||
```
|
||||
GET /api/embed-providers
|
||||
```
|
||||
|
||||
Lists all available embed providers with example URLs.
|
||||
|
||||
---
|
||||
|
||||
## Health Check
|
||||
|
||||
```
|
||||
|
||||
+29
-3
@@ -5,13 +5,39 @@ This guide explains how to get streaming URLs from MiruroAPI in 3 steps.
|
||||
## Overview
|
||||
|
||||
```
|
||||
Step 1: Get Episodes → /api/episodes/:anilistId
|
||||
Step 2: Get Stream URLs → /api/watch/:provider/:anilistId/:category/:slug
|
||||
Step 3: Play M3U8 → Use HLS player
|
||||
Option A (Pipe-based — may be Cloudflare-blocked):
|
||||
Step 1: Get Episodes → /api/episodes/:anilistId
|
||||
Step 2: Get Stream URLs → /api/watch/:provider/:anilistId/:category/:slug
|
||||
Step 3: Play M3U8 → Use HLS player
|
||||
|
||||
Option B (Direct embed — no Cloudflare blocking):
|
||||
Step 1: Get Embed URLs → /api/embed/:anilistId/:episode
|
||||
Step 2: Embed in iframe → <iframe src="..."></iframe>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Alternative: Direct Embed (Recommended)
|
||||
|
||||
If pipe-based streaming is blocked by Cloudflare, use direct embed providers instead:
|
||||
|
||||
```bash
|
||||
# Step 1: Get embed URLs for all providers
|
||||
curl "https://mirurotvapi.vercel.app/api/embed/20/1?lang=sub"
|
||||
|
||||
# Step 2: Embed the URL in an iframe
|
||||
<iframe src="https://anixo.buzz/embed/ani/20/1/sub" allow="autoplay; fullscreen"></iframe>
|
||||
```
|
||||
|
||||
| Provider | URL Pattern | CORS |
|
||||
|----------|-------------|------|
|
||||
| Megavid | `megavid.buzz/ani/{id}/{ep}/{lang}` | No |
|
||||
| AniXo | `anixo.buzz/embed/ani/{id}/{ep}/{lang}` | Yes |
|
||||
|
||||
This approach bypasses Cloudflare entirely — no scraping, no proxy, works from any environment.
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Get Episodes
|
||||
|
||||
Each anime has episodes from multiple providers. Fetch the episode list with the AniList ID.
|
||||
|
||||
Reference in New Issue
Block a user