Skip to main content
GET

Authorizations

client_id
string
query
default:YOUR_CLIENT_ID
required

Preferred form: your client_id as a URL query parameter on every request. Self-describing in logs and curl commands. See Headers and required parameters.

Authorization
string
header
default:YOUR_ACCESS_TOKEN
required

A user access_token, sent as Authorization: Bearer .... Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. Every flow returns the same kind of token. See Set up authentication.

Headers

User-Agent
string
required

Descriptive identifier for your app, ideally name/version. Examples: PlexMediaServer/1.43.1.10540, kodi-simkl/0.9.2, MyApp/2.4.1 (https://myapp.com).

Path Parameters

type
enum<string>
required

Media-type slice. Use all to fetch every type in one response — this is the canonical "I don't care which type" form. The path segment is required because OpenAPI 3.1 does not permit optional path parameters.

Available options:
movies,
tv,
anime,
all
Example:

"all"

Query Parameters

user_watchlist
enum<string>
default:all
required
Available options:
all,
watching,
plantowatch,
completed,
dropped,
hold
Example:

"1"

fields
enum<string>
  • A comma-separated list of additional fields to include in the response.
  • simkl – returns the Simkl rating and votes.
  • ext – includes external ratings such as IMDB or MAL if available.
  • rank – returns the rank within the Simkl service for that media type (movie, tv, anime).
  • release_status – includes the release status of the item.
  • year – includes the year of release.
  • Example: fields=rank,droprate,simkl,ext,year
Available options:
simkl,
ext,
rank,
release_status,
year,
link
client_id
string
required

Your client_id from your Simkl developer settings. Required on every request.

app-name
string
required

Short, lowercase identifier for your app (e.g. plex-scrobbler, kodi-bridge). Helps Simkl identify which apps are using the API.

app-version
string
required

Your app's current version (e.g. 1.0, 2.4.1). Helps Simkl debug issues you report.

Response

OK

id
number
required
type
string
required
release_status
string
required
release_year
number
required
rank
number
required
simkl
object
required
imdb
object

External-source rating.

mal
object

External-source rating.