simon/hottub
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
067ff3d1da4b7a3ed4179ccb87c9e019095be858
hottub/docs/hottubapp/📡 Status - Hot Tub Docs.html
Simon 067ff3d1da docs
2026-04-03 17:20:11 +00:00

2231 lines
108 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en" class="js-focus-visible js" data-js-focus-visible=""><head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="icon" href="https://docs.hottubapp.io/assets/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.22">
<link rel="stylesheet" href="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/main.84d31ad4.min.css">
<link rel="stylesheet" href="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin="">
<link rel="stylesheet" href="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/css.css">
<style>:root{--md-text-font:"Montserrat";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/extra.css">
<script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-FKHVJYKHGB"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-FKHVJYKHGB",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-FKHVJYKHGB",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
<script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
<meta name="theme-color" content="#14151a"><meta name="color-scheme" content="dark"><link rel="canonical" href="https://docs.hottubapp.io/developers/api/status/"><link rel="prev" href="https://docs.hottubapp.io/developers/server/"><link rel="next" href="https://docs.hottubapp.io/developers/api/videos/"><title>📡 Status - Hot Tub Docs</title><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="indigo" data-md-color-media="(prefers-color-scheme: dark)"><div id="bubble-background" style="position: fixed; top: 0px; left: 0px; width: 100%; height: 100%; z-index: -1;"><canvas style="position: fixed; top: 0px; left: 0px; width: 100%; height: 100%; z-index: -1; pointer-events: none;" width="1366" height="616"></canvas></div>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="https://docs.hottubapp.io/developers/api/status/#overview" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="https://docs.hottubapp.io/" title="Hot Tub Docs" class="md-header__button md-logo" aria-label="Hot Tub Docs" data-md-component="logo">
<img src="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/icon-round.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"></path></svg>
</label>
<div class="md-header__title md-header__title--active" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Hot Tub Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
📡 Status
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="white" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden="">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"></path></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"></path></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<div class="md-header__option">
<div class="md-select">
<button class="md-header__button md-icon" aria-label="Select language">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12.87 15.07-2.54-2.51.03-.03A17.5 17.5 0 0 0 14.07 6H17V4h-7V2H8v2H1v2h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2zm-2.62 7 1.62-4.33L19.12 17z"></path></svg>
</button>
<div class="md-select__inner">
<ul class="md-select__list">
<li class="md-select__item">
<a href="" hreflang="en" class="md-select__link">
English
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=fr" hreflang="fr" class="md-select__link">
French
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=de" hreflang="de" class="md-select__link">
German
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=es" hreflang="es" class="md-select__link">
Spanish
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=it" hreflang="it" class="md-select__link">
Italian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=nl" hreflang="nl" class="md-select__link">
Dutch
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=pt" hreflang="pt" class="md-select__link">
Portuguese
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=pl" hreflang="pl" class="md-select__link">
Polish
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=tr" hreflang="tr" class="md-select__link">
Turkish
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=zh" hreflang="zh" class="md-select__link">
Chinese
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=ja" hreflang="ja" class="md-select__link">
Japanese
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=de" hreflang="at" class="md-select__link">
Austrian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=nl" hreflang="be" class="md-select__link">
Belgian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=bg" hreflang="bg" class="md-select__link">
Bulgarian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=hr" hreflang="hr" class="md-select__link">
Croatian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=el" hreflang="cy" class="md-select__link">
Cypriot
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=cs" hreflang="cs" class="md-select__link">
Czech
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=da" hreflang="da" class="md-select__link">
Danish
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=et" hreflang="et" class="md-select__link">
Estonian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=fi" hreflang="fi" class="md-select__link">
Finnish
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=el" hreflang="el" class="md-select__link">
Greek
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=hu" hreflang="hu" class="md-select__link">
Hungarian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=ga" hreflang="ga" class="md-select__link">
Irish
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=lv" hreflang="lv" class="md-select__link">
Latvian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=lt" hreflang="lt" class="md-select__link">
Lithuanian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=lb" hreflang="lb" class="md-select__link">
Luxembourgish
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=mt" hreflang="mt" class="md-select__link">
Maltese
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=ro" hreflang="ro" class="md-select__link">
Romanian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=sk" hreflang="sk" class="md-select__link">
Slovak
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=sl" hreflang="sl" class="md-select__link">
Slovenian
</a>
</li>
<li class="md-select__item">
<a href="https://docs-hottubapp-io.translate.goog/?_x_tr_sl=en&amp;_x_tr_tl=sv" hreflang="sv" class="md-select__link">
Swedish
</a>
</li>
</ul>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="none" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required="">
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"></path></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0">
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">Type to start searching</div>
<ol class="md-search-result__list" role="presentation" hidden=""></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" style="top: 48px;">
<div class="md-sidebar__scrollwrap" style="height: 520px;">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="https://docs.hottubapp.io/" title="Hot Tub Docs" class="md-nav__button md-logo" aria-label="Hot Tub Docs" data-md-component="logo">
<img src="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/icon-round.png" alt="logo">
</a>
Hot Tub Docs
</label>
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/" class="md-nav__link">
<span class="md-ellipsis">
🏡 Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/install/" class="md-nav__link">
<span class="md-ellipsis">
📲 Install
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/setup/" class="md-nav__link">
<span class="md-ellipsis">
🚀 Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/advanced-settings/" class="md-nav__link">
<span class="md-ellipsis">
🪛 Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/faq/" class="md-nav__link">
<span class="md-ellipsis">
❓ FAQ
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked="checked">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis">
Developers
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Developers
</label>
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/server/" class="md-nav__link">
<span class="md-ellipsis">
📦 Server
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" checked="checked">
<label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
<span class="md-ellipsis">
🌐 Endpoints
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6_2">
<span class="md-nav__icon md-icon"></span>
🌐 Endpoints
</label>
<ul class="md-nav__list">
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
📡 Status
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="https://docs.hottubapp.io/developers/api/status/" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
📡 Status
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc">
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#overview" class="md-nav__link md-nav__link--passed">
<span class="md-ellipsis">
Overview
</span>
</a>
<nav class="md-nav" aria-label="Overview">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#request" class="md-nav__link md-nav__link--passed md-nav__link--active">
<span class="md-ellipsis">
Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#response" class="md-nav__link">
<span class="md-ellipsis">
Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#field-reference" class="md-nav__link">
<span class="md-ellipsis">
Field Reference
</span>
</a>
<nav class="md-nav" aria-label="Field Reference">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#serverstatus-object" class="md-nav__link">
<span class="md-ellipsis">
ServerStatus Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channelgroup-object" class="md-nav__link">
<span class="md-ellipsis">
ChannelGroup Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channel-object" class="md-nav__link">
<span class="md-ellipsis">
Channel Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channeltag-object" class="md-nav__link">
<span class="md-ellipsis">
ChannelTag Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channelmaintainer-object" class="md-nav__link">
<span class="md-ellipsis">
ChannelMaintainer Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#notice-object" class="md-nav__link">
<span class="md-ellipsis">
Notice Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channeloption-object" class="md-nav__link">
<span class="md-ellipsis">
ChannelOption Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channeloptionchoice-object" class="md-nav__link">
<span class="md-ellipsis">
ChannelOptionChoice Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channelstatus-enum" class="md-nav__link">
<span class="md-ellipsis">
ChannelStatus Enum
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/videos/" class="md-nav__link">
<span class="md-ellipsis">
🎬 Videos
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/uploaders/" class="md-nav__link">
<span class="md-ellipsis">
👤 Uploaders
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/url-schemes/" class="md-nav__link">
<span class="md-ellipsis">
🔗 URL Schemes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/developer-tools/" class="md-nav__link">
<span class="md-ellipsis">
🐛 Developer Tools
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<span class="md-ellipsis">
About Us
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
About Us
</label>
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/about/info/" class="md-nav__link">
<span class="md-ellipsis">
ℹ️ Info
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/about/contact/" class="md-nav__link">
<span class="md-ellipsis">
📇 Contact Us
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/about/press-kit/" class="md-nav__link">
<span class="md-ellipsis">
📰 Press Kit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/about/legal/" class="md-nav__link">
<span class="md-ellipsis">
📄 Terms &amp; Privacy Policy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/about/partners/" class="md-nav__link">
<span class="md-ellipsis">
🤝 Partner with Hot Tub
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" style="top: 48px;">
<div class="md-sidebar__scrollwrap" style="height: 520px;">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc">
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#overview" class="md-nav__link md-nav__link--passed">
<span class="md-ellipsis">
Overview
</span>
</a>
<nav class="md-nav" aria-label="Overview">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#request" class="md-nav__link md-nav__link--passed md-nav__link--active">
<span class="md-ellipsis">
Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#response" class="md-nav__link">
<span class="md-ellipsis">
Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#field-reference" class="md-nav__link">
<span class="md-ellipsis">
Field Reference
</span>
</a>
<nav class="md-nav" aria-label="Field Reference">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#serverstatus-object" class="md-nav__link">
<span class="md-ellipsis">
ServerStatus Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channelgroup-object" class="md-nav__link">
<span class="md-ellipsis">
ChannelGroup Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channel-object" class="md-nav__link">
<span class="md-ellipsis">
Channel Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channeltag-object" class="md-nav__link">
<span class="md-ellipsis">
ChannelTag Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channelmaintainer-object" class="md-nav__link">
<span class="md-ellipsis">
ChannelMaintainer Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#notice-object" class="md-nav__link">
<span class="md-ellipsis">
Notice Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channeloption-object" class="md-nav__link">
<span class="md-ellipsis">
ChannelOption Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channeloptionchoice-object" class="md-nav__link">
<span class="md-ellipsis">
ChannelOptionChoice Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="https://docs.hottubapp.io/developers/api/status/#channelstatus-enum" class="md-nav__link">
<span class="md-ellipsis">
ChannelStatus Enum
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1>📡 Status</h1>
<div><h2 id="overview">Overview</h2>
<p>The <code>POST /api/status</code> endpoint is used to retrieve the
status of the given source. It contains information about the source,
channels, and other relevant information.</p>
<h3 id="request">Request</h3>
<p><code>POST /api/status</code></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-0-1"></a><span class="p">{</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-0-2"></a><span class="w"> </span><span class="nt">"clientVersion"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.1.2"</span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-0-3"></a><span class="w"> </span><span class="c1">// Your server's global options can be sent in the status request</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-0-4"></a><span class="w"> </span><span class="nt">"sort"</span><span class="p">:</span><span class="w"> </span><span class="s2">"new"</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-0-5"></a><span class="w"> </span><span class="nt">"flavor"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mint chocolate chip"</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-0-6"></a><span class="p">}</span>
</code></pre></div>
<div class="admonition tip">
<p class="admonition-title">Server Options</p>
<p>Your server's options can be used to customize the experience for the user.
For example, you may return different categories, channels, or notices based on their preferences.</p>
</div>
<h3 id="response">Response</h3>
<div class="highlight"><pre><span></span><code tabindex="0"><a id="__codelineno-1-1" name="__codelineno-1-1" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-1"></a><span class="p">{</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-2"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example-server"</span><span class="p">,</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-3"></a><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Example Video Server"</span><span class="p">,</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-4"></a><span class="w"> </span><span class="nt">"subtitle"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A demo video streaming service."</span><span class="p">,</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-5"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This is an example server demonstrating the Hot Tub API structure and capabilities."</span><span class="p">,</span>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-6"></a><span class="w"> </span><span class="nt">"iconUrl"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/icon.png"</span><span class="p">,</span>
<a id="__codelineno-1-7" name="__codelineno-1-7" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-7"></a><span class="w"> </span><span class="nt">"color"</span><span class="p">:</span><span class="w"> </span><span class="s2">"#007AFF"</span><span class="p">,</span>
<a id="__codelineno-1-8" name="__codelineno-1-8" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-8"></a><span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span>
<a id="__codelineno-1-9" name="__codelineno-1-9" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-9"></a><span class="w"> </span><span class="nt">"notices"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-1-10" name="__codelineno-1-10" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-10"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-11" name="__codelineno-1-11" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-11"></a><span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"warning"</span><span class="p">,</span>
<a id="__codelineno-1-12" name="__codelineno-1-12" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-12"></a><span class="w"> </span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Scheduled Maintenance"</span><span class="p">,</span>
<a id="__codelineno-1-13" name="__codelineno-1-13" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-13"></a><span class="w"> </span><span class="nt">"details"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Our servers will undergo maintenance on January 15th from 2:00-4:00 AM UTC. Some features may be temporarily unavailable."</span><span class="p">,</span>
<a id="__codelineno-1-14" name="__codelineno-1-14" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-14"></a><span class="w"> </span><span class="nt">"priority"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<a id="__codelineno-1-15" name="__codelineno-1-15" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-15"></a><span class="w"> </span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-1-16" name="__codelineno-1-16" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-16"></a><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-1-17" name="__codelineno-1-17" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-17"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-18" name="__codelineno-1-18" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-18"></a><span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"info"</span><span class="p">,</span>
<a id="__codelineno-1-19" name="__codelineno-1-19" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-19"></a><span class="w"> </span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Features Available"</span><span class="p">,</span>
<a id="__codelineno-1-20" name="__codelineno-1-20" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-20"></a><span class="w"> </span><span class="nt">"details"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Check out our latest update with improved video quality and faster loading times!"</span><span class="p">,</span>
<a id="__codelineno-1-21" name="__codelineno-1-21" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-21"></a><span class="w"> </span><span class="nt">"priority"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
<a id="__codelineno-1-22" name="__codelineno-1-22" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-22"></a><span class="w"> </span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/changelog"</span>
<a id="__codelineno-1-23" name="__codelineno-1-23" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-23"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-1-24" name="__codelineno-1-24" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-24"></a><span class="w"> </span><span class="p">],</span>
<a id="__codelineno-1-25" name="__codelineno-1-25" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-25"></a><span class="w"> </span><span class="nt">"channels"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-1-26" name="__codelineno-1-26" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-26"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-27" name="__codelineno-1-27" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-27"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example-tube"</span><span class="p">,</span>
<a id="__codelineno-1-28" name="__codelineno-1-28" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-28"></a><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Example Tube"</span><span class="p">,</span>
<a id="__codelineno-1-29" name="__codelineno-1-29" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-29"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A sample video channel demonstrating the API structure."</span><span class="p">,</span>
<a id="__codelineno-1-30" name="__codelineno-1-30" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-30"></a><span class="w"> </span><span class="nt">"premium"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
<a id="__codelineno-1-31" name="__codelineno-1-31" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-31"></a><span class="w"> </span><span class="nt">"favicon"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/favicon.ico"</span><span class="p">,</span>
<a id="__codelineno-1-32" name="__codelineno-1-32" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-32"></a><span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span>
<a id="__codelineno-1-33" name="__codelineno-1-33" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-33"></a><span class="w"> </span><span class="nt">"categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"Entertainment"</span><span class="p">,</span><span class="w"> </span><span class="s2">"Education"</span><span class="p">,</span><span class="w"> </span><span class="s2">"Music"</span><span class="p">],</span>
<a id="__codelineno-1-34" name="__codelineno-1-34" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-34"></a><span class="w"> </span><span class="nt">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-1-35" name="__codelineno-1-35" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-35"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-36" name="__codelineno-1-36" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-36"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"quality"</span><span class="p">,</span>
<a id="__codelineno-1-37" name="__codelineno-1-37" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-37"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Video Quality"</span><span class="p">,</span>
<a id="__codelineno-1-38" name="__codelineno-1-38" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-38"></a><span class="w"> </span><span class="nt">"systemImage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"video"</span><span class="p">,</span>
<a id="__codelineno-1-39" name="__codelineno-1-39" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-39"></a><span class="w"> </span><span class="nt">"colorName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"blue"</span><span class="p">,</span>
<a id="__codelineno-1-40" name="__codelineno-1-40" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-40"></a><span class="w"> </span><span class="nt">"multiSelect"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
<a id="__codelineno-1-41" name="__codelineno-1-41" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-41"></a><span class="w"> </span><span class="nt">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-1-42" name="__codelineno-1-42" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-42"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-43" name="__codelineno-1-43" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-43"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"hd"</span><span class="p">,</span>
<a id="__codelineno-1-44" name="__codelineno-1-44" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-44"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HD"</span><span class="p">,</span>
<a id="__codelineno-1-45" name="__codelineno-1-45" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-45"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"High definition videos only"</span>
<a id="__codelineno-1-46" name="__codelineno-1-46" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-46"></a><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-1-47" name="__codelineno-1-47" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-47"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-48" name="__codelineno-1-48" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-48"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"any"</span><span class="p">,</span>
<a id="__codelineno-1-49" name="__codelineno-1-49" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-49"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Any Quality"</span><span class="p">,</span>
<a id="__codelineno-1-50" name="__codelineno-1-50" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-50"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Include all video qualities"</span>
<a id="__codelineno-1-51" name="__codelineno-1-51" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-51"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-1-52" name="__codelineno-1-52" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-52"></a><span class="w"> </span><span class="p">]</span>
<a id="__codelineno-1-53" name="__codelineno-1-53" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-53"></a><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-1-54" name="__codelineno-1-54" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-54"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-55" name="__codelineno-1-55" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-55"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"duration"</span><span class="p">,</span>
<a id="__codelineno-1-56" name="__codelineno-1-56" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-56"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Duration"</span><span class="p">,</span>
<a id="__codelineno-1-57" name="__codelineno-1-57" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-57"></a><span class="w"> </span><span class="nt">"systemImage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"clock"</span><span class="p">,</span>
<a id="__codelineno-1-58" name="__codelineno-1-58" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-58"></a><span class="w"> </span><span class="nt">"colorName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"orange"</span><span class="p">,</span>
<a id="__codelineno-1-59" name="__codelineno-1-59" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-59"></a><span class="w"> </span><span class="nt">"multiSelect"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<a id="__codelineno-1-60" name="__codelineno-1-60" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-60"></a><span class="w"> </span><span class="nt">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-1-61" name="__codelineno-1-61" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-61"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-62" name="__codelineno-1-62" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-62"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"short"</span><span class="p">,</span>
<a id="__codelineno-1-63" name="__codelineno-1-63" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-63"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Short (&lt; 5 min)"</span><span class="p">,</span>
<a id="__codelineno-1-64" name="__codelineno-1-64" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-64"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Videos under 5 minutes"</span>
<a id="__codelineno-1-65" name="__codelineno-1-65" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-65"></a><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-1-66" name="__codelineno-1-66" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-66"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-67" name="__codelineno-1-67" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-67"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"medium"</span><span class="p">,</span>
<a id="__codelineno-1-68" name="__codelineno-1-68" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-68"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Medium (5-20 min)"</span><span class="p">,</span>
<a id="__codelineno-1-69" name="__codelineno-1-69" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-69"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Videos between 5-20 minutes"</span>
<a id="__codelineno-1-70" name="__codelineno-1-70" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-70"></a><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-1-71" name="__codelineno-1-71" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-71"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-72" name="__codelineno-1-72" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-72"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"long"</span><span class="p">,</span>
<a id="__codelineno-1-73" name="__codelineno-1-73" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-73"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Long (&gt; 20 min)"</span><span class="p">,</span>
<a id="__codelineno-1-74" name="__codelineno-1-74" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-74"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Videos over 20 minutes"</span>
<a id="__codelineno-1-75" name="__codelineno-1-75" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-75"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-1-76" name="__codelineno-1-76" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-76"></a><span class="w"> </span><span class="p">]</span>
<a id="__codelineno-1-77" name="__codelineno-1-77" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-77"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-1-78" name="__codelineno-1-78" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-78"></a><span class="w"> </span><span class="p">],</span>
<a id="__codelineno-1-79" name="__codelineno-1-79" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-79"></a><span class="w"> </span><span class="nt">"nsfw"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
<a id="__codelineno-1-80" name="__codelineno-1-80" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-80"></a><span class="w"> </span><span class="nt">"ytdlpCommand"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yt-dlp --format best"</span><span class="p">,</span>
<a id="__codelineno-1-81" name="__codelineno-1-81" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-81"></a><span class="w"> </span><span class="nt">"cacheDuration"</span><span class="p">:</span><span class="w"> </span><span class="mi">1800</span>
<a id="__codelineno-1-82" name="__codelineno-1-82" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-82"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-1-83" name="__codelineno-1-83" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-83"></a><span class="w"> </span><span class="p">],</span>
<a id="__codelineno-1-84" name="__codelineno-1-84" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-84"></a><span class="w"> </span><span class="nt">"nsfw"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
<a id="__codelineno-1-85" name="__codelineno-1-85" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-85"></a><span class="w"> </span><span class="nt">"categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-1-86" name="__codelineno-1-86" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-86"></a><span class="w"> </span><span class="s2">"Funny"</span><span class="p">,</span>
<a id="__codelineno-1-87" name="__codelineno-1-87" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-87"></a><span class="w"> </span><span class="s2">"Cute"</span><span class="p">,</span>
<a id="__codelineno-1-88" name="__codelineno-1-88" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-88"></a><span class="w"> </span><span class="s2">"Action"</span><span class="p">,</span>
<a id="__codelineno-1-89" name="__codelineno-1-89" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-89"></a><span class="w"> </span><span class="s2">"Adventure"</span><span class="p">,</span>
<a id="__codelineno-1-90" name="__codelineno-1-90" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-90"></a><span class="w"> </span><span class="s2">"Animation"</span><span class="p">,</span>
<a id="__codelineno-1-91" name="__codelineno-1-91" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-91"></a><span class="w"> </span><span class="s2">"Comedy"</span><span class="p">,</span>
<a id="__codelineno-1-92" name="__codelineno-1-92" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-92"></a><span class="w"> </span><span class="s2">"Documentary"</span><span class="p">,</span>
<a id="__codelineno-1-93" name="__codelineno-1-93" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-93"></a><span class="w"> </span><span class="s2">"Drama"</span>
<a id="__codelineno-1-94" name="__codelineno-1-94" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-94"></a><span class="w"> </span><span class="p">],</span>
<a id="__codelineno-1-95" name="__codelineno-1-95" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-95"></a><span class="w"> </span><span class="nt">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-1-96" name="__codelineno-1-96" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-96"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-97" name="__codelineno-1-97" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-97"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"sort"</span><span class="p">,</span>
<a id="__codelineno-1-98" name="__codelineno-1-98" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-98"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sort"</span><span class="p">,</span>
<a id="__codelineno-1-99" name="__codelineno-1-99" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-99"></a><span class="w"> </span><span class="nt">"systemImage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"arrow.up.arrow.down"</span><span class="p">,</span>
<a id="__codelineno-1-100" name="__codelineno-1-100" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-100"></a><span class="w"> </span><span class="nt">"colorName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"blue"</span><span class="p">,</span>
<a id="__codelineno-1-101" name="__codelineno-1-101" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-101"></a><span class="w"> </span><span class="nt">"multiSelect"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
<a id="__codelineno-1-102" name="__codelineno-1-102" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-102"></a><span class="w"> </span><span class="nt">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-1-103" name="__codelineno-1-103" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-103"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-104" name="__codelineno-1-104" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-104"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"new"</span><span class="p">,</span>
<a id="__codelineno-1-105" name="__codelineno-1-105" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-105"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New"</span><span class="p">,</span>
<a id="__codelineno-1-106" name="__codelineno-1-106" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-106"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sort the videos by newest first."</span>
<a id="__codelineno-1-107" name="__codelineno-1-107" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-107"></a><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-1-108" name="__codelineno-1-108" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-108"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-109" name="__codelineno-1-109" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-109"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"likes"</span><span class="p">,</span>
<a id="__codelineno-1-110" name="__codelineno-1-110" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-110"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Most Liked"</span><span class="p">,</span>
<a id="__codelineno-1-111" name="__codelineno-1-111" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-111"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sort the videos by likes."</span>
<a id="__codelineno-1-112" name="__codelineno-1-112" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-112"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-1-113" name="__codelineno-1-113" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-113"></a><span class="w"> </span><span class="p">]</span>
<a id="__codelineno-1-114" name="__codelineno-1-114" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-114"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-1-115" name="__codelineno-1-115" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-115"></a><span class="w"> </span><span class="p">],</span>
<a id="__codelineno-1-116" name="__codelineno-1-116" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-116"></a><span class="w"> </span><span class="nt">"popup"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<a id="__codelineno-1-117" name="__codelineno-1-117" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-117"></a><span class="w"> </span><span class="nt">"filtersFooter"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Help us improve our algorithms by selecting the categories that best describe you. These may not change search results on your source, but they help personalize the overall app experience."</span>
<a id="__codelineno-1-118" name="__codelineno-1-118" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-1-118"></a><span class="p">}</span>
</code></pre></div>
<h2 id="field-reference">Field Reference</h2>
<h3 id="serverstatus-object">ServerStatus Object</h3>
<div class="md-typeset__scrollwrap"><div class="md-typeset__table"><table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Unique server identifier</td>
</tr>
<tr>
<td><code>name</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Server display name</td>
</tr>
<tr>
<td><code>subtitle</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Brief server description</td>
</tr>
<tr>
<td><code>description</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Detailed server description</td>
</tr>
<tr>
<td><code>iconUrl</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Server icon/logo URL</td>
</tr>
<tr>
<td><code>color</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Brand color (hex code or Swift color names)</td>
</tr>
<tr>
<td><code>status</code></td>
<td><code>ChannelStatus</code></td>
<td>⚪</td>
<td>Server operational status</td>
</tr>
<tr>
<td><code>notices</code></td>
<td><code>Notice[]</code></td>
<td>⚪</td>
<td>Status notices/alerts</td>
</tr>
<tr>
<td><code>channels</code></td>
<td><code>Channel[]</code></td>
<td>⚪</td>
<td>Available content channels</td>
</tr>
<tr>
<td><code>channelGroups</code></td>
<td><code>ChannelGroup[]</code></td>
<td>⚪</td>
<td>Explicit channel picker sections (takes priority over per-channel <code>groupKey</code>/<code>sortOrder</code>)</td>
</tr>
<tr>
<td><code>nsfw</code></td>
<td><code>boolean</code></td>
<td>⚪</td>
<td>Whether server contains adult content</td>
</tr>
<tr>
<td><code>categories</code></td>
<td><code>string[]</code></td>
<td>⚪</td>
<td>Available content categories</td>
</tr>
<tr>
<td><code>options</code></td>
<td><code>ChannelOption[]</code></td>
<td>⚪</td>
<td>Global server options</td>
</tr>
<tr>
<td><code>filtersFooter</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Footer text for filter UI</td>
</tr>
</tbody>
</table></div></div>
<h3 id="channelgroup-object">ChannelGroup Object</h3>
<p>An explicit, ordered section definition for the channel picker. When present, <code>channelGroups</code> takes full priority over per-channel <code>groupKey</code> and <code>sortOrder</code>.</p>
<div class="md-typeset__scrollwrap"><div class="md-typeset__table"><table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Unique group identifier</td>
</tr>
<tr>
<td><code>title</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Section heading displayed in the channel picker</td>
</tr>
<tr>
<td><code>channelIds</code></td>
<td><code>string[]</code></td>
<td>✅</td>
<td>Ordered list of channel IDs belonging to this group</td>
</tr>
</tbody>
</table></div></div>
<div class="admonition info">
<p class="admonition-title">Channel Picker Section Logic</p>
<p>The channel picker builds sections using the following priority order:</p>
<ol>
<li><strong><code>channelGroups</code></strong> (top-level, on
ServerStatus) — explicit sections with named titles and an ordered list
of channel IDs. Use this for full control over grouping and order.</li>
<li><strong><code>groupKey</code> + <code>sortOrder</code></strong> (per-channel fields) — lightweight fallback. Channels are grouped by their <code>groupKey</code> string; within each group they are sorted by <code>sortOrder</code> (ascending), then alphabetically. Use this when you don't want a separate top-level structure.</li>
<li><strong>Default</strong> — if neither is provided, channels are
split into a "Premium" section and a general "Channels" section, each
sorted alphabetically.</li>
</ol>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-1"></a><span class="c1">// Option A: channelGroups (explicit, recommended for complex layouts)</span>
<a id="__codelineno-2-2" name="__codelineno-2-2" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-2"></a><span class="p">{</span>
<a id="__codelineno-2-3" name="__codelineno-2-3" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-3"></a><span class="w"> </span><span class="nt">"channelGroups"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-2-4" name="__codelineno-2-4" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-4"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"featured"</span><span class="p">,</span><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Featured"</span><span class="p">,</span><span class="w"> </span><span class="nt">"channelIds"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"tube-a"</span><span class="p">,</span><span class="w"> </span><span class="s2">"tube-b"</span><span class="p">]</span><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-2-5" name="__codelineno-2-5" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-5"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"niche"</span><span class="p">,</span><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Niche"</span><span class="p">,</span><span class="w"> </span><span class="nt">"channelIds"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"tube-c"</span><span class="p">]</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-2-6" name="__codelineno-2-6" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-6"></a><span class="w"> </span><span class="p">]</span>
<a id="__codelineno-2-7" name="__codelineno-2-7" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-7"></a><span class="p">}</span>
<a id="__codelineno-2-8" name="__codelineno-2-8" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-8"></a>
<a id="__codelineno-2-9" name="__codelineno-2-9" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-9"></a><span class="c1">// Option B: groupKey + sortOrder (per-channel, simpler)</span>
<a id="__codelineno-2-10" name="__codelineno-2-10" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-10"></a><span class="p">{</span><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tube-a"</span><span class="p">,</span><span class="w"> </span><span class="nt">"groupKey"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Featured"</span><span class="p">,</span><span class="w"> </span><span class="nt">"sortOrder"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-2-11" name="__codelineno-2-11" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-11"></a><span class="p">{</span><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tube-b"</span><span class="p">,</span><span class="w"> </span><span class="nt">"groupKey"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Featured"</span><span class="p">,</span><span class="w"> </span><span class="nt">"sortOrder"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-2-12" name="__codelineno-2-12" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-2-12"></a><span class="p">{</span><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"tube-c"</span><span class="p">,</span><span class="w"> </span><span class="nt">"groupKey"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Niche"</span><span class="p">,</span><span class="w"> </span><span class="nt">"sortOrder"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<h3 id="channel-object">Channel Object</h3>
<div class="md-typeset__scrollwrap"><div class="md-typeset__table"><table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Unique channel identifier</td>
</tr>
<tr>
<td><code>name</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Channel display name</td>
</tr>
<tr>
<td><code>favicon</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Channel favicon URL</td>
</tr>
<tr>
<td><code>status</code></td>
<td><code>ChannelStatus</code></td>
<td>⚪</td>
<td>Channel operational status</td>
</tr>
<tr>
<td><code>categories</code></td>
<td><code>string[]</code></td>
<td>⚪</td>
<td>Content categories for this channel — drives the home screen category browser (tapping one runs a search for that term)</td>
</tr>
<tr>
<td><code>tags</code></td>
<td><code>ChannelTag[]</code></td>
<td>⚪</td>
<td>Specialization chips shown in the channel picker (e.g. "4K", "Amateur")</td>
</tr>
<tr>
<td><code>options</code></td>
<td><code>ChannelOption[]</code></td>
<td>⚪</td>
<td>Channel-specific filter options</td>
</tr>
<tr>
<td><code>maintainers</code></td>
<td><code>ChannelMaintainer[]</code></td>
<td>⚪</td>
<td>Attribution entries shown in video cells</td>
</tr>
<tr>
<td><code>premium</code></td>
<td><code>boolean</code></td>
<td>⚪</td>
<td>Whether channel requires premium</td>
</tr>
<tr>
<td><code>description</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Channel description</td>
</tr>
<tr>
<td><code>image</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Channel banner/hero image URL</td>
</tr>
<tr>
<td><code>nsfw</code></td>
<td><code>boolean</code></td>
<td>⚪</td>
<td>Whether channel contains adult content</td>
</tr>
<tr>
<td><code>default</code></td>
<td><code>boolean</code></td>
<td>⚪</td>
<td>Whether this channel is selected by default</td>
</tr>
<tr>
<td><code>sortOrder</code></td>
<td><code>number</code></td>
<td>⚪</td>
<td>Display order when <code>channelGroups</code> is not used — lower values appear first</td>
</tr>
<tr>
<td><code>groupKey</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Section key for grouping channels (e.g. <code>"favorites"</code>, <code>"premium"</code>, or a category name)</td>
</tr>
<tr>
<td><code>ytdlpCommand</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Custom yt-dlp command</td>
</tr>
<tr>
<td><code>cacheDuration</code></td>
<td><code>number</code></td>
<td>⚪</td>
<td>Cache duration in seconds — yt-dlp re-extracts video details when expired</td>
</tr>
</tbody>
</table></div></div>
<div class="admonition info">
<p class="admonition-title">Categories vs Tags</p>
<ul>
<li><strong><code>categories</code></strong> is a flat list of content keywords (e.g. <code>"Comedy"</code>, <code>"Action"</code>) shared across videos from this channel. They populate the home screen <strong>category browser</strong> — tapping one runs a search using that term.</li>
<li><strong><code>tags</code></strong> are specialization labels for the <em>channel itself</em> (e.g. <code>"4K"</code>, <code>"Amateur"</code>, <code>"VR"</code>) displayed as chips in the channel picker UI. They describe what the site is known for, not individual video content.</li>
</ul>
</div>
<h3 id="channeltag-object">ChannelTag Object</h3>
<p>Tags can be supplied as a plain string (legacy) or a typed object — the app accepts both transparently.</p>
<div class="md-typeset__scrollwrap"><div class="md-typeset__table"><table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>name</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Tag label displayed on the channel chip</td>
</tr>
<tr>
<td><code>systemImage</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>SF Symbol name shown alongside the tag label</td>
</tr>
</tbody>
</table></div></div>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-3-1"></a><span class="c1">// Plain string (legacy — still accepted)</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-3-2"></a><span class="nt">"categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"4K"</span><span class="p">,</span><span class="w"> </span><span class="s2">"Amateur"</span><span class="p">]</span>
<a id="__codelineno-3-3" name="__codelineno-3-3" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-3-3"></a>
<a id="__codelineno-3-4" name="__codelineno-3-4" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-3-4"></a><span class="c1">// Object format (recommended — supports icons)</span>
<a id="__codelineno-3-5" name="__codelineno-3-5" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-3-5"></a><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-3-6" name="__codelineno-3-6" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-3-6"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4K"</span><span class="p">,</span><span class="w"> </span><span class="nt">"systemImage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4k.tv"</span><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-3-7" name="__codelineno-3-7" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-3-7"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"VR"</span><span class="p">,</span><span class="w"> </span><span class="nt">"systemImage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"visionpro"</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-3-8" name="__codelineno-3-8" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-3-8"></a><span class="p">]</span>
</code></pre></div>
<h3 id="channelmaintainer-object">ChannelMaintainer Object</h3>
<div class="md-typeset__scrollwrap"><div class="md-typeset__table"><table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Maintainer identifier</td>
</tr>
<tr>
<td><code>name</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Display name</td>
</tr>
<tr>
<td><code>avatar</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Avatar image URL (canonical)</td>
</tr>
<tr>
<td><code>role</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td><code>"maintainer"</code> (built the integration) or <code>"upstream"</code> (federated proxy)</td>
</tr>
</tbody>
</table></div></div>
<p>See <a href="https://docs.hottubapp.io/developers/server/#json-key-names">JSON key names</a> for naming conventions and the legacy <code>profile_picture_url</code> avatar key.</p>
<h3 id="notice-object">Notice Object</h3>
<div class="md-typeset__scrollwrap"><div class="md-typeset__table"><table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>status</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Notice type ("success", "info", "error", "warning", etc.)</td>
</tr>
<tr>
<td><code>message</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Notice title/message</td>
</tr>
<tr>
<td><code>details</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Detailed notice description</td>
</tr>
<tr>
<td><code>priority</code></td>
<td><code>boolean</code></td>
<td>⚪</td>
<td>Whether to display prominently on home page</td>
</tr>
<tr>
<td><code>url</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Action URL for the notice</td>
</tr>
</tbody>
</table></div></div>
<h3 id="channeloption-object">ChannelOption Object</h3>
<div class="md-typeset__scrollwrap"><div class="md-typeset__table"><table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Unique option identifier</td>
</tr>
<tr>
<td><code>title</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Option display title</td>
</tr>
<tr>
<td><code>options</code></td>
<td><code>ChannelOptionChoice[]</code></td>
<td>✅</td>
<td>Available choices for this option</td>
</tr>
<tr>
<td><code>systemImage</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>SF Symbol name for option icon</td>
</tr>
<tr>
<td><code>colorName</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Swift color name for theming</td>
</tr>
<tr>
<td><code>multiSelect</code></td>
<td><code>boolean</code></td>
<td>⚪</td>
<td>Whether multiple choices can be selected</td>
</tr>
<tr>
<td><code>value</code></td>
<td><code>string\|number\|boolean</code></td>
<td>⚪</td>
<td>Current option value</td>
</tr>
</tbody>
</table></div></div>
<h3 id="channeloptionchoice-object">ChannelOptionChoice Object</h3>
<div class="md-typeset__scrollwrap"><div class="md-typeset__table"><table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>id</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Unique choice identifier</td>
</tr>
<tr>
<td><code>title</code></td>
<td><code>string</code></td>
<td>✅</td>
<td>Choice display title</td>
</tr>
<tr>
<td><code>description</code></td>
<td><code>string</code></td>
<td>⚪</td>
<td>Choice description</td>
</tr>
<tr>
<td><code>options</code></td>
<td><code>ChannelOption[]</code></td>
<td>⚪</td>
<td>Nested options shown when this choice is selected</td>
</tr>
</tbody>
</table></div></div>
<h3 id="channelstatus-enum">ChannelStatus Enum</h3>
<div class="md-typeset__scrollwrap"><div class="md-typeset__table"><table>
<thead>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>active</code></td>
<td>Channel is online and fully functional (same as <code>normal</code> / <code>ok</code>)</td>
</tr>
<tr>
<td><code>normal</code></td>
<td>Alias for <code>active</code></td>
</tr>
<tr>
<td><code>ok</code></td>
<td>Alias for <code>active</code></td>
</tr>
<tr>
<td><code>inactive</code></td>
<td>Channel deliberately disabled or suspended</td>
</tr>
<tr>
<td><code>degraded</code></td>
<td>Channel working with reduced quality or performance</td>
</tr>
<tr>
<td><code>maintenance</code></td>
<td>Channel temporarily unavailable due to planned work</td>
</tr>
<tr>
<td><code>restricted</code></td>
<td>Access is limited (e.g. region-locked, paywalled, or subject to a takedown)</td>
</tr>
<tr>
<td><code>error</code></td>
<td>Channel encountered a critical issue</td>
</tr>
<tr>
<td><code>unknown</code></td>
<td>Channel status is not known</td>
</tr>
<tr>
<td><code>testing</code></td>
<td>Channel is in testing mode for development</td>
</tr>
</tbody>
</table></div></div>
<div class="admonition tip">
<p class="admonition-title">Implementation Notes</p>
<ul>
<li>Only <code>id</code> and <code>name</code> are truly required for both <code>ServerStatus</code> and <code>Channel</code></li>
<li>Options create hierarchical filter UIs — choices can have nested options</li>
<li><code>priority</code> notices appear on the home page; others only appear on the lock screen</li>
<li>Colors support both hex codes (<code>#FF0000</code>) and Swift color names (<code>purple</code>)</li>
<li>Channel <code>tags</code> accept either plain strings (legacy) or <code>{ name, systemImage }</code> objects — mixing both in the same array is fine</li>
<li><code>sortOrder</code> and <code>groupKey</code> are the per-channel fallback for sectioning; <code>channelGroups</code> on the server response takes priority when present</li>
</ul>
</div>
<div class="admonition info">
<p class="admonition-title">Popup System</p>
<p>The popup system allows servers to display onboarding flows, age
verification, preferences, and other modal content. Here's an example
multi-page onboarding popup:</p>
<div class="highlight"><pre><span></span><code tabindex="0"><a id="__codelineno-4-1" name="__codelineno-4-1" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-1"></a><span class="p">{</span>
<a id="__codelineno-4-2" name="__codelineno-4-2" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-2"></a><span class="w"> </span><span class="nt">"popup"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-4-3" name="__codelineno-4-3" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-3"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"onboarding"</span><span class="p">,</span>
<a id="__codelineno-4-4" name="__codelineno-4-4" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-4"></a><span class="w"> </span><span class="nt">"pages"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-4-5" name="__codelineno-4-5" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-5"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-4-6" name="__codelineno-4-6" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-6"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ageVerification"</span><span class="p">,</span>
<a id="__codelineno-4-7" name="__codelineno-4-7" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-7"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Welcome to"</span><span class="p">,</span>
<a id="__codelineno-4-8" name="__codelineno-4-8" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-8"></a><span class="w"> </span><span class="nt">"subtitle"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Example Server"</span><span class="p">,</span>
<a id="__codelineno-4-9" name="__codelineno-4-9" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-9"></a><span class="w"> </span><span class="nt">"warning"</span><span class="p">:</span><span class="w"> </span><span class="s2">"⚠️ Adult Content Warning"</span><span class="p">,</span>
<a id="__codelineno-4-10" name="__codelineno-4-10" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-10"></a><span class="w"> </span><span class="nt">"body"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This source contains adult content. You must be 18 years or older to use it. By continuing, you confirm that you meet this requirement and agree to use the app responsibly."</span><span class="p">,</span>
<a id="__codelineno-4-11" name="__codelineno-4-11" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-11"></a><span class="w"> </span><span class="nt">"items"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-4-12" name="__codelineno-4-12" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-12"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-4-13" name="__codelineno-4-13" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-13"></a><span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"section"</span><span class="p">,</span>
<a id="__codelineno-4-14" name="__codelineno-4-14" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-14"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Age Verification"</span><span class="p">,</span>
<a id="__codelineno-4-15" name="__codelineno-4-15" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-15"></a><span class="w"> </span><span class="nt">"items"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-4-16" name="__codelineno-4-16" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-16"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-4-17" name="__codelineno-4-17" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-17"></a><span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"toggle"</span><span class="p">,</span>
<a id="__codelineno-4-18" name="__codelineno-4-18" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-18"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"termsToggle"</span><span class="p">,</span>
<a id="__codelineno-4-19" name="__codelineno-4-19" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-19"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"I am over 18 years of age"</span><span class="p">,</span>
<a id="__codelineno-4-20" name="__codelineno-4-20" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-20"></a><span class="w"> </span><span class="nt">"systemImage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"checkmark.seal.fill"</span><span class="p">,</span>
<a id="__codelineno-4-21" name="__codelineno-4-21" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-21"></a><span class="w"> </span><span class="nt">"color"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gray"</span><span class="p">,</span>
<a id="__codelineno-4-22" name="__codelineno-4-22" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-22"></a><span class="w"> </span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
<a id="__codelineno-4-23" name="__codelineno-4-23" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-23"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-4-24" name="__codelineno-4-24" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-24"></a><span class="w"> </span><span class="p">]</span>
<a id="__codelineno-4-25" name="__codelineno-4-25" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-25"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-4-26" name="__codelineno-4-26" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-26"></a><span class="w"> </span><span class="p">],</span>
<a id="__codelineno-4-27" name="__codelineno-4-27" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-27"></a><span class="w"> </span><span class="nt">"actions"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-4-28" name="__codelineno-4-28" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-28"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-4-29" name="__codelineno-4-29" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-29"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Continue"</span><span class="p">,</span>
<a id="__codelineno-4-30" name="__codelineno-4-30" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-30"></a><span class="w"> </span><span class="nt">"systemImage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"arrow.right.circle.fill"</span><span class="p">,</span>
<a id="__codelineno-4-31" name="__codelineno-4-31" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-31"></a><span class="w"> </span><span class="nt">"color"</span><span class="p">:</span><span class="w"> </span><span class="s2">"blue"</span><span class="p">,</span>
<a id="__codelineno-4-32" name="__codelineno-4-32" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-32"></a><span class="w"> </span><span class="nt">"actionType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"next"</span><span class="p">,</span>
<a id="__codelineno-4-33" name="__codelineno-4-33" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-33"></a><span class="w"> </span><span class="nt">"enabledBy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"termsToggle"</span>
<a id="__codelineno-4-34" name="__codelineno-4-34" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-34"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-4-35" name="__codelineno-4-35" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-35"></a><span class="w"> </span><span class="p">]</span>
<a id="__codelineno-4-36" name="__codelineno-4-36" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-36"></a><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-4-37" name="__codelineno-4-37" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-37"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-4-38" name="__codelineno-4-38" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-38"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"preferences"</span><span class="p">,</span>
<a id="__codelineno-4-39" name="__codelineno-4-39" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-39"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Choose your Preferences"</span><span class="p">,</span>
<a id="__codelineno-4-40" name="__codelineno-4-40" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-40"></a><span class="w"> </span><span class="nt">"subtitle"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Personalize Your Experience"</span><span class="p">,</span>
<a id="__codelineno-4-41" name="__codelineno-4-41" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-41"></a><span class="w"> </span><span class="nt">"body"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Select the type of content you'd like to explore. This can be changed later in the filters menu."</span><span class="p">,</span>
<a id="__codelineno-4-42" name="__codelineno-4-42" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-42"></a><span class="w"> </span><span class="nt">"items"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-4-43" name="__codelineno-4-43" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-43"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-4-44" name="__codelineno-4-44" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-44"></a><span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"custom"</span><span class="p">,</span>
<a id="__codelineno-4-45" name="__codelineno-4-45" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-45"></a><span class="w"> </span><span class="nt">"view"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ServerFiltersView"</span>
<a id="__codelineno-4-46" name="__codelineno-4-46" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-46"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-4-47" name="__codelineno-4-47" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-47"></a><span class="w"> </span><span class="p">],</span>
<a id="__codelineno-4-48" name="__codelineno-4-48" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-48"></a><span class="w"> </span><span class="nt">"actions"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<a id="__codelineno-4-49" name="__codelineno-4-49" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-49"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-4-50" name="__codelineno-4-50" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-50"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Continue"</span><span class="p">,</span>
<a id="__codelineno-4-51" name="__codelineno-4-51" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-51"></a><span class="w"> </span><span class="nt">"systemImage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"arrow.right.circle.fill"</span><span class="p">,</span>
<a id="__codelineno-4-52" name="__codelineno-4-52" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-52"></a><span class="w"> </span><span class="nt">"color"</span><span class="p">:</span><span class="w"> </span><span class="s2">"blue"</span><span class="p">,</span>
<a id="__codelineno-4-53" name="__codelineno-4-53" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-53"></a><span class="w"> </span><span class="nt">"actionType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"next"</span>
<a id="__codelineno-4-54" name="__codelineno-4-54" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-54"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-4-55" name="__codelineno-4-55" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-55"></a><span class="w"> </span><span class="p">]</span>
<a id="__codelineno-4-56" name="__codelineno-4-56" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-56"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-4-57" name="__codelineno-4-57" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-57"></a><span class="w"> </span><span class="p">]</span>
<a id="__codelineno-4-58" name="__codelineno-4-58" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-58"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-4-59" name="__codelineno-4-59" href="https://docs.hottubapp.io/developers/api/status/#__codelineno-4-59"></a><span class="p">}</span>
</code></pre></div>
<p><strong>Popup Features:</strong></p>
<ul>
<li><strong>Multi-page flows</strong> - Create step-by-step onboarding experiences</li>
<li><strong>Conditional actions</strong> - Use <code>enabledBy</code> to require toggle states before proceeding</li>
<li><strong>Custom views</strong> - Embed specialized UI like <code>ServerFiltersView</code> for complex interactions</li>
<li><strong>Rich content</strong> - Support for titles, subtitles, warnings, body text, and actions</li>
<li><strong>Interactive controls</strong> - Toggles, buttons, and sections for user input</li>
</ul>
</div></div>
<form class="md-feedback" name="feedback">
<fieldset>
<legend class="md-feedback__title">
Was this page helpful?
</legend>
<div class="md-feedback__inner">
<div class="md-feedback__list">
<button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m7 0c0 .8-.7 1.5-1.5 1.5S14 10.3 14 9.5 14.7 8 15.5 8s1.5.7 1.5 1.5m-5 7.73c-1.75 0-3.29-.73-4.19-1.81L9.23 14c.45.72 1.52 1.23 2.77 1.23s2.32-.51 2.77-1.23l1.42 1.42c-.9 1.08-2.44 1.81-4.19 1.81"></path></svg>
</button>
<button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10m-6.5-4c.8 0 1.5.7 1.5 1.5s-.7 1.5-1.5 1.5-1.5-.7-1.5-1.5.7-1.5 1.5-1.5M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m2 4.5c1.75 0 3.29.72 4.19 1.81l-1.42 1.42C14.32 16.5 13.25 16 12 16s-2.32.5-2.77 1.23l-1.42-1.42C8.71 14.72 10.25 14 12 14"></path></svg>
</button>
</div>
<div class="md-feedback__note">
<div data-md-value="1" hidden="">
Thanks for your feedback!
</div>
<div data-md-value="0" hidden="">
Thanks for your feedback! Help us improve this page by
</div>
</div>
</div>
</fieldset>
</form>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden="" style="top: 64px;" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"></path></svg>
Back to top
</button>
</main>
<link rel="stylesheet" href="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/all.min.css">
<footer class="site-footer" style="background-color: rgba(0, 0, 0, 0.5); width: 100%">
<div class="footer-content" style="
max-width: 1200px;
margin: 0 auto;
display: flex;
justify-content: space-between;
align-items: center;
">
<div class="footer-brand" style="display: flex; flex-direction: row; align-items: center; gap: 10px">
<a href="https://reddoorendeavors.com/">
<img src="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/logo.png" alt="Red Door Endeavors" style="height: 50px; padding-top: 10px; padding-bottom: 10px">
</a>
<div class="footer-copyright">© 2024 Red Door Endeavors, Inc. All rights reserved.</div>
</div>
<div class="footer-nav">
<!-- Uncomment the following lines to display the links -->
<!-- <a href="https://docs.hottubapp.io/products">Products</a>
<a href="https://docs.hottubapp.io/about">About</a>
<a href="https://docs.hottubapp.io/contact">Contact</a> -->
<div class="social-links" style="display: flex; gap: 12px">
<a href="https://github.com/hottubapp" class="social-link">
<i class="fa-brands fa-github" style="color: white; font-size: 20px"></i>
</a>
<a href="https://hottubapp.io/discord" class="social-link">
<i class="fab fa-discord" style="color: white; font-size: 20px"></i>
</a>
<a href="https://docs.hottubapp.io/cdn-cgi/l/email-protection#81f2f4f1f1eef3f5c1e9eef5f5f4e3e0f1f1afe8ee" class="social-link">
<i class="fas fa-envelope" style="color: white; font-size: 20px"></i>
</a>
<a href="https://patreon.com/c1d3rdev" class="social-link">
<i class="fa-brands fa-patreon" style="color: white; font-size: 20px"></i>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": ".", "features": ["navigation.instant", "navigation.tracking", "navigation.sections", "navigation.expand", "navigation.indexes", "navigation.top", "search.suggest", "search.highlight", "toc.follow", "navigation.search", "navigation.sticky"], "search": "assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/bundle.f55a23d4.min.js"></script>
<script src="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/react.production.min.js"></script>
<script src="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/react-dom.production.min.js"></script>
<script src="%F0%9F%93%A1%20Status%20-%20Hot%20Tub%20Docs_files/three.min.js"></script>
<script src="assets/process-polyfill.js"></script>
<script src="assets/content-restrictions-video.js"></script>
<script src="assets/contact-reps.js"></script>
<script src="assets/home-feature-cards.js"></script>
<script src="assets/demo-3d.bundle.js"></script>
<script src="assets/bubble-background.js"></script>
</body></html>
Reference in New Issue View Git Blame Copy Permalink