Docs/data/endpoints.min.json

{"askfm":{"base_path":"\/askfm","endpoints":[{"route":"rss\/{USER}","parameters":[{"name":"{USER}","description":"The name of the user you wish to retrieve a feed from"}],"qs":null,"notes":["Provides an RSS feed of a specified ASKfm users answers."]}]},"br":{"base_path":"\/br","endpoints":[{"route":"player\/{ID}\/{TYPE}","parameters":[{"name":"{ID}","description":"The BR player ID, or Steam64 ID of the player.","type":"int64"},{"name":"{TYPE}","description":"Either <code>hardcore<\/code> or <code>regular<\/code>. Defaults to regular.","optional":true}],"qs":[{"name":"options={OPTIONS}","description":"A comma-separated list of options. Available options can be listed if you specify <code>list<\/code> instead of <code>{OPTIONS}<\/code>. Similarly, specifying <code>default<\/code> will list the default options."}],"notes":["Returns stats from the leaderboards API about the player."]}]},"bttv":{"base_path":"\/bttv","endpoints":[{"route":"emotes\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel to retrieve BetterTTV emotes for"}],"qs":null,"notes":["Returns a space-separated list of BetterTTV channel emotes available in the channel."]}]},"dayz":{"base_path":"\/dayz","endpoints":[{"route":"izurvive","parameters":null,"qs":[{"name":"search={SEARCH}","description":"<code>{SEARCH}<\/code> the location name to search for.","required":true}],"notes":["Searches for locations based on the search query string, and returns a location name together with a URL to the location on <a href=\"https:\/\/www.izurvive.com\/\">iZurvive<\/a>."]},{"route":"players","parameters":null,"qs":[{"name":"ip={IP_ADDRESS}","description":"The IP address of the server.","required":true},{"name":"port={PORT}","description":"The connect port of the server.","required":true,"type":"int"},{"name":"query={QUERY_PORT}","description":"The query port of the server.","required":true,"type":"int"}],"notes":["Queries the specified DayZ server and returns a player count in format of: <code>{PLAYERCOUNT}\/{MAXPLAYERS}<\/code>","Note: This also works with other games, such as <a href=\"http:\/\/store.steampowered.com\/app\/299740\/\">Miscreated<\/a>."]},{"route":"status-report","parameters":null,"qs":null,"notes":["Retrieves the latest status report from the <a href=\"https:\/\/dayz.com\/\">DayZ website<\/a>."]},{"route":"steam-status-report","parameters":null,"qs":null,"notes":["Retrieves the latest status report from the <a href=\"https:\/\/steamcommunity.com\/app\/221100\/allnews\/\">DayZ news section on Steam<\/a>."]}]},"example":{"base_path":"\/example","endpoints":[{"route":"sample\/{CHANNEL}\/{USER}","parameters":[{"name":"{CHANNEL}","description":"The channel name"},{"name":"{USER}","description":"The name of the user","optional":true}],"qs":[{"name":"key={API_KEY}","description":"Your custom API key"},{"name":"limit={NUMBER}","description":"The limit of list entries - Max: 100","type":"int"}],"notes":["This is just an example note."]},{"route":"test\/{USER}","parameters":[{"name":"{USER}","description":"The name of the user"}],"qs":[{"name":"limit={NUMBER}","description":"The limit of list entries","type":"int"}],"notes":["Retrieves information about the user."]}]},"lever":{"base_path":"\/lever","endpoints":[{"route":"twitch","parameters":null,"qs":null,"notes":["Returns an RSS feed of the latest <a href=\"https:\/\/jobs.lever.co\/twitch\/\"><i class=\"fa fa-1x fa-twitch\"><\/i> Twitch jobs listings<\/a>."]}]},"misc":{"base_path":"\/misc","endpoints":[{"route":"currency","parameters":null,"qs":[{"name":"from","description":"The currency code you are converting from.","required":true},{"name":"to","description":"The currency code you want to convert to.","required":true},{"name":"value","description":"The amount of 'from' you wish to convert.","required":true,"type":"float"},{"name":"round","description":"The amount of decimals you wish to round the currency to. Default: 2.","type":"int"},{"name":"list","description":"If this is included in the request, a comma-separated list of available currencies will be listed instead."}],"notes":["Converts from one currency to another.<\/a>.","The currency codes follow the <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_4217\">ISO 4217<\/a> standard.","The API used for currency conversions is <a href=\"http:\/\/fixer.io\/\">Fixer.io<\/a>."]}]},"r6":{"base_path":"\/r6","endpoints":[{"route":"patch_notes","parameters":null,"qs":[{"name":"offset","description":"How many patch notes you want to skip back in history","type":"int"}],"notes":["Retrieves the latest Rainbow Six: Siege patch notes from the <a href=\"http:\/\/forums.ubi.com\/forumdisplay.php\/1074-News-amp-Announcements\">Ubisoft forums<\/a>."]}]},"random":{"base_path":"\/random","endpoints":[{"route":"number\/{MIN}\/{MAX}","parameters":[{"name":"{MIN}","description":"The minimum number the result can be - Default: 0.","type":"int"},{"name":"{MAX}","description":"The maximum number the result can be - Default: 100.","type":"int"}],"qs":[{"name":"format","description":"If specified, number will be formatted using the default options of <code><a href=\"https:\/\/secure.php.net\/manual\/en\/function.number-format.php\">number_format()<\/a><\/code>"}],"notes":["Picks a random number between {MIN} and {MAX}.","This only uses <code><a href=\"https:\/\/secure.php.net\/manual\/en\/function.rand.php\">rand()<\/a><\/code> and should not be if you want a \"truly random\" number."]}]},"steam":{"base_path":"\/steam","endpoints":[{"route":"currencies","parameters":null,"qs":null,"notes":["Lists currencies available on Steam (3-letter code + full name)","Send the header <code>Accept: application\/json<\/code> to retrieve a JSON object."]},{"route":"hours\/{STEAM_ID}\/{APP_ID}\/readable","parameters":[{"name":"{STEAM_ID}","description":"The Steam64 ID of the user. See: <a href=\"http:\/\/steamid.co\/\">steamid.co<\/a>","type":"int64"},{"name":"{APP_ID}","description":"The Steam application ID.","type":"int"},{"name":"readable","description":"This has to be passed as just <code>readable<\/code> and nothing else to have any effect. It formats the time to a more \"human-readable\" format. For example: 190.97 hours = 7 days 22 hours 58 minutes.","optional":true}],"qs":[{"name":"round","description":"How many decimals the hours should round to - Default: 2.","type":"int"},{"name":"key","description":"A custom Steam API key. In some cases this is necessary to retrieve profile information about private\/friends-only profiles."}],"notes":["Retrieves the player's time played in the specified game (app ID).","The Steam API key can be retrieved here: <a href=\"https:\/\/steamcommunity.com\/dev\/\">https:\/\/steamcommunity.com\/dev\/<\/a>"]},{"route":"server_ip\/{STEAM_ID}","parameters":[{"name":"{STEAM_ID}","description":"The Steam64 ID of the user. See: <a href=\"http:\/\/steamid.co\/\">steamid.co<\/a>","type":"int64"}],"qs":null,"notes":["Retrieves the gameserver information of the user, if available.","This only works for certain games and only if the user's profile is set to public."]}]},"twitch":{"base_path":"\/twitch","endpoints":[{"route":"","notes":["Lists the currently available endpoints - <strong>Returns a JSON object<\/strong>"]},{"route":"chat_rules\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name to retrieve the chat rules for."}],"notes":["Gives a \"newlined\" list of chat rules for the specified channel."]},{"route":"clusters\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel to check chat cluster for."}],"notes":["Retrieves the chat cluster name for the channel specified.","Note that this is essentially useless from now on, as all requests will (most likely) return <code>aws<\/code>."]},{"route":"emoteslots\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The name of the channel. Will only be used for reference."}],"qs":[{"name":"subscribers","description":"The amount of subscribers, used for calculating how many subscribers are needed to get the next amount of emote slots.","required":true,"type":"int"}]},{"route":"followage\/{CHANNEL}\/{USER}","parameters":[{"name":"{CHANNEL}","description":"The channel name that will be used as reference for checking the \"follow age\"."},{"name":"{USER}","description":"The name of the user that you wish to check the \"follow age\" for."}],"qs":[{"name":"precision","description":"How precise the timestamp should be in terms of years, months, weeks, days, hours, minutes & seconds.- Default: 2.","type":"int"}],"notes":["Gets the time difference (also known as the \"follow age\") between when <code>{USER}<\/code> followed <code>{CHANNEL}<\/code>"]},{"route":"followed\/{CHANNEL}\/{USER}","parameters":[{"name":"{CHANNEL}","description":"The channel name."},{"name":"{USER}","description":"The name of the user."}],"notes":["Retrieves the date and time of when the user followed the channel.","Example format: <code>Mar 13. 2016 - 07:31:29 PM (UTC)<\/code>"]},{"route":"followers\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name of the channel you wish to retrieve followers for."}],"qs":[{"name":"count","description":"How many followers to get with the request. Default: 1. Max: 100.","type":"int"},{"name":"offset","description":"How many followers to offset from the beginning of the object.","type":"int"},{"name":"direction","description":"What direction to retrieve followers in. Can either be 'asc' or 'desc'. Default: 'desc'.","type":"string"},{"name":"num","description":"Prefixes each follower with a number.","type":"none"}]},{"route":"game\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name."}],"notes":["Retrieves the current game the channel has been set to."]},{"route":"help\/{SEARCH}","parameters":[{"name":"{SEARCH}","description":"The string to search for in the titles of the help articles."}],"qs":[{"name":"list","description":"If this is specified at all, a list of available help articles will be returned instead."}],"notes":["Allows you to search help article titles and return the full title + URL.","<strong>JSON results are supported for most requests<\/strong> (search + help articles)."]},{"route":"highlight\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name."}],"notes":["Retrieves the latest \"highlight\" of the specified channel."]},{"route":"hosts\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name."}],"qs":[{"name":"display_name","description":"If specified, this will use the display names instead of the usernames of the users that are hosting."},{"name":"list","description":"If specified, the list will be in plaintext (using newlines) instead of in a JSON object."},{"name":"implode","description":"If specified, the list will be returned comma-separated (\", \") instead of JSON\/a \"newlined\" list."}],"notes":["Returns a list of channel names hosting the specified channel.","<strong>JSON results are returned by default. See <code>list\/implode<\/code> query string.<\/strong>."]},{"route":"id\/{USER}","parameters":[{"name":"{USER}","description":"The name of the user."}],"notes":["Returns the Twitch user ID of the specified user (if valid)."]},{"route":"ingests","notes":["Returns a formatted list of available ingest servers."]},{"route":"subcount\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name."}],"notes":["Retrieves the subscriber count of the specified channel.","<strong>This only works for channels that have authenticated and authorized this app<\/strong>."]},{"route":"subscriber_emotes\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name."}],"notes":["Retrieves the subscriber emotes for the specified channels and lists them (space-separated).","<strong>JSON results are supported<\/strong>."]},{"route":"status\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name."}],"notes":["Retrieves the current title set on the channel."]},{"route":"team_members\/{TEAM_ID}","parameters":[{"name":"{TEAM_ID}","description":"The team identifier."}],"qs":[{"name":"sort","description":"If this is specified, it will sort the members of the team alphabetically."},{"name":"text","description":"If this is specified, the list will be returned in plaintext compared to a JSON array."}],"notes":["Retrieves the members of a specified team.","The team identifier is the identifier used in URLs. Example: The team \"New Game Plus\" has the identifier \"newgameplus\".","<strong>JSON results are returned by default. See <code>text<\/code> query string.<\/strong>."]},{"route":"title\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name."}],"notes":["Works identical to <code>status<\/code> - Retrieves the current title set on the channel."]},{"route":"upload\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name."}],"notes":["Returns the latest uploaded video (title + URL) for the specified channel."]},{"route":"uptime\/{CHANNEL}","parameters":[{"name":"{CHANNEL}","description":"The channel name."}],"notes":["Returns how long the specified channel has been live for the current broadcast.","<strong>Rate-limited:<\/strong> This is rate-limited to 100 requests per minute."]}]},"twitter":{"base_path":"\/twitter","endpoints":[{"route":"latest","parameters":[{"name":"{USER}","description":"The name of the user."}],"qs":[{"name":"no_rts","description":"If specified, retweets will <strong>not<\/strong> be included."},{"name":"include_replies","description":"If specified at all, this includes replies from the specified user to other users as well."},{"name":"no_exclude_replies","description":"Works similarly to <code>include_replies<\/code>, except this query string cannot be specified as just empty unlike <code>include_replies<\/code>."},{"name":"search","description":"Goes through each of the latest tweets (up to 200) and then searches with the specified string (case-insensitive). If this is not specified, it will just return the latest tweet."},{"name":"strict","description":"This is used together with <code>search<\/code>. If specified, it will do a case-sensitive search."},{"name":"url","description":"If specified, the URL of the tweet will be appended to the result."},{"name":"shorten","description":"Used together with <code>url<\/code>. Shortens the URL using TinyURL."},{"name":"howlong","description":"Includes the time since the tweet was posted."}],"notes":["Returns the latest tweet by the specified user."]},{"route":"latest_url","notes":["Works exactly like <code>latest<\/code>, except this will not include the tweet text and by default only include the URL."]},{"route":"latest_id","notes":["Works exactly like <code>latest<\/code>, except this will <strong>only<\/strong> include the tweet ID and nothing else."]}]},"youtube":{"base_path":"\/youtube","endpoints":[{"route":"latest_video","qs":[{"name":"user","description":"For users with URLs that are formatted like: <code>youtube.com\/user\/[USERNAME_HERE]<\/code>."},{"name":"id","description":"For users with URLs that are formatted like: <code>youtube.com\/channel\/[ID_HERE]<\/code>."},{"name":"skip","description":"Skips the specified amount of uploads. - Default: 0. - Maximum: 50.","type":"int"}],"notes":["Retrieves the latest video uploaded to the specified channel and returns the title + URL for it.","Either <code>user<\/code> or <code>id<\/code> has to be specified. If both are specified, <code>id<\/code> will be used."]},{"route":"videoid\/{SEARCH}","parameters":[{"name":"{SEARCH}","description":"The search string."}],"qs":[{"name":"show_url","description":"Prepends <code>https:\/\/youtu.be\/<\/code> before the video ID to make it a proper URL."}],"notes":["Searches the YouTube API with the specified string and returns the first result it can find (if any).","If the search string is a valid video ID, it will just return the video ID."]}]}}