Read a series from a source

GET

/api/v1/me/extensions/{extensionId}/series

curl --request GET \
  --url 'http://localhost:8080/api/v1/me/extensions/example/series?seriesId=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

• session
• basic

Parameters

Path Parameters

extensionId

required

string

The extension’s reverse-DNS id.

Query Parameters

seriesId

required

string

The source’s own series id.

Responses

200

The series.

Media typeapplication/json

object

id

required

string

title

required

string

summary

required

string | null

coverUrl

required

One of:

string

A path on this server, relative to its base URL, that serves the image.

string

null

null

contributors

required

Array<object>

object

name

required

string

role

required

string

readingDirection

required

string | null

Allowed values: ltr rtl ttb

status

required

Whether the series is still going, as the source says.

string | null

Allowed values: ongoing completed hiatus cancelled

year

required

The year the series started, when the source knows.

integer | null

tags

required

Genres and themes as the source names them, most important first.

Array<string>

contentRating

required

One of:

string

How explicit a series is, mildest first, on the scale MangaDex uses. suggestive is fan service and mild sexual themes, erotica nudity or sexual content short of explicit, and pornographic explicit.

string

Allowed values: safe suggestive erotica pornographic

null

null

Example

{
  "coverUrl": "/api/v1/me/extensions/org.example.comics/image?ref=eyJ1cmwiOi",
  "readingDirection": "ltr",
  "status": "ongoing",
  "contentRating": "safe"
}

401

The request has no valid session token.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

403

The signed-in user may not do this. demo_account when the user is a shared demo account, named in CHEK_DEMO_USERS, which can’t change its password, sessions, sign-in providers, extensions or annotations.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

404

The resource does not exist.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

500

The server failed; details are in its log.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

502

The extension reported an error, went over a limit, or the image couldn’t be fetched.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}