aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRitesh Ghosh <[email protected]>2024-12-25 18:14:49 +0530
committerRitesh Ghosh <[email protected]>2024-12-25 18:14:49 +0530
commit03d0ec0a8c7b7d78f9d1b8d498daf5671a6a859d (patch)
tree98bb6e6d7934891dcc45ca6a30af6a63b41841e9 /README.md
parentf0acd89d87e5e62c12e20a95225ca9261fefe411 (diff)
downloadaniwatch-api-03d0ec0a8c7b7d78f9d1b8d498daf5671a6a859d.tar.xz
aniwatch-api-03d0ec0a8c7b7d78f9d1b8d498daf5671a6a859d.zip
docs(`/qtip`): add `/qtip` endpoint documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 61 insertions, 1 deletions
diff --git a/README.md b/README.md
index 06f7395..621b572 100644
--- a/README.md
+++ b/README.md
@@ -72,7 +72,8 @@
- [Render](#render)
- [Documentation](#documentation)
- [GET Anime Home Page](#get-anime-home-page)
- - [GET Anime A-Z List](#get-anime-home-page)
+ - [GET Anime A-Z List](#get-anime-a-z-list)
+ - [GET Anime Qtip Info](#get-anime-qtip-info)
- [GET Anime About Info](#get-anime-about-info)
- [GET Search Results](#get-search-results)
- [GET Search Suggestions](#get-search-suggestions)
@@ -409,6 +410,65 @@ console.log(data);
<summary>
+### `GET` Anime Qtip Info
+
+</summary>
+
+#### Endpoint
+
+```sh
+/api/v2/hianime/qtip/{animeId}
+```
+
+#### Query Parameters
+
+| Parameter | Type | Description | Required? | Default |
+| :-------: | :----: | :----------------------------------: | :-------: | :-----: |
+| `animeId` | string | The unique anime id (in kebab case). | Yes | -- |
+
+#### Request Sample
+
+```javascript
+const resp = await fetch("/api/v2/hianime/qtip/one-piece-100");
+const data = await resp.json();
+console.log(data);
+```
+
+#### Response Schema
+
+```javascript
+{
+ success: true,
+ data: {
+ anime: {
+ id: "one-piece-100",
+ name: "One Piece",
+ malscore: string,
+ quality: string,
+ episodes: {
+ sub: number,
+ dub: number
+ },
+ type: string,
+ description: string,
+ jname: string,
+ synonyms: string,
+ aired: string,
+ status: string,
+ genres: ["Action", "Adventure", "Comedy", "Drama", "Fantasy", "Shounen", "Drama", "Fantasy", "Shounen", "Fantasy", "Shounen", "Shounen", "Super Power"]
+ }
+ }
+}
+```
+
+[🔼 Back to Top](#table-of-contents)
+
+</details>
+
+<details>
+
+<summary>
+
### `GET` Anime About Info
</summary>