User Tools

Site Tools


custom_api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
custom_api [2019/06/24 18:47]
ianchandler1990
custom_api [2020/04/10 18:30] (current)
ianchandler1990
Line 1: Line 1:
 ===== Community Custom API'​s===== ===== Community Custom API'​s=====
  
-**<color red>​ImportantCommunity Made API are all community ​built and are **NOT** Officially Supported by Deepbot.</​color>​**\\ +**Please NoteAll 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>​Important: ​If commands that require ​an API are spammed more then 40 times per minute ​the api may blacklist you for 24 hours!</color>**\\+
  
-<color red>**Newest Updates** 1st Jan 2018</​color>​\\ +**<color red>This page is current under restructuring to allow the page to be easier to read and navigateAdding tables and headings to allow this page to be more user friendly and descriptivePlease bare with us over the coming weeks while we make this changeSome wording and sentences may also not make sense due to these changes</​color>​**
-<color red>**Best Version** 0.11.0.0</​color>​+
  
-  * **[[custom_api#​Ian Chandler ​APIs|Ian Chandler ​API's]]**+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 [[http://​discord.deepbot.tv|Discord server]] and we will look to adding a link to the API in question as soon as possible.
  
-=== Custom ​API Examples ===+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]
  
  
-This is list of all available Custom api's made by the Community.+ 
 +Missing ​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!\\
  
 ---- ----
  
-=== Ian Chandler APIs ===+=====Emotes=====
  
 ---- ----
  
-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!+**Creator/​Maintainer:​**\\ 
 +Ianchandler1990 ​[[http://www.twitch.tv/​ianchandler1990|Twitch Channel Link]]
  
-All Commands where you see **//TWITCHNAME//** please change that with your twitch username!\\+**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/​
  
-  ​Emotes: http://​api.chandler-gaming.com/​emotes/?user=TWITCHNAME&​ffz=true&​bttv=true&​twitch=true&​gamewisp=true&​deepbot=true +**Example Usage:​**\\ 
-  * **Note** set them to false or remove them if you dont want them also remove deepbot=true if u don't want it to post as streamer+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
  
-  ​Update Game & Titlehttps://​api.chandler-gaming.com/​updateboth/?msg=@replace@[@target@|#​|/​=/+**Example Usage In Deepbot:**\\ 
-  * **Note** Use the between the game and title ie: Minecraft ​This will be the title+@customapi@[http://​api.chandler-gaming.com/​info/?streamer=TWITCHNAME&​format=/display_name/​+has+been+live+for+/​created_at/​+while+playing+/game/+with+/​viewers/​+viewers]
  
-  ​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 +**URL Parameters** 
-  * **Known Online parameters**:​ /url/, /​display_name/,​ /​created_at/,​ /game/, /viewers/, /status/, /views/, /followers/ +^ Field  ​     ^ Type   ^Values ​              ​^Description^ 
-  * **Known Offline parameters**:​ /url/, /​display_name/,​ /game/, /status/, /​followers/,​ /​created_at/​ +streamer ​   | String ​   | Ianchander1990 ​     | The username of the streamer that you want to display info for | 
-  * **Note**: Stream //Must// be live for these to work! unless you include &​status=offline to the end of the URL+| 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!   * 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!
Line 40: Line 92:
   * Define a word: http://​api.chandler-gaming.com/​define/?​term=@target@   * Define a word: http://​api.chandler-gaming.com/​define/?​term=@target@
  
-  * Follow Check: http://​api.chandler-gaming.com/​following/?streamer=TWITCHNAME&​follower=@user@+  * Follow Check: http://​api.chandler-gaming.com/​howlong?user=@user@&​streamer=TWITCHNAME
  
   * Follow Train: http://​api.chandler-gaming.com/​followtrain/?​streamer=TWITCHNAME **Note**: this will display the last 5 followers!   * Follow Train: http://​api.chandler-gaming.com/​followtrain/?​streamer=TWITCHNAME **Note**: this will display the last 5 followers!
custom_api.1561402044.txt.gz · Last modified: 2019/06/24 18:47 by ianchandler1990