Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api.simkl.org/llms.txt

Use this file to discover all available pages before exploring further.

The Simkl API lets you extend Simkl — the dream “TV, Anime and Movie Tracker” — into your own apps. Build a media-center plugin, a mobile tracker, a browser extension, or anything else you can dream up. Every request uses HTTPS, returns JSON, and follows REST conventions.
Users open your app and see their library in seconds — not minutes. Most trackers re-download the whole watchlist on every launch; that’s the spinner your users sit through. Simkl’s two-phase sync — check a tiny timestamp, fetch only the items that changed — means returning users see everything instantly, and your app moves only the bytes that actually moved. The Sync guide has the pattern with reference implementations in Node and Python.
This site has three tabs — switch via the header bar at the top: Documentation (you’re here, concepts and guides), API Reference (every endpoint with try-it-now), and Changelog.

​
Start here

API rules

Read this before you ship. Attribution, free-for-non-commercial terms, and when you need a commercial license.

Get an API key

Create a new app in your developer settings to receive a client_id.

Quickstart

Authenticate a user and make your first call in under 5 minutes.

API Reference

Separate tab. Every endpoint with an interactive try-it-now playground.

​
What would you like to do?

Authenticate a user

OAuth 2.0 for web and mobile, or PIN flow for TVs and consoles.

Search the catalog

Find titles by name, IMDB / TMDB / TVDB / MAL / AniDB ID, or text query.

Sync user history

Users open and see their library in seconds — not minutes. Check a tiny timestamp, fetch only what changed since last sync.

Scrobble in real time

Track playback live with start / pause / stop events.

Pull calendars

CDN-hosted JSON for upcoming episodes and movie releases — no auth.

Show what's trending

Pre-built JSON for “Most watched” lists — no auth required.

​
What you can build

Media-center plugins

Sync Plex, Jellyfin, Kodi, Emby, Infuse — anywhere users watch — to one cloud library.

Mobile trackers

iOS and Android apps that browse, search, scrobble, and rate.

Browser extensions

One-click “Mark as watched” or “Add to watchlist” from any web page.

​
Base URL

https://api.simkl.com

​
Required parameters and headers

Every request needs three URL parameters and a User-Agent header: 
/endpoint?client_id=YOUR_CLIENT_ID&app-name=my-app-name&app-version=1.0
WhatWhereValue
client_idURL paramYour client_id from developer settings
app-nameURL paramA short identifier for your app
app-versionURL paramYour app’s version
User-AgentHeaderDescriptive name/version (e.g. MyApp/1.0)
AuthorizationHeaderBearer YOUR_ACCESS_TOKEN (only for endpoints marked Token Required)
See Headers and conventions for the full reference.

​
Resources

Quickstart

Get from zero to your first authenticated API call in five minutes.

Changelog

What’s new across endpoints, schemas, and the docs themselves.

​
Stay in the loop

Discord community

Talk to the Simkl team and other developers.

Status

Live uptime and incident history.
If a method you need doesn’t exist yet, DM us on Discord or visit support.simkl.com — we add things fast.