Get paused playback sessions for one type

curl --request GET \
  --url 'https://api.simkl.com/sync/playback/{type}?client_id=' \
  --header 'Authorization: Bearer <token>' \
  --header 'User-Agent: <user-agent>'

import requests

url = "https://api.simkl.com/sync/playback/{type}?client_id="

headers = {
    "User-Agent": "<user-agent>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'User-Agent': '<user-agent>', Authorization: 'Bearer <token>'}
};

fetch('https://api.simkl.com/sync/playback/{type}?client_id=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'GET',
  headers: {'User-Agent': '<user-agent>', Authorization: 'Bearer <token>'}
};

fetch('https://api.simkl.com/sync/playback/{type}?client_id=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.simkl.com/sync/playback/{type}?client_id=")
  .get()
  .addHeader("User-Agent", "<user-agent>")
  .addHeader("Authorization", "Bearer <token>")
  .build()

val response = client.newCall(request).execute()

import Foundation

let url = URL(string: "https://api.simkl.com/sync/playback/{type}")!
var components = URLComponents(url: url, resolvingAgainstBaseURL: true)!
let queryItems: [URLQueryItem] = [
  URLQueryItem(name: "client_id", value: ""),
]
components.queryItems = components.queryItems.map { $0 + queryItems } ?? queryItems

var request = URLRequest(url: components.url!)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
  "User-Agent": "<user-agent>",
  "Authorization": "Bearer <token>"
]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

HttpResponse<String> response = Unirest.get("https://api.simkl.com/sync/playback/{type}?client_id=")
  .header("User-Agent", "<user-agent>")
  .header("Authorization", "Bearer <token>")
  .asString();

const url = 'https://api.simkl.com/sync/playback/{type}?client_id=';
const options = {
  method: 'GET',
  headers: {'User-Agent': '<user-agent>', Authorization: 'Bearer <token>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.simkl.com/sync/playback/{type}?client_id="

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("User-Agent", "<user-agent>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api.simkl.com/sync/playback/{type}?client_id=");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("User-Agent", "<user-agent>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.simkl.com/sync/playback/{type}?client_id=");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("User-Agent", "<user-agent>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.simkl.com/sync/playback/{type}?client_id=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "User-Agent: <user-agent>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.simkl.com/sync/playback/{type}?client_id=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["User-Agent"] = '<user-agent>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

$headers=@{}
$headers.Add("User-Agent", "<user-agent>")
$headers.Add("Authorization", "Bearer <token>")
$response = Invoke-WebRequest -Uri 'https://api.simkl.com/sync/playback/{type}?client_id=' -Method GET -Headers $headers

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.simkl.com/sync/playback/{type}?client_id=");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "User-Agent: <user-agent>");
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.simkl.com/sync/playback/{type}?client_id=");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "User-Agent: <user-agent>");
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

[
  {
    "id": 123,
    "progress": 45.5,
    "paused_at": "2024-01-15T10:30:00.000Z",
    "type": "episode",
    "episode": {
      "season": 1,
      "episode": 5,
      "title": "Episode 5",
      "tvdb_season": 1,
      "tvdb_number": 5
    },
    "show": {
      "title": "Breaking Bad",
      "year": 2008,
      "ids": {
        "simkl": 12345,
        "slug": "breaking-bad",
        "tmdb": "1429",
        "imdb": "tt0903747"
      }
    }
  },
  {
    "id": 124,
    "progress": 75,
    "paused_at": "2024-01-15T11:15:00.000Z",
    "type": "movie",
    "movie": {
      "title": "Inception",
      "year": 2010,
      "ids": {
        "simkl": 67890,
        "slug": "inception",
        "tmdb": "27205",
        "imdb": "tt1375666"
      }
    }
  }
]

{
  "error": "user_token_failed",
  "code": 401
}

{
  "error": "id_err",
  "code": 404
}

{
  "error": "client_id_failed",
  "code": 412,
  "message": "Your client_id is wrong. Try another one"
}

{
  "error": "rate_limit",
  "code": 429
}

{
  "error": "internal",
  "code": 500
}

Get paused playback sessions for one type

Returns the user’s saved paused playbacks — created by /scrobble/pause or /scrobble/stop with progress < 80%. The {type} segment is optional:

Path	Returns
`GET /sync/playback`	All paused playbacks (episodes + movies).
`GET /sync/playback/episodes`	TV/anime episode playbacks only.
`GET /sync/playback/movies`	Movie playbacks only.

The response shape is identical across the three forms; only the included items differ. Resume a session by calling /scrobble/start with the same item.

Query parameters

Param	Effect	Default
`date_from`	Only sessions with `paused_at >= date_from`.	—
`date_to`	Only sessions with `paused_at < date_to`.	—
`hide_watched`	Exclude items already watched after the pause was created.	`true`
`limit`	Max items returned (1–10000).	`10000`

Item shape

{
  "id": 12345,
  "progress": 42.2,
  "paused_at": "2024-04-30T22:13:00Z",
  "type": "episode",
  "episode": {
    "season": 1,
    "number": 3,
    "title": "Chapter Three: Holly Jolly",
    "tvdb_season": 1,
    "tvdb_number": 3
  },
  "show": {
    "title": "Stranger Things",
    "year": 2016,
    "ids": {
      "simkl": 39687,
      "imdb": "tt4574334",
      "tvdb": 305288
    }
  }
}

Note: progress is a percentage (0-100) — same scale as the scrobble endpoints. The example values shown above (75, 45.5, 42.2) are real outputs from the API.

Members can browse and clean these up at simkl.com/my/history/playback-progress-manager.

Retention by plan

Free — 7 days · PRO — 30 days · VIP — 90 days

Sessions persist until they’re manually removed via DELETE /sync/playback/{id}, replaced by the next scrobble update on the same title, or aged out per the plan retention window above. They are not auto-deleted on paused_at expiry — you’ll see the same session in the response indefinitely until one of those three things happens.

Scrobble guide — full walkthrough

Real-time playback tracking — /start, /pause, /stop lifecycle, paused-playback resumption across devices, when scrobble auto-completes, and the difference between /scrobble/checkin (fire-and-forget) and /scrobble/start (active tracking).

Which IDs can I send/expect? All accepted input identifiers and the keys you’ll see echoed back in responses are listed at Standard media objects → Supported ID keys. Send every ID you have on writes — Simkl picks the first that resolves and ignores the rest. Reminder: slug is response-only (never send it on a request).

GET

sync

playback

{type}

Get paused playback sessions for one type

curl --request GET \
  --url 'https://api.simkl.com/sync/playback/{type}?client_id=' \
  --header 'Authorization: Bearer <token>' \
  --header 'User-Agent: <user-agent>'

import requests

url = "https://api.simkl.com/sync/playback/{type}?client_id="

headers = {
    "User-Agent": "<user-agent>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'User-Agent': '<user-agent>', Authorization: 'Bearer <token>'}
};

fetch('https://api.simkl.com/sync/playback/{type}?client_id=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'GET',
  headers: {'User-Agent': '<user-agent>', Authorization: 'Bearer <token>'}
};

fetch('https://api.simkl.com/sync/playback/{type}?client_id=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.simkl.com/sync/playback/{type}?client_id=")
  .get()
  .addHeader("User-Agent", "<user-agent>")
  .addHeader("Authorization", "Bearer <token>")
  .build()

val response = client.newCall(request).execute()

import Foundation

let url = URL(string: "https://api.simkl.com/sync/playback/{type}")!
var components = URLComponents(url: url, resolvingAgainstBaseURL: true)!
let queryItems: [URLQueryItem] = [
  URLQueryItem(name: "client_id", value: ""),
]
components.queryItems = components.queryItems.map { $0 + queryItems } ?? queryItems

var request = URLRequest(url: components.url!)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
  "User-Agent": "<user-agent>",
  "Authorization": "Bearer <token>"
]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

HttpResponse<String> response = Unirest.get("https://api.simkl.com/sync/playback/{type}?client_id=")
  .header("User-Agent", "<user-agent>")
  .header("Authorization", "Bearer <token>")
  .asString();

const url = 'https://api.simkl.com/sync/playback/{type}?client_id=';
const options = {
  method: 'GET',
  headers: {'User-Agent': '<user-agent>', Authorization: 'Bearer <token>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.simkl.com/sync/playback/{type}?client_id="

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("User-Agent", "<user-agent>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api.simkl.com/sync/playback/{type}?client_id=");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("User-Agent", "<user-agent>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.simkl.com/sync/playback/{type}?client_id=");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("User-Agent", "<user-agent>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.simkl.com/sync/playback/{type}?client_id=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "User-Agent: <user-agent>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.simkl.com/sync/playback/{type}?client_id=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["User-Agent"] = '<user-agent>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

$headers=@{}
$headers.Add("User-Agent", "<user-agent>")
$headers.Add("Authorization", "Bearer <token>")
$response = Invoke-WebRequest -Uri 'https://api.simkl.com/sync/playback/{type}?client_id=' -Method GET -Headers $headers

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.simkl.com/sync/playback/{type}?client_id=");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "User-Agent: <user-agent>");
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.simkl.com/sync/playback/{type}?client_id=");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "User-Agent: <user-agent>");
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

[
  {
    "id": 123,
    "progress": 45.5,
    "paused_at": "2024-01-15T10:30:00.000Z",
    "type": "episode",
    "episode": {
      "season": 1,
      "episode": 5,
      "title": "Episode 5",
      "tvdb_season": 1,
      "tvdb_number": 5
    },
    "show": {
      "title": "Breaking Bad",
      "year": 2008,
      "ids": {
        "simkl": 12345,
        "slug": "breaking-bad",
        "tmdb": "1429",
        "imdb": "tt0903747"
      }
    }
  },
  {
    "id": 124,
    "progress": 75,
    "paused_at": "2024-01-15T11:15:00.000Z",
    "type": "movie",
    "movie": {
      "title": "Inception",
      "year": 2010,
      "ids": {
        "simkl": 67890,
        "slug": "inception",
        "tmdb": "27205",
        "imdb": "tt1375666"
      }
    }
  }
]

{
  "error": "user_token_failed",
  "code": 401
}

{
  "error": "id_err",
  "code": 404
}

{
  "error": "client_id_failed",
  "code": 412,
  "message": "Your client_id is wrong. Try another one"
}

{
  "error": "rate_limit",
  "code": 429
}

{
  "error": "internal",
  "code": 500
}

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

OAuth 2.0 or PIN-flow access_token. Required for endpoints that read or modify the user's library, scrobble session, ratings, settings, or playbacks. See 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

episodes or movies to filter by item type. To get all paused playbacks of both kinds, call GET /sync/playback. Strictness; drop the segment from the URL to call without it.

Available options:

movies,

episodes

Query Parameters

limit

number

Slice your result to the first N items. Default: 10000

hide_watched

enum<string>

default:true

When true, hides items already watched after the pause was created.

Available options:

true,

false

date_from

string

Filter sessions from this date

date_to

string

Filter sessions until this date

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

integer

Internal playback session ID. Use to delete via DELETE /sync/playback/{id}.

progress

number

Saved progress percentage 0–100.

watched_at

string<date-time>

movie

object

Standard movie object. See the Standard Media Objects guide.

Hide child attributes

movie.ids

object

required

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

movie.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

movie.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

movie.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

movie.ids.tmdb

string

TMDb ID.

Example:

"296"

movie.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

movie.ids.mal

string

MyAnimeList ID.

Example:

"4246"

movie.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

movie.ids.anilist

string

AniList ID.

Example:

"21"

movie.ids.kitsu

string

Kitsu ID.

Example:

"12"

movie.ids.anisearch

string

aniSearch ID.

Example:

"2227"

movie.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

movie.ids.livechart

string

LiveChart ID.

Example:

"321"

movie.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

movie.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

movie.ids.hulu

string

Hulu episode ID.

movie.ids.crunchyroll

string

Crunchyroll episode ID.

movie.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

movie.title

string

Example:

"Terminator 3: Rise of the Machines"

movie.year

integer

Example:

2003

show

object

Standard show object. May include nested seasons/episodes for partial sync.

Hide child attributes

show.ids

object

required

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

show.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

show.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

show.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

show.ids.tmdb

string

TMDb ID.

Example:

"296"

show.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

show.ids.mal

string

MyAnimeList ID.

Example:

"4246"

show.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

show.ids.anilist

string

AniList ID.

Example:

"21"

show.ids.kitsu

string

Kitsu ID.

Example:

"12"

show.ids.anisearch

string

aniSearch ID.

Example:

"2227"

show.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

show.ids.livechart

string

LiveChart ID.

Example:

"321"

show.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

show.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

show.ids.hulu

string

Hulu episode ID.

show.ids.crunchyroll

string

Crunchyroll episode ID.

show.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

show.title

string

Example:

"The Walking Dead"

show.year

integer

Example:

2010

show.seasons

object[]

Hide child attributes

show.seasons.number

integer

show.seasons.episodes

object[]

Hide child attributes

show.seasons.episodes.season

integer

Required range: x >= 0

Example:

1

show.seasons.episodes.number

integer

Required range: x >= 1

Example:

2

show.seasons.episodes.watched_at

string<date-time>

ISO-8601 GMT timestamp.

Example:

"2014-09-01T09:10:11Z"

show.seasons.episodes.ids

object

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

show.seasons.episodes.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

show.seasons.episodes.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

show.seasons.episodes.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

show.seasons.episodes.ids.tmdb

string

TMDb ID.

Example:

"296"

show.seasons.episodes.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

show.seasons.episodes.ids.mal

string

MyAnimeList ID.

Example:

"4246"

show.seasons.episodes.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

show.seasons.episodes.ids.anilist

string

AniList ID.

Example:

"21"

show.seasons.episodes.ids.kitsu

string

Kitsu ID.

Example:

"12"

show.seasons.episodes.ids.anisearch

string

aniSearch ID.

Example:

"2227"

show.seasons.episodes.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

show.seasons.episodes.ids.livechart

string

LiveChart ID.

Example:

"321"

show.seasons.episodes.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

show.seasons.episodes.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

show.seasons.episodes.ids.hulu

string

Hulu episode ID.

show.seasons.episodes.ids.crunchyroll

string

Crunchyroll episode ID.

show.seasons.episodes.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

anime

object

Standard anime object. Like Show, but may include anime_type. Episode numbering follows AniDB.

Hide child attributes

anime.ids

object

required

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

anime.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

anime.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

anime.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

anime.ids.tmdb

string

TMDb ID.

Example:

"296"

anime.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

anime.ids.mal

string

MyAnimeList ID.

Example:

"4246"

anime.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

anime.ids.anilist

string

AniList ID.

Example:

"21"

anime.ids.kitsu

string

Kitsu ID.

Example:

"12"

anime.ids.anisearch

string

aniSearch ID.

Example:

"2227"

anime.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

anime.ids.livechart

string

LiveChart ID.

Example:

"321"

anime.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

anime.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

anime.ids.hulu

string

Hulu episode ID.

anime.ids.crunchyroll

string

Crunchyroll episode ID.

anime.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

anime.title

string

Example:

"Attack on Titan"

anime.year

integer

Example:

2013

anime.anime_type

enum<string>

Anime production format. tv is the common case; movies, OVAs, ONAs, and music videos all surface through the /anime/* endpoints with the same response shape.

Available options:

tv,

movie,

special,

ova,

ona,

music video

anime.episodes

object[]

Hide child attributes

anime.episodes.season

integer

Required range: x >= 0

Example:

1

anime.episodes.number

integer

Required range: x >= 1

Example:

2

anime.episodes.watched_at

string<date-time>

ISO-8601 GMT timestamp.

Example:

"2014-09-01T09:10:11Z"

anime.episodes.ids

object

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

anime.episodes.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

anime.episodes.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

anime.episodes.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

anime.episodes.ids.tmdb

string

TMDb ID.

Example:

"296"

anime.episodes.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

anime.episodes.ids.mal

string

MyAnimeList ID.

Example:

"4246"

anime.episodes.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

anime.episodes.ids.anilist

string

AniList ID.

Example:

"21"

anime.episodes.ids.kitsu

string

Kitsu ID.

Example:

"12"

anime.episodes.ids.anisearch

string

aniSearch ID.

Example:

"2227"

anime.episodes.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

anime.episodes.ids.livechart

string

LiveChart ID.

Example:

"321"

anime.episodes.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

anime.episodes.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

anime.episodes.ids.hulu

string

Hulu episode ID.

anime.episodes.ids.crunchyroll

string

Crunchyroll episode ID.

anime.episodes.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

episode

object

Episode reference. Use season + number, or ids.

Hide child attributes

episode.season

integer

Required range: x >= 0

Example:

1

episode.number

integer

Required range: x >= 1

Example:

2

episode.watched_at

string<date-time>

ISO-8601 GMT timestamp.

Example:

"2014-09-01T09:10:11Z"

episode.ids

object

External and internal identifiers for an item. Pass as many as you have — Simkl resolves to the canonical record.

Hide child attributes

episode.ids.simkl

integer

Simkl internal ID. Most reliable.

Example:

53536

episode.ids.slug

string

URL-safe slug returned in responses.

Example:

"attack-on-titan"

episode.ids.imdb

string

IMDb ID.

Example:

"tt0181852"

episode.ids.tmdb

string

TMDb ID.

Example:

"296"

episode.ids.tvdb

string

TVDB ID or slug.

Example:

"153021"

episode.ids.mal

string

MyAnimeList ID.

Example:

"4246"

episode.ids.anidb

string

AniDB ID. Specifying just this is enough for anime lookups.

Example:

"10846"

episode.ids.anilist

string

AniList ID.

Example:

"21"

episode.ids.kitsu

string

Kitsu ID.

Example:

"12"

episode.ids.anisearch

string

aniSearch ID.

Example:

"2227"

episode.ids.animeplanet

string

Anime-Planet slug.

Example:

"one-piece"

episode.ids.livechart

string

LiveChart ID.

Example:

"321"

episode.ids.letterboxd

string

Letterboxd slug.

Example:

"the-truman-show"

episode.ids.netflix

string

Netflix movie ID.

Example:

"70210890"

episode.ids.hulu

string

Hulu episode ID.

episode.ids.crunchyroll

string

Crunchyroll episode ID.

episode.ids.traktslug

string

Trakt slug.

Example:

"john-wick-chapter-4-2023"

Example:

{
  "simkl": 53536,
  "imdb": "tt0181852",
  "tmdb": "296"
}

⌘I

API Reference

Trending

Calendar

Redirect

Auth

Scrobble

Playback

Sync

Search

TV

Anime

Movies

Ratings

Users

Changes

Get paused playback sessions for one type

Query parameters

Item shape

Retention by plan

Scrobble guide — full walkthrough

Authorizations

Headers

Path Parameters

Query Parameters

Response