Docs/yaml/endpoints/twitch.yaml

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