UNPKG

this-is-bad-api

Version:

API wrapper for this-is-a-bad.site

126 lines (105 loc) 2.53 kB
# this-is-bad-api --- ### API wrapper for this-is-a-bad.site Documentation can be found [here](http://this-is-a-bad.site/docs/api) _or you can read this_ --- ### How can I get API key? 1. Go to [this-is-a-bad.site](http://this-is-a-bad.site) 2. Register 3. Click "viev your key" on top of the screen, this will be your token for all APIs --- ### Examples 1. Getting random meme ```js const api = require('this-is-bad-api'); const BadAPI = new api.BadAPI('YOUR TOKEN'); console.log(BadAPI.getMeme()); ``` 1. Getting random cute image ```js const api = require('this-is-bad-api'); const BadAPI = new api.BadAPI('YOUR TOKEN'); console.log(BadAPI.getCute()); ``` 1. Getting random gif ```js const api = require('this-is-bad-api'); const BadAPI = new api.BadAPI('YOUR TOKEN'); console.log(BadAPI.getGif()); ``` 1. Getting random wallpaper ```js const api = require('this-is-bad-api'); const BadAPI = new api.BadAPI('YOUR TOKEN'); console.log(BadAPI.getWallpaper()); ``` Responses should look something like that: ```json { _id: 819273423, title: "This a funny meme", url: "https://this-is-a-bad.site/meme/819273423.png" } ``` `_id_` is image ID assigned on this-is-a-bad.site, no need to care about that :) `title` is image title, like "Waterfall" for example. `url` is direct link to the image --- ### Documentation ```js new BadAPI('YOUR TOKEN'); ``` This generates new BadAPI object that allows you to use API. --- # ```js BadAPI.getMeme(); ``` Gets random meme, expected response: ```json { _id: 819273423, title: "This a funny meme", url: "https://this-is-a-bad.site/meme/819273423.png" } ``` --- # ```js BadAPI.getCute(); ``` Gets random cute image, expected response: ```json { _id: 819273423, title: "Cute image, well, I was too lazy and copied meme response :)", url: "https://this-is-a-bad.site/meme/819273423.png" } ``` --- # ```js BadAPI.getWallpaper(); ``` Gets random wallpaper, expected response: ```json { id: "1525900091", title: "I've added a few more characters to the original wallpaper that I found here. (Link of the original in comments)", url: "https://this-is-a-bad.site/wallpapers/1525900091.jpg" } ``` --- # ```js BadAPI.getGif(); ``` Gets random GIF, expected response: ```json { id: "1526404380", title: "Kung fu driving", url: "https://this-is-a-bad.site/gifs/1526404380.gifv" } ``` ### From developers for developers, with <3