Skip to main content

Opds2Feed

OPDS 2.0 Feed

The main container for OPDS 2.0 data. A feed contains metadata, links, and one of: navigation, publications, or groups.

groups object[]

Groups containing multiple collections

  • Array [
    • metadata objectrequired

    Group metadata (title required)

    currentPageinteger,null<int32>nullable

    Current page number (for pagination)

    itemsPerPageinteger,null<int32>nullable

    Items per page (for pagination)

    modifiedstring,null<date-time>nullable

    Last modification date

    numberOfItemsinteger,null<int64>nullable

    Total number of items in the collection (for pagination)

    subtitlestring | nullnullable

    Optional subtitle

    titlestringrequired

    Title of the feed

    navigation object[]

    Navigation links within this group

  • Array [
    • hrefstringrequired

    The URI or URI template for the link

    properties object
    oneOf
    null
    relstring | nullnullable

    Relation type (e.g., "self", "search", "http://opds-spec.org/acquisition")

    templatedboolean | nullnullable

    Whether the href is a URI template

    titlestring | nullnullable

    Human-readable title for the link

    typestring | nullnullable

    Media type of the linked resource

  • ]
    • publications object[]

    Publications within this group

  • Array [
    • images object[]

    Cover images for the publication

  • Array [
    • heightinteger,null<int32>nullable

    Height in pixels

    hrefstringrequired

    URL to the image

    typestringrequired

    Media type of the image

    widthinteger,null<int32>nullable

    Width in pixels

  • ]
    • links object[]required

    Links for the publication (acquisition, streaming, etc.)

  • Array [
    • hrefstringrequired

    The URI or URI template for the link

    properties object
    oneOf
    null
    relstring | nullnullable

    Relation type (e.g., "self", "search", "http://opds-spec.org/acquisition")

    templatedboolean | nullnullable

    Whether the href is a URI template

    titlestring | nullnullable

    Human-readable title for the link

    typestring | nullnullable

    Media type of the linked resource

  • ]
    • metadata objectrequired

    Publication metadata (title, author, etc.)

    @typestring | nullnullable

    Schema.org type (e.g., "http://schema.org/Book")

    artist object[]

    Artists/illustrators

  • Array [
    • namestringrequired

    Name of the contributor

    sortAsstring | nullnullable

    Sort-friendly version of the name

  • ]
    • author object[]

    Authors

  • Array [
    • namestringrequired

    Name of the contributor

    sortAsstring | nullnullable

    Sort-friendly version of the name

  • ]
    • belongsTo object
    oneOf
    null
    descriptionstring | nullnullable

    Description/summary

    identifierstring | nullnullable

    Unique identifier (e.g., "urn:uuid:...")

    languagestring | nullnullable

    Language code (e.g., "en", "ja")

    modifiedstring,null<date-time>nullable

    Last modification date

    numberOfPagesinteger,null<int32>nullable

    Number of pages

    publishedstring,null<date-time>nullable

    Publication date

    publisherstring | nullnullable

    Publisher name

    subtitlestring | nullnullable

    Subtitle

    titlestringrequired

    Title of the publication

    readingProgress object
    oneOf
    null
  • ]
  • ]
    • links object[]required

    Feed-level links (self, search, start, etc.)

  • Array [
    • hrefstringrequired

    The URI or URI template for the link

    properties object
    oneOf
    null
    relstring | nullnullable

    Relation type (e.g., "self", "search", "http://opds-spec.org/acquisition")

    templatedboolean | nullnullable

    Whether the href is a URI template

    titlestring | nullnullable

    Human-readable title for the link

    typestring | nullnullable

    Media type of the linked resource

  • ]
    • metadata objectrequired

    Feed metadata (title, pagination, etc.)

    currentPageinteger,null<int32>nullable

    Current page number (for pagination)

    itemsPerPageinteger,null<int32>nullable

    Items per page (for pagination)

    modifiedstring,null<date-time>nullable

    Last modification date

    numberOfItemsinteger,null<int64>nullable

    Total number of items in the collection (for pagination)

    subtitlestring | nullnullable

    Optional subtitle

    titlestringrequired

    Title of the feed

    navigation object[]

    Navigation links (for navigation feeds)

  • Array [
    • hrefstringrequired

    The URI or URI template for the link

    properties object
    oneOf
    null
    relstring | nullnullable

    Relation type (e.g., "self", "search", "http://opds-spec.org/acquisition")

    templatedboolean | nullnullable

    Whether the href is a URI template

    titlestring | nullnullable

    Human-readable title for the link

    typestring | nullnullable

    Media type of the linked resource

  • ]
    • publications object[]

    Publication entries (for acquisition feeds)

  • Array [
    • images object[]

    Cover images for the publication

  • Array [
    • heightinteger,null<int32>nullable

    Height in pixels

    hrefstringrequired

    URL to the image

    typestringrequired

    Media type of the image

    widthinteger,null<int32>nullable

    Width in pixels

  • ]
    • links object[]required

    Links for the publication (acquisition, streaming, etc.)

  • Array [
    • hrefstringrequired

    The URI or URI template for the link

    properties object
    oneOf
    null
    relstring | nullnullable

    Relation type (e.g., "self", "search", "http://opds-spec.org/acquisition")

    templatedboolean | nullnullable

    Whether the href is a URI template

    titlestring | nullnullable

    Human-readable title for the link

    typestring | nullnullable

    Media type of the linked resource

  • ]
    • metadata objectrequired

    Publication metadata (title, author, etc.)

    @typestring | nullnullable

    Schema.org type (e.g., "http://schema.org/Book")

    artist object[]

    Artists/illustrators

  • Array [
    • namestringrequired

    Name of the contributor

    sortAsstring | nullnullable

    Sort-friendly version of the name

  • ]
    • author object[]

    Authors

  • Array [
    • namestringrequired

    Name of the contributor

    sortAsstring | nullnullable

    Sort-friendly version of the name

  • ]
    • belongsTo object
    oneOf
    null
    descriptionstring | nullnullable

    Description/summary

    identifierstring | nullnullable

    Unique identifier (e.g., "urn:uuid:...")

    languagestring | nullnullable

    Language code (e.g., "en", "ja")

    modifiedstring,null<date-time>nullable

    Last modification date

    numberOfPagesinteger,null<int32>nullable

    Number of pages

    publishedstring,null<date-time>nullable

    Publication date

    publisherstring | nullnullable

    Publisher name

    subtitlestring | nullnullable

    Subtitle

    titlestringrequired

    Title of the publication

    readingProgress object
    oneOf
    null
  • ]
    • Opds2Feed
    {
      "groups": "Unknown Type: array,null",
      "links": [
        {
          "href": "string",
          "properties": "null",
          "rel": "string",
          "templated": true,
          "title": "string",
          "type": "string"
        }
      ],
      "metadata": {
        "currentPage": 0,
        "itemsPerPage": 0,
        "modified": "2024-07-29T15:51:28.071Z",
        "numberOfItems": 0,
        "subtitle": "string",
        "title": "string"
      },
      "navigation": "Unknown Type: array,null",
      "publications": "Unknown Type: array,null"
    }