Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/Anarios/return-youtube-dislike.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDmitrii Selivanov <selivano.d@gmail.com>2022-01-03 15:56:23 +0300
committerGitHub <noreply@github.com>2022-01-03 15:56:23 +0300
commit4a8a36a4da02d85d35d16dea3bbe3e3efcf36bbc (patch)
tree8232e5e45e9966dd4f201475e4b7cd8798af6925 /README.md
parentad3bb54772fa4a38b179425356d3a6af51549444 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9c90a5a..4e5acad 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,40 @@ With the removal of dislike stats from the YouTube API, our backend switched to
You can learn more at our website at: [returnyoutubedislike.com](https://www.returnyoutubedislike.com/)
+## API documentation
+
+Third party use of this open API is allowed with the following restrictions:
+
+- **Attribution**: This project should be clearly attributed with either a link to this repo or a link to [returnyoutubedislike.com](https://returnyoutubedislike.com/).
+- **Rate Limiting**: There are per client rate limits in place of 100 per minute and 10'000 per day. This will return a *429* status code indicating that your application should back off.
+
+The API is accessible over the following base URL:
+https://returnyoutubedislikeapi.com
+
+List of available endpoints is available here:
+https://returnyoutubedislikeapi.com/swagger/index.html
+
+### Get votes
+Example to get votes of a given YouTube video ID:
+`/votes?videoId=kxOuG8jMIgI`
+
+```json
+{
+ "id": "kxOuG8jMIgI",
+ "dateCreated": "2021-12-20T12:25:54.418014Z",
+ "likes": 27326,
+ "dislikes": 498153,
+ "rating": 1.212014408444885,
+ "viewCount": 3149885,
+ "deleted": false
+}
+```
+
+None existing YouTube ID will return status code *404* "Not Found".
+Wrong formed YouTube ID will return *400* "Bad Request".
+
+
+
<!---
## API documentation