API Reference
Internal API docs generated by TypeDoc. For contributors and developers extending the CLI.
Modules
| Module | Description |
|---|---|
| api/client | HTTP client for Spotify Web API |
| api/player | Playback control endpoints |
| api/tracks | Track and saved-track endpoints |
| api/albums | Album and saved-album endpoints |
| api/playlists | Playlist CRUD and track management |
| api/search | Search across Spotify's catalog |
| api/user | User profile and top items |
Auth
| Module | Description |
|---|---|
| auth/flow | OAuth 2.0 PKCE login flow |
| auth/token-store | Token persistence and refresh |
| auth/pkce | PKCE challenge/verifier generation |
| auth/server | Local OAuth callback server |
Schemas
Zod schemas used for Spotify API response validation.
| Module | Description |
|---|---|
| schemas/track | Track objects |
| schemas/album | Album objects |
| schemas/player | Player state and device objects |
| schemas/playlist | Playlist and playlist-track objects |
| schemas/search | Search result objects |
| schemas/user | User profile objects |
| schemas/artist | Artist objects |
| schemas/common | Shared types (pagination, images) |
Utilities
| Module | Description |
|---|---|
| errors | Structured error codes and error classes |
| config | CLI configuration and paths |
| output | JSON output formatting |
| parse | Argument parsing utilities |
