Cider Docs
GitHubTwitterWebsite
  • 👋README
  • docs
    • 1.client
      • Disclaimer
      • Troubleshooting FAQs
      • RPC Documentation
    • 2.other
      • Client Protocol Schema
    • 3.legacy-docs
      • 2.compilation
        • Compiling on Linux
        • Compiling on macOS
        • Compiling on Windows
      • 3.legacy-plugins
        • Additional Links
        • REST API
        • Creating a Basic Plugin
        • documentation
        • Frontend API
        • Publishing to GitHub
        • Renderer
        • Unsorted Features
      • 4.themes
        • Available Attributes
        • Publishing to GitHub
        • Theme Definitions (theme.json)
        • Creating a Theme
        • Using Resources in Themes
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
Export as PDF
  1. docs
  2. 3.legacy-docs
  3. 3.legacy-plugins

REST API

Learn how to control the client using REST

PreviousAdditional LinksNextCreating a Basic Plugin

Last updated 9 months ago

Was this helpful?

Cider offers a simple REST API to remotely control the app.

URL: http://localhost:9000/api/

Endpoints

Endpoint
Description

/playpause

Toggle between play and pause

/play

Play

/pause

Pause

/stop

Stop the current song

/next

Skip to the next song in the queue

/previous

Go back to the previous song in the queue

Endpoint
Method
Description
Usage

/v3

POST

Access the MusicKit instance and use the v3 API routes

Takes 3 parameters. route body options

https://developer.apple.com/documentation/applemusicapi/