---
hide:
  - navigation
toc_depth: 3
---

# API Reference

## API Client (`uiprotect.api`)

::: uiprotect.api
options:
show_root_toc_entry: false
show_signature_annotations: true
show_source: false
heading_level: 3

## Data Models (`uiprotect.data`)

::: uiprotect.data
options:
show_root_toc_entry: false
show_signature_annotations: true
show_source: false
heading_level: 3

## Exceptions (`uiprotect.exception`)

::: uiprotect.exceptions
options:
show_root_toc_entry: false
show_signature_annotations: true
show_source: false
heading_level: 3

## Stream (`uiprotect.stream`)

::: uiprotect.stream
options:
show_root_toc_entry: false
show_signature_annotations: true
show_source: false
heading_level: 3

## Utils (`uiprotect.utils`)

::: uiprotect.utils
options:
show_root_toc_entry: false
show_signature_annotations: true
show_source: false
heading_level: 3

## Websocket (`uiprotect.websocket`)

::: uiprotect.websocket
options:
show_root_toc_entry: false
show_signature_annotations: true
show_source: false
heading_level: 3
