shishantbiswas/AniKotoAPI
1
0
Fork 0
mirror of https://github.com/Shineii86/AniKotoAPI.git synced 2026-10-22 10:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix /api/servers parameter docs and add /api/stream reference

Browse Source
This commit is contained in:
Shinei Nouzen
2026-07-05 16:15:56 +05:30
parent 403b205625
commit bc840f1373
2 changed files with 86 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+8
View File
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [2.0.1] - 2026-07-05
### Fixed
- **Documentation**: Fixed `/api/servers` parameter description — now correctly states `server_ids` from `/episodes` response (base64-encoded) instead of generic "Episode IDs"
- **Documentation**: Fixed `/api/servers` sample response to match actual API output (flat array with `type`, `ep_id`, `link_id`, `cmid`, `sv_id`, `name`)
- **Documentation**: Added `/api/stream` quick reference section with parameter docs and example response
- **Documentation**: Added note that `/api/stream` requires lowercase `id` parameter (case-sensitive)
## [2.0.0] - 2026-07-04 ## [2.0.0] - 2026-07-04
### Added ### Added
README.md
+78 -20
View File
@@ -909,7 +909,7 @@ console.log(resp.data);
| Parameter | Type | Mandatory | Default | Description | | Parameter | Type | Mandatory | Default | Description |
| :-------: | :--: | :-------: | :-----: | :---------: | | :-------: | :--: | :-------: | :-----: | :---------: |
| `ids` | `string` | Yes ✔️ | — | Episode IDs | | `ids` | `string` | Yes ✔️ | — | `server_ids` from `/episodes` response (base64-encoded) |
#### Example of request #### Example of request
@@ -930,15 +930,24 @@ console.log(resp.data);
```json ```json
{ {
"success": true, "success": true,
"results": { "results": [
"sub": [ {
{ "server_id": 1, "server_name": "Vidstreaming", "type": "sub" }, "type": "sub",
{ "server_id": 2, "server_name": "Gogocdn", "type": "sub" } "ep_id": "16638",
], "link_id": "MTF1dkFtaW9BRTZPbzJJRElFZUZr...",
"dub": [ "cmid": "animixplay-fqs",
{ "server_id": 3, "server_name": "Vidstreaming", "type": "dub" } "sv_id": "8e4",
] "name": "VidPlay-1"
} },
{
"type": "sub",
"ep_id": "16638",
"link_id": "MTF1dkFtaW9BRTZPbzJJRElFZUZr...",
"cmid": "animixplay-fqs",
"sv_id": "323",
"name": "HD-1"
}
]
} }
``` ```
@@ -1004,7 +1013,7 @@ Server list for an episode — returns available streaming servers with their na
| Param | Type | Default | Description | | Param | Type | Default | Description |
|:---|:---|:---|:---| |:---|:---|:---|:---|
| `ids` | `string` | **required** | Episode IDs | | `ids` | `string` | **required** | `server_ids` from `/episodes` response (base64-encoded) |
```bash ```bash
curl "https://anikototvapi.vercel.app/api/servers?ids={episodeIds}" curl "https://anikototvapi.vercel.app/api/servers?ids={episodeIds}"
@@ -1024,15 +1033,24 @@ console.log(resp.data);
```json ```json
{ {
"success": true, "success": true,
"results": { "results": [
"sub": [ {
{ "server_id": 1, "server_name": "Vidstreaming", "type": "sub" }, "type": "sub",
{ "server_id": 2, "server_name": "Gogocdn", "type": "sub" } "ep_id": "16638",
], "link_id": "MTF1dkFtaW9BRTZPbzJJRElFZUZr...",
"dub": [ "cmid": "animixplay-fqs",
{ "server_id": 3, "server_name": "Vidstreaming", "type": "dub" } "sv_id": "8e4",
] "name": "VidPlay-1"
} },
{
"type": "sub",
"ep_id": "16638",
"link_id": "MTF1dkFtaW9BRTZPbzJJRElFZUZr...",
"cmid": "animixplay-fqs",
"sv_id": "323",
"name": "HD-1"
}
]
} }
``` ```
</details> </details>
@@ -1087,6 +1105,46 @@ console.log(resp.data);
--- ---
### `GET /api/stream`
Get streaming URL for a server. Pass the `link_id` from `/api/servers` response.
| Param | Type | Default | Description |
|:---|:---|:---|:---|
| `id` | `string` | **required** | `link_id` from `/servers` response (lowercase `id` required) |
```bash
curl "https://anikototvapi.vercel.app/api/stream?id=MTF1dkFtaW9BRTZPbzJJRElFZUZr..."
```
```javascript
import axios from "axios";
const resp = await axios.get("https://anikototvapi.vercel.app/api/stream", {
params: { id: "yourLinkId" }
});
console.log(resp.data);
```
<details>
<summary>📄 Example Response</summary>
```json
{
"success": true,
"results": {
"linkId": "MTF1dkFtaW9BRTZPbzJJRElFZUZr...",
"url": "https://vidtube.site/stream/aVlsNDR3MnRLbWRvQUFBbWJUNERLQT09/sub",
"skipData": {
"intro": [0, 0],
"outro": [0, 0]
}
}
}
```
</details>
---
### `GET /api/top-ten` ### `GET /api/top-ten`
Top 10 anime rankings for day, week, and month. Top 10 anime rankings for day, week, and month.