User Tools

Site Tools


custom_api

Community Custom API's

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.

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

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@.

Have an API that we have not mentioned here that you would like to see mentioned? Let us know on our Discord server and we will look to adding a link to the API in question as soon as possible.

You can read more about features that are exclusive to the Deepbot VIP subscription here: VIP Features You can read more about @customapi@ and other variables usable in commands here: 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!

All Commands where you see TWITCHNAME please change that with your twitch username!


Emotes


Creator/Maintainer:
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 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 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/
custom_api.txt · Last modified: 2020/03/06 15:33 by dante557