| Both sides previous revision Previous revision Next revision | Previous revision |
| custom_api [2020/03/06 15:33] – [Emotes] Replaced username with TWITCHNAME in Example Usage in Deepbot dante557 | custom_api [2023/01/18 22:39] (current) – missing ] dante557 |
|---|
| |
| **Please Note: All APIs mentioned here are community driven and are NOT offically supported the Deepbot team. If you require support with regards to this the first port of call should be the creator/maintainer of the API.** | **Please Note: All APIs mentioned here are community driven and are NOT offically supported the Deepbot team. If you require support with regards to this the first port of call should be the creator/maintainer of the API.** |
| |
| **<color red>This page is current under restructuring to allow the page to be easier to read and navigate. Adding tables and headings to allow this page to be more user friendly and descriptive. Please bare with us over the coming weeks while we make this change. Some wording and sentences may also not make sense due to these changes</color>** | |
| |
| APIs (Application Program Interface) are a great way to add some additional functionality to Deepbot. For example, you could use an API to retrieve the latest Tweet that you have sent from Twitter or the latest Youtube video from your favourite creator. These are usable in Deepbot through @customapi@ or, for certain APIs that return JSON formatted pages, the VIP exclusive variable @customjsonapi@. | APIs (Application Program Interface) are a great way to add some additional functionality to Deepbot. For example, you could use an API to retrieve the latest Tweet that you have sent from Twitter or the latest Youtube video from your favourite creator. These are usable in Deepbot through @customapi@ or, for certain APIs that return JSON formatted pages, the VIP exclusive variable @customjsonapi@. |
| |
| You can read more about features that are exclusive to the Deepbot VIP subscription here: [[vip_features|VIP Features]] | You can read more about features that are exclusive to the Deepbot VIP subscription here: [[vip_features|VIP Features]] |
| You can read more about @customapi@ and other variables usable in commands here: [[custom_commands|Custom Command Variables] | You can read more about @customapi@ and other variables usable in commands here: [[custom_commands|Custom Command Variables]] |
| |
| |
| |
| Missing a API you would like to see? Give me a message on [[http://discord.deepbot.tv|Discord]] and ill have a look into adding one! | Missing a API you would like to see? Give me a message on [[http://discord.deepbot.tv|Discord]] and ill have a look into adding one! |
| |
| All Commands where you see **//TWITCHNAME//** please change that with your twitch username!\\ | |
| |
| ---- | ---- |
| |
| =====Emotes===== | ^ API Name/Usage ^ URL Endpoint ^ URL Parameters ^ Example Deepbot Usage ^ Description ^ |
| | | Convert Time | https://api.chandler-gaming.com/converttime/ | ?seconds=SECONDS | <code>@customapi@[https://api.chandler-gaming.com/converttime/?seconds=100]</code> | Converts to seconds that you pass to a readable sentence regarding the time. \\ \\ I.e 55010000000 seconds would become **1768 years, 6 months, 29 days, 19 hours, 33 minutes and 20 seconds** | |
| ---- | | Define a word | https://api.chandler-gaming.com/define/ | ?term=Word To Search | <code>@customapi@[https://api.chandler-gaming.com/define/?term=@target@]</code> | Find the (potential) definition of a word of your choosing | |
| | | Choose At Random | https://api.chandler-gaming.com/select/ | ?choices=list separated by commas | <code>@customapi@[https://api.chandler-gaming.com/select/?choices=one,two,three,four,five]</code> | Choose at random from a list of provided options. Put a comma between each item you want it to select from. For items with spaces, put **%20** instead of a space. | |
| **Creator/Maintainer:**\\ | | Latest YouTube Video | https://decapi.me/youtube/latest_video | ?id=YOUTUBEID | <code>@customapi@[https://decapi.me/youtube/latest_video?id=UCKMLV8QT_f1nnAdlI3JgRIA]</code> | Grab the latest video of the provided ID so that the link can be posted in chat. \\ \\ To find your YouTube's channel ID, go to the following link - https://www.youtube.com/account_advanced | |
| Ianchandler1990 [[http://www.twitch.tv/ianchandler1990|Twitch Channel Link]] | |
| | |
| **API URL:**\\ | |
| http://api.chandler-gaming.com/emotes/ | |
| | |
| **Example URL:**\\ | |
| http://api.chandler-gaming.com/emotes/?user=ianchandler1990&ffz=true&bttv=true&twitch=true&gamewisp=true&deepbot=true | |
| | |
| **Example Usage In Deepbot:**\\ | |
| @customapi@[http://api.chandler-gaming.com/emotes/?user=TWITCHNAME&ffz=true&bttv=true&twitch=true&gamewisp=true&deepbot=true] | |
| | |
| **URL Parameters** | |
| ^ Field ^ Type ^Values ^Description^ | |
| | User | String | Username | The username of the stream you want to display the emotes of [Required] | | |
| | ffz | Boolean | true, false | Display FFZ Emotes saved for the mentioned stream or not | | |
| | bttv | Boolean | true, false | Display BBTV emotes saved for the mentioned stream or not | | |
| | twitch | Boolean | true, false | Display Twitch subscriber emotes saved for the mentioned stream or not | | |
| | gamewisp | Boolean | true, false | Display Gamewisp subscriber emotes saved for the mentioned stream or not | | |
| | deepbot | Boolean | true, false | If true this will return @sendstreamermsg@ to send the return message as the streamer account | | |
| | |
| | |
| ---- | |
| | |
| =====Update Game & Title===== | |
| | |
| ---- | |
| | |
| **Creator/Maintainer:**\\ | |
| Ianchandler1990 [[http://www.twitch.tv/ianchandler1990|Twitch Channel Link]] | |
| | |
| **API URL:**\\ | |
| https://api.chandler-gaming.com/updateboth/ | |
| | |
| **Example Usage:**\\ | |
| https://api.chandler-gaming.com/updateboth/?msg=gamename/=/streamtitle | |
| | |
| **Example Usage In Deepbot:**\\ | |
| @customapi@[https://api.chandler-gaming.com/updateboth/?msg=@replace@[@target@|#|/=/]] | |
| | |
| **URL Parameters** | |
| ^ Field ^ Type ^Values ^Description^ | |
| | msg | String | Example1#Example2 | Formatted like game/=/stream title | | |
| | |
| =====Streamer Information===== | |
| | |
| **Creator/Maintainer:**\\ | |
| Ianchandler1990 [[http://www.twitch.tv/ianchandler1990|Twitch Channel Link]] | |
| | |
| **API URL:**\\ | |
| http://api.chandler-gaming.com/info/ | |
| | |
| **Example Usage:**\\ | |
| Streamer Infomation: http://api.chandler-gaming.com/info/?streamer=TWITCHNAME&format=/display_name/+has+been+live+for+/created_at/+while+playing+/game/+with+/viewers/+viewers | |
| | |
| **Example Usage In Deepbot:**\\ | |
| @customapi@[http://api.chandler-gaming.com/info/?streamer=TWITCHNAME&format=/display_name/+has+been+live+for+/created_at/+while+playing+/game/+with+/viewers/+viewers] | |
| | |
| **URL Parameters** | |
| ^ Field ^ Type ^Values ^Description^ | |
| | streamer | String | Ianchander1990 | The username of the streamer that you want to display info for | | |
| | status | String | Online, Offline | Include status=offline if you want this to output even if the stream is offline.\\ If this is not included to specifically state offline this API will return that the stream is offline. | | |
| | format | String | /display_name/+has+been+live+for+/created_at/+while+playing+/game/+with+/viewers/+viewers | The message that is outputted to the stream. Make sure to put a + between each space.\\ The following are known parameters that can be used with this API\\ **Known Online parameters**: /url/, /display_name/, /created_at/, /game/, /viewers/, /status/, /views/, /followers/\\ **Known Offline parameters**: /url/, /display_name/, /game/, /status/, /followers/, /created_at/ | | |
| | |
| * Convert Time: http://api.chandler-gaming.com/converttime/?seconds=SECONDS Replace **//SECONDS//** with the number of seconds you would like to convert into hours and minutes! | |
| | |
| * Define a word: http://api.chandler-gaming.com/define/?term=@target@ | |
| | |
| * Follow Check: http://api.chandler-gaming.com/following/?streamer=TWITCHNAME&follower=@user@ | |
| | |
| * Follow Train: http://api.chandler-gaming.com/followtrain/?streamer=TWITCHNAME **Note**: this will display the last 5 followers! | |
| | |
| * Choose at random: http://api.chandler-gaming.com/select/?choices=one,two,three,four,five **Note**: you can change the options and add as many as you like as long as you use the , to split them up! | |
| | |
| * Latest Tweet: http://api.chandler-gaming.com/twitter/?user=TWITTER **Note** Change **//TWITTER//** to your own twitter username! | |
| | |
| * Latest Youtube Video: https://decapi.me/youtube/latest_video?id=YOUTUBEID **Note** Change **//YOUTUBEID//** to your own Youtube ID eg: UCuKJ0LqxI8t2a9ATl1rWBGA! | |