lib/app.moviebase.trakt.api/TraktUsersApi

TraktUsersApi

class TraktUsersApi(client: HttpClient)

Constructors

TraktUsersApi

constructor(client: HttpClient)

Functions

addFavorites

suspend fun addFavorites(items: TraktSyncItems): TraktSyncResponse

Add items to a user's favorites.

addHiddenItems

suspend fun addHiddenItems(section: TraktHiddenSection, items: TraktSyncItems): TraktSyncResponse

addListItems

suspend fun addListItems(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, items: TraktSyncItems): TraktSyncResponse

approveFollowRequest

suspend fun approveFollowRequest(requestId: Int): TraktFollowResponse

createList

suspend fun createList(userSlug: TraktUserSlug = TraktUserSlug.ME, list: TraktList): TraktList

deleteList

suspend fun deleteList(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String): HttpResponse

denyFollowRequest

suspend fun denyFollowRequest(requestId: Int): HttpResponse

suspend fun follow(userSlug: TraktUserSlug): TraktFollowResponse

getCollectionMovies

suspend fun getCollectionMovies(userSlug: TraktUserSlug, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktCollectionItem>

getCollectionMoviesPage

suspend fun getCollectionMoviesPage(userSlug: TraktUserSlug, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktCollectionItem>

getCollectionShows

suspend fun getCollectionShows(userSlug: TraktUserSlug, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktCollectionItem>

getCollectionShowsPage

suspend fun getCollectionShowsPage(userSlug: TraktUserSlug, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktCollectionItem>

getFavoriteMovies

suspend fun getFavoriteMovies(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktFavoriteItem>

Get a user's favorite movies.

getFavoriteMoviesPage

suspend fun getFavoriteMoviesPage(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktFavoriteItem>

getFavoriteShows

suspend fun getFavoriteShows(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktFavoriteItem>

Get a user's favorite shows.

getFavoriteShowsPage

suspend fun getFavoriteShowsPage(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktFavoriteItem>

getFollowerRequests

suspend fun getFollowerRequests(extended: TraktExtended? = null): List<TraktFollowRequest>

getFollowers

suspend fun getFollowers(userSlug: TraktUserSlug, extended: TraktExtended? = null): List<TraktUser>

getFollowing

suspend fun getFollowing(userSlug: TraktUserSlug, extended: TraktExtended? = null): List<TraktUser>

getFriends

suspend fun getFriends(userSlug: TraktUserSlug, extended: TraktExtended? = null): List<TraktUser>

getHiddenItems

suspend fun getHiddenItems(section: TraktHiddenSection, type: TraktMediaType? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktHiddenItem>

getHiddenItemsPage

suspend fun getHiddenItemsPage(section: TraktHiddenSection, type: TraktMediaType? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktHiddenItem>

getHistory

suspend fun getHistory(userSlug: TraktUserSlug = TraktUserSlug.ME, listType: TraktListMediaType? = null, itemId: Int? = null, extended: TraktExtended? = null, startAt: Instant? = null, endAt: Instant? = null, page: Int? = null, limit: Int? = null): List<TraktHistoryItem>

Example: users/id/history/type/item_id?start_at=2016-06-01T00%3A00%3A00.000Z&end_at=2016-07-01T23%3A59%3A59.000Z

getHistoryPage

suspend fun getHistoryPage(userSlug: TraktUserSlug = TraktUserSlug.ME, listType: TraktListMediaType? = null, itemId: Int? = null, extended: TraktExtended? = null, startAt: Instant? = null, endAt: Instant? = null, page: Int? = null, limit: Int? = null): TraktPage<TraktHistoryItem>

getLikes

suspend fun getLikes(type: String? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS): List<TraktLike>

getLikesPage

suspend fun getLikesPage(type: String? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS): TraktPage<TraktLike>

getListItems

suspend fun getListItems(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktUserListItem>

getListItemsPage

suspend fun getListItemsPage(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktUserListItem>

getLists

suspend fun getLists(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int? = null, limit: Int? = null): List<TraktList>

Paginated: without page/limit Trakt returns only the FIRST 100 lists, so a caller that needs every list must page — prefer getListsPage.

getListsPage

suspend fun getListsPage(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int? = null, limit: Int? = null): TraktPage<TraktList>

getProfile

suspend fun getProfile(userSlug: TraktUserSlug, extended: TraktExtended? = null): TraktUser

getRatingsEpisodes

suspend fun getRatingsEpisodes(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktRatedItem>

Get a user's ratings for episodes.

getRatingsEpisodesPage

suspend fun getRatingsEpisodesPage(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktRatedItem>

getRatingsMovies

suspend fun getRatingsMovies(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktRatedItem>

Get a user's ratings for movies.

getRatingsMoviesPage

suspend fun getRatingsMoviesPage(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktRatedItem>

getRatingsSeasons

suspend fun getRatingsSeasons(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktRatedItem>

Get a user's ratings for seasons.

getRatingsSeasonsPage

suspend fun getRatingsSeasonsPage(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktRatedItem>

getRatingsShows

suspend fun getRatingsShows(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktRatedItem>

Get a user's ratings for shows.

getRatingsShowsPage

suspend fun getRatingsShowsPage(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktRatedItem>

getSettings

suspend fun getSettings(): TraktUserSettings

getStats

suspend fun getStats(userSlug: TraktUserSlug = TraktUserSlug.ME): TraktUserStats

getUserNotes

suspend fun getUserNotes(userSlug: TraktUserSlug, type: String? = null, page: Int? = null, limit: Int? = null): List<TraktNoteItem>

getUserNotesPage

suspend fun getUserNotesPage(userSlug: TraktUserSlug, type: String? = null, page: Int? = null, limit: Int? = null): TraktPage<TraktNoteItem>

getWatchedMovies

suspend fun getWatchedMovies(userSlug: TraktUserSlug, extended: TraktExtended? = null, page: Int? = null, limit: Int? = null): List<TraktWatchedItem>

Paginated since 2026-07-03. Without page/limit Trakt returns only the FIRST 100 items, so a caller that needs the user's whole watched set must page — prefer getWatchedMoviesPage. Max limit is TraktWebConfig.MAX_LIMIT_WATCHED; larger values are silently clamped.

getWatchedMoviesPage

suspend fun getWatchedMoviesPage(userSlug: TraktUserSlug, extended: TraktExtended? = null, page: Int? = null, limit: Int? = null): TraktPage<TraktWatchedItem>

getWatchedShows

suspend fun getWatchedShows(userSlug: TraktUserSlug, extended: TraktExtended? = null, page: Int? = null, limit: Int? = null): List<TraktWatchedItem>

Paginated since 2026-07-03. Without page/limit Trakt returns only the FIRST 100 items, so a caller that needs the user's whole watched set must page — prefer getWatchedShowsPage. Max limit is TraktWebConfig.MAX_LIMIT_WATCHED; larger values are silently clamped.

getWatchedShowsPage

suspend fun getWatchedShowsPage(userSlug: TraktUserSlug, extended: TraktExtended? = null, page: Int? = null, limit: Int? = null): TraktPage<TraktWatchedItem>

getWatching

suspend fun getWatching(userSlug: TraktUserSlug = TraktUserSlug.ME, extended: TraktExtended? = null): TraktWatching?

getWatchlistEpisodes

suspend fun getWatchlistEpisodes(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktWatchlistItem>

Get a user's watchlist episodes.

getWatchlistEpisodesPage

suspend fun getWatchlistEpisodesPage(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktWatchlistItem>

getWatchlistMovies

suspend fun getWatchlistMovies(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktWatchlistItem>

Get a user's watchlist movies.

getWatchlistMoviesPage

suspend fun getWatchlistMoviesPage(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktWatchlistItem>

getWatchlistSeasons

suspend fun getWatchlistSeasons(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktWatchlistItem>

Get a user's watchlist seasons.

getWatchlistSeasonsPage

suspend fun getWatchlistSeasonsPage(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktWatchlistItem>

getWatchlistShows

suspend fun getWatchlistShows(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktWatchlistItem>

Get a user's watchlist shows.

getWatchlistShowsPage

suspend fun getWatchlistShowsPage(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktWatchlistItem>

removeFavorites

suspend fun removeFavorites(items: TraktSyncItems): TraktSyncResponse

Remove items from a user's favorites.

removeHiddenItems

suspend fun removeHiddenItems(section: TraktHiddenSection, items: TraktSyncItems): TraktSyncResponse

removeListItems

suspend fun removeListItems(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, items: TraktSyncItems): TraktSyncResponse

reorderListItems

suspend fun reorderListItems(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, rank: List<Long>): TraktReorderResponse

reorderLists

suspend fun reorderLists(userSlug: TraktUserSlug = TraktUserSlug.ME, rank: List<Long>): TraktReorderResponse

unfollow

suspend fun unfollow(userSlug: TraktUserSlug): HttpResponse

updateList

suspend fun updateList(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, list: TraktList): TraktList