Skip to content

Overview

The Multi-Scrobbler server API is documented in OpenAPI format and includes endpoints useful for programatically interacting with your Play data and the various Sources/Clients you have configured.

Additionally, the Ingress category endpoints document the body/query shape required to make a successful api call for Ingress-based Sources.

:::tip

If you not using Ingress-based Sources or trying to write an application to use the MS API, you do not not need to use this docs section.

:::

:::important

The endpoints documented here, other than those in Ingress categories, are subject to change until a release declares them stable.

:::

Information

  • OpenAPI version: 3.1.0

Session cookie set by logging in to the dashboard. Only required once the instance is secured (an admin password is set).

Security scheme type: apiKey

Cookie parameter name: ms.session_token

API key created in the dashboard under Settings -> Account. Read keys can only use GET requests, Write keys can use everything. Only required once the instance is secured (an admin password is set).

Security scheme type: http