/
KA
kareadita
/
Kavita
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 12m ago · Updated 2d ago
View markdown
Account
28
Activity
1
Admin
1
Annotation
12
Book
4
Cbl
14
Chapter
5
Collection
12
ColorScape
3
Device
10
Download
12
Email
1
Filter
12
Font
5
Health
1
Image
15
KavitaPlusAudit
5
Koreader
3
Library
23
License
13
Locale
1
Manage
1
Metadata
14
OAuth
2
Oidc
2
Opds
22
Panels
2
Person
10
Plugin
5
Rating
4
Reader
39
ReadingList
27
ReadingProfile
16
Review
5
Scrobbling
18
get
Returns all scrobble providers for a user. This list is guaranteed to contain an entry for each currently valid scrobble provider. If the user has none setup, returns the empty default values.
post
Updates the scrobble settings for a given provider. Libraries are filtered on supported types
post
Update authentication details for the given provider
post
Generate scrobble events from history. Should only be ran once per user.
post
Generate scrobble events from history for all valid providers.
get
Checks if the current Scrobbling token for the given Provider has expired for the current user
get
Returns all expired tokens for the current user
get
Returns all scrobbling errors for the instance
post
Clears the scrobbling errors table
post
Returns the scrobbling history for the user
get
Returns all scrobble holds for the current user
get
If there is an active hold on the series
get
Does the library the series is in allow scrobbling?
post
Adds a hold against the Series for user's scrobbling
delete
Remove a hold against the Series for user's scrobbling
post
Delete the given scrobble events if they belong to that user
post
Attempts to retry Scrobble Events for the current authenticated user (or admin-allowed).
get
Returns when Scrobbling upload will next execute
Search
4
Series
33
Server
18
Settings
20
Stats
34
Stream
17
Tachiyomi
2
Theme
7
Upload
10
Users
10
Volume
4
WantToRead
4
Scrobbling
Returns the scrobbling history for the user
User must have a valid license
post
/api/Scrobbling/scrobble-events
Query parameters
PageNumber
integer
PageSize
integer
Request body
ScrobbleEventFilter
required
field
0
|
1
|
2
|
3
|
4
|
5
|
6
Members:
0
— None
1
— Created
2
— LastModified
3
— Type
4
— Series
5
— IsProcessed
6
— ScrobbleEventFilter
isDescending
boolean
query
string
nullable
includeReviews
boolean
Response
OK
ScrobbleEventDto[]
required
id
integer
seriesName
string
nullable
seriesId
integer
libraryId
integer
isProcessed
boolean
volumeNumber
number
float
nullable
chapterNumber
integer
nullable
lastModifiedUtc
string
date-time
createdUtc
string
date-time
rating
number
float
nullable
readStatus
0
|
1
|
2
|
3
|
4
|
5
Members:
0
— Ignore
1
— Want to Read (WantToRead)
2
— Read
3
— Un read (UnRead)
4
— Dropped
5
— On hold (OnHold)
scrobbleEventType
0
|
1
|
2
|
3
|
4
|
5
Members:
0
— Chapter Read (ChapterRead)
1
— Add to Want to Read (AddWantToRead)
2
— Remove from Want to Read (RemoveWantToRead)
3
— Score Updated (ScoreUpdated)
4
— Review Added/Updated (Review)
5
— Read status Updated (ReadStatusUpdate)
scrobbleProvider
0
|
1
|
2
|
4
|
5
|
6
Members:
0
— Kavita
1
— AniList
2
— Mal
4
— Cbr
5
— Hardcover
6
— MangaBaka
isErrored
boolean
errorDetails
string
nullable