diff options
author | simon <simobilleter@gmail.com> | 2021-12-20 15:59:24 +0300 |
---|---|---|
committer | simon <simobilleter@gmail.com> | 2021-12-20 17:20:01 +0300 |
commit | 3be5051f53e84f07da109c74323d125c823bd1ab (patch) | |
tree | 44dfd9fe9a2db51822a3571ac342deb223ad43e0 /README.md | |
parent | fdb9df6fe714996904ebe575f945125c188a4388 (diff) |
add API documentation with get vote example
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
@@ -36,6 +36,37 @@ and estimates based on view\like ratios. 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". ## Contributing |