Personal scripts
Create a key in the app and call the API from your own machine: dashboards, Home Assistant, exports.
Your key starts with rfk_. Create a key
Every show, film and anime a member tracks, one call away.
Read a member's library, watch history, ratings, watchlist and lists. Build a companion app, a home dashboard, or a script that keeps your media server in step.
Pick your path
Section titled “Pick your path”Sign in with Refract
Let any member connect your app. OAuth 2.1 with PKCE, refresh tokens, and scopes the member approves. Register an app
TVs and terminals
No keyboard? Show a short code; the member approves it on getrefract.app/device from their phone. Read the guide
What you can read
Section titled “What you can read”| Data | Endpoint | Scope |
|---|---|---|
| The member | GET /v1/me |
profile:read |
| Library, with progress and rewatches | GET /v1/library |
library:read |
| Watchlist | GET /v1/watchlist |
library:read |
| Watched episodes | GET /v1/history/episodes |
history:read |
| Movie plays | GET /v1/history/movies |
history:read |
| Ratings | GET /v1/ratings |
ratings:read |
| Lists and their titles | GET /v1/lists |
lists:read |
Up next, the calendar, stats, a feed of changes for sync, and writes arrive in later releases. Follow the changelog.
Made for code and for agents
Section titled “Made for code and for agents”Ids you already useEvery title carries its TMDB id, and IMDb and TheTVDB when we have them.
Errors you can parseRFC 9457 problem details with a stable code and a page that explains the fix.
Limits in the headersRateLimit and Retry-After on every answer; revalidate with an ETag to skip unchanged downloads.
OpenAPI and llms.txtAn OpenAPI 3.1 document, llms.txt, and every page as Markdown.