Skip to main content

SeriesDetail

alternateTitlesstring[]required
canonicalTitlestringrequired
codex object
oneOf
null
coverUrlstring | nullnullable
descriptionstring | nullnullable
externalIds object[]required
  • Array [
    • externalIdstringrequired
    fetchedAtinteger<int64>required
    providerstringrequired
  • ]
    • firstSeenAtinteger<int64>required
    genresstring[]required
    highestChapternumber,null<double>nullable
    highestVolumenumber,null<double>nullable
    idinteger<int32>required
    kindstring | nullnullable
    lastReleaseAtinteger<int64>required
    metadataFetchedAtinteger<int64>required
    metadataSourcestringrequired
    ownedbooleanrequired

    Whether the operator owns this series on Codex. Derived from the presence of [Self::codex]; only ever true for admins.

    publishedEndDatestring | nullnullable
    publishedStartDatestring | nullnullable

    Official publication start/end dates from provider metadata, ISO YYYY-MM-DD (nullable). See [SeriesListItem::published_start_date].

    ratingnumber,null<double>nullable

    Provider rating on a 0-10 scale (normalized in the provider's mapping layer). None when the provider has no rating.

    statusstring | nullnullable
    tagsstring[]required
    totalChaptersinteger,null<int32>nullable

    Published total chapter count from provider metadata. See [Self::total_volumes] for how this differs from highest_chapter.

    totalVolumesinteger,null<int32>nullable

    Published total volume count from provider metadata. Distinct from [Self::highest_volume], which tracks the highest span observed across releases. None if the provider has no value for this row.

    wishlistedbooleanrequired

    Whether the series is on the operator's wishlist. Admin-only (always false for non-admin requests), like [Self::owned].

    wishlistedAtinteger,null<int64>nullable

    Epoch seconds the series was clipped to the wishlist, or null when not wishlisted / not admin.

    yearinteger,null<int32>nullable
    SeriesDetail
    {
      "alternateTitles": [
        "string"
      ],
      "canonicalTitle": "string",
      "codex": "null",
      "coverUrl": "string",
      "description": "string",
      "externalIds": [
        {
          "externalId": "string",
          "fetchedAt": 0,
          "provider": "string"
        }
      ],
      "firstSeenAt": 0,
      "genres": [
        "string"
      ],
      "highestChapter": 0,
      "highestVolume": 0,
      "id": 0,
      "kind": "string",
      "lastReleaseAt": 0,
      "metadataFetchedAt": 0,
      "metadataSource": "string",
      "owned": true,
      "publishedEndDate": "string",
      "publishedStartDate": "string",
      "rating": 0,
      "status": "string",
      "tags": [
        "string"
      ],
      "totalChapters": 0,
      "totalVolumes": 0,
      "wishlisted": true,
      "wishlistedAt": 0,
      "year": 0
    }