New home: api.simkl.org
The Simkl developer documentation has moved to api.simkl.org.
Apiary (where these docs have lived for years) is being sunset by Oracle in October 2026. All new endpoints, breaking changes, and improvements are published on the new site. The pages below are frozen as of 2026-05-22 and will be retired when Oracle pulls Apiary down.
The new documentation at api.simkl.org is a top-to-bottom rewrite, not a content port. What you will find there:
- Detailed workflow guides for Sync, Scrobble, Search, Anime, Deep linking, Mark as watched, and the new Rewatches guide.
- All three authentication flows properly walked through at api.simkl.org/authentication: OAuth 2.0 for server-side web apps, Public PKCE for mobile, SPAs, browser extensions, and desktop binaries, and the PIN flow for TVs, consoles, CLIs, and media-server plugins.
- Conventions pages for the cross-cutting topics this Apiary spec never covered: Headers, Pagination, Dates, Watchlist statuses, Null values, Images, and CORS.
- A flat Errors page covering every HTTP status code, with cause, fix, and example for each.
- Interactive try-it-now playground on all 48 endpoints across 14 categories. Drop in your token, hit Send, get a real response back.
- Copy-paste examples in 16 languages: curl, Python, JS/TS, Kotlin, Swift, Java, Go, C#, Ruby, PowerShell, C/C++, and more.
- LLM-friendly: every page can be copied as raw markdown or opened straight in Claude, ChatGPT, Cursor, or VSCode. Full-site llms.txt is published too.
- Full OpenAPI 3.1 spec with every endpoint and every response shape verified against the live API. Point your SDK generator at it.
- Rewatches:
POST /sync/history?allow_rewatch=yesnow tracks separate viewing sessions on items the user already finished, the same data that powers the Rewatches panel on simkl.com. Up to 50 sessions per movie, show, or anime, with proper session IDs you can resume. Available for Simkl Pro and VIP members. - API Analytics: every registered Simkl app now has a built-in live request log. 24 hours of individual requests, with edge and origin status codes, latency, burst detection for retry loops, and CSV export. Useful for diagnosing OAuth wrappers, sync loops missing
date_from, and silent 4xx errors your HTTP client never surfaces. Open it from your app row in your developer dashboard.
The Simkl team is on Discord and reads everything posted there. The changelog tracks every new endpoint, breaking change, and improvement.
Simkl API Documentation on Apiary
by Simkl