social.popfeed.feed.listItem

bookhive.buzz

Documentation

main record

No description available.

Record Key tid Timestamp-based ID

Properties

addedAt string datetime Required

Timestamp when the creative work was added to the list.

backdrop blob Optional

No description available.

maxSize: 4.0 MB
backdropUrl string uri Optional

Backdrop image URL for the creative work. Soon to be deprecated in favor of the 'backdrop' blob field

bookProgress ref #bookProgress Optional

Reading progress for books or book series (also supports audiobooks via time fields).

completedAt string datetime Optional

Timestamp when the user finished the creative work. Most relevant for books, TV shows, and video games.

creativeWorkType string Required

The type of creative work this item represents.

Allowed: movie, tv_show, video_game, album, book, book_series, episode, album, ep, tv_season, tv_episode, track
description string Optional

Optional description or commentary for the list item.

maxLength: 5000 bytes
genres array of string Optional

No description available.

identifiers ref #identifiers Required

External identifiers for the creative work.

listType string Optional

The type of list, e.g., 'watchlist', 'favorites', 'to-read', etc.

maxLength: 50 bytes
listUri string uri Required

URI of the list where the item is stored.

mainCredit string Optional

Main actor, director, author, or artist of the creative work.

maxLength: 1000 bytes
mainCreditRole string Optional

The role of the main credit.

Allowed: director, author, artist, showrunner, lead_actor, creator, studio, publisher, developer, performer, network
position integer Optional

DEPRECATED

poster blob Optional

No description available.

maxSize: 2.0 MB
posterUrl string uri Optional

Poster or cover image URL for the creative work. Soon to be deprecated in favor of the 'poster' blob field

releaseDate string datetime Optional

Release date of the creative work.

startedAt string datetime Optional

Timestamp when the user started the creative work. Most relevant for books, TV shows, and video games.

status string Optional

No description available.

Known values: #finished, #in_progress, #backlog, #abandoned
title string Optional

Title of the creative work.

maxLength: 1000 bytes
watchedEpisodes array of ref #watchedEpisode Optional

For TV shows, the episodes the user has watched.

View raw schema 
{
  "key": "tid",
  "record": {
    "properties": {
      "addedAt": {
        "description": "Timestamp when the creative work was added to the list.",
        "format": "datetime",
        "type": "string"
      },
      "backdrop": {
        "accept": [
          "image/*"
        ],
        "maxSize": 4000000,
        "type": "blob"
      },
      "backdropUrl": {
        "description": "Backdrop image URL for the creative work. Soon to be deprecated in favor of the 'backdrop' blob field",
        "format": "uri",
        "type": "string"
      },
      "bookProgress": {
        "description": "Reading progress for books or book series (also supports audiobooks via time fields).",
        "ref": "#bookProgress",
        "type": "ref"
      },
      "completedAt": {
        "description": "Timestamp when the user finished the creative work. Most relevant for books, TV shows, and video games.",
        "format": "datetime",
        "type": "string"
      },
      "creativeWorkType": {
        "description": "The type of creative work this item represents.",
        "enum": [
          "movie",
          "tv_show",
          "video_game",
          "album",
          "book",
          "book_series",
          "episode",
          "album",
          "ep",
          "tv_season",
          "tv_episode",
          "track"
        ],
        "type": "string"
      },
      "description": {
        "description": "Optional description or commentary for the list item.",
        "maxLength": 5000,
        "type": "string"
      },
      "genres": {
        "items": {
          "maxLength": 50,
          "type": "string"
        },
        "type": "array"
      },
      "identifiers": {
        "description": "External identifiers for the creative work.",
        "ref": "#identifiers",
        "type": "ref"
      },
      "listType": {
        "description": "The type of list, e.g., 'watchlist', 'favorites', 'to-read', etc.",
        "maxLength": 50,
        "type": "string"
      },
      "listUri": {
        "description": "URI of the list where the item is stored.",
        "format": "uri",
        "type": "string"
      },
      "mainCredit": {
        "description": "Main actor, director, author, or artist of the creative work.",
        "maxLength": 1000,
        "type": "string"
      },
      "mainCreditRole": {
        "description": "The role of the main credit.",
        "enum": [
          "director",
          "author",
          "artist",
          "showrunner",
          "lead_actor",
          "creator",
          "studio",
          "publisher",
          "developer",
          "performer",
          "network"
        ],
        "type": "string"
      },
      "position": {
        "description": "DEPRECATED",
        "type": "integer"
      },
      "poster": {
        "accept": [
          "image/*"
        ],
        "maxSize": 2000000,
        "type": "blob"
      },
      "posterUrl": {
        "description": "Poster or cover image URL for the creative work. Soon to be deprecated in favor of the 'poster' blob field",
        "format": "uri",
        "type": "string"
      },
      "releaseDate": {
        "description": "Release date of the creative work.",
        "format": "datetime",
        "type": "string"
      },
      "startedAt": {
        "description": "Timestamp when the user started the creative work. Most relevant for books, TV shows, and video games.",
        "format": "datetime",
        "type": "string"
      },
      "status": {
        "knownValues": [
          "#finished",
          "#in_progress",
          "#backlog",
          "#abandoned"
        ],
        "type": "string"
      },
      "title": {
        "description": "Title of the creative work.",
        "maxLength": 1000,
        "type": "string"
      },
      "watchedEpisodes": {
        "description": "For TV shows, the episodes the user has watched.",
        "items": {
          "ref": "#watchedEpisode",
          "type": "ref"
        },
        "type": "array"
      }
    },
    "required": [
      "identifiers",
      "creativeWorkType",
      "addedAt",
      "listUri"
    ],
    "type": "object"
  },
  "type": "record"
}
bookProgress object

Tracks reading/listening progress for a book or book series item.

Properties

currentChapter integer Optional

Current chapter number (optional alternative to pages).

currentPage integer Optional

Current page number (if applicable).

percent integer Optional

Optional explicit progress percentage (0–100).

status string Required

Overall progress state.

totalChapters integer Optional

Total chapters (if known).

totalPages integer Optional

Total pages (if known).

updatedAt string datetime Required

Last time progress was updated.

View raw schema 
{
  "description": "Tracks reading/listening progress for a book or book series item.",
  "properties": {
    "currentChapter": {
      "description": "Current chapter number (optional alternative to pages).",
      "type": "integer"
    },
    "currentPage": {
      "description": "Current page number (if applicable).",
      "type": "integer"
    },
    "percent": {
      "description": "Optional explicit progress percentage (0–100).",
      "type": "integer"
    },
    "status": {
      "description": "Overall progress state.",
      "enum": [
        "in_progress",
        "completed",
        "paused"
      ],
      "type": "string"
    },
    "totalChapters": {
      "description": "Total chapters (if known).",
      "type": "integer"
    },
    "totalPages": {
      "description": "Total pages (if known).",
      "type": "integer"
    },
    "updatedAt": {
      "description": "Last time progress was updated.",
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "status",
    "updatedAt"
  ],
  "type": "object"
}
identifiers object

No description available.

Properties

asin string Optional

Amazon Standard ID

episodeNumber integer Optional

Episode number for TV shows or series

hiveId string Optional

BookHive ID for fast local lookup

igdbId string Optional

IGDB ID for games

imdbId string Optional

IMDb ID

isbn10 string Optional

ISBN-10 for books

isbn13 string Optional

ISBN-13 for books

mbId string Optional

DEPRECATED - soon to be ignored

mbReleaseId string Optional

MusicBrainz ID for specific releases (albums, EPs, tracks)

other string Optional

Other external ID

parentMbReleaseId string Optional

MusicBrainz ID for parent release (e.g., album for a track)

seasonNumber integer Optional

Season number for TV shows or series

tmdbId string Optional

TMDb ID for movies/TV shows

tmdbTvSeriesId string Optional

TMDb ID for TV series

View raw schema 
{
  "properties": {
    "asin": {
      "description": "Amazon Standard ID",
      "type": "string"
    },
    "episodeNumber": {
      "description": "Episode number for TV shows or series",
      "type": "integer"
    },
    "hiveId": {
      "description": "BookHive ID for fast local lookup",
      "type": "string"
    },
    "igdbId": {
      "description": "IGDB ID for games",
      "type": "string"
    },
    "imdbId": {
      "description": "IMDb ID",
      "type": "string"
    },
    "isbn10": {
      "description": "ISBN-10 for books",
      "type": "string"
    },
    "isbn13": {
      "description": "ISBN-13 for books",
      "type": "string"
    },
    "mbId": {
      "description": "DEPRECATED - soon to be ignored",
      "type": "string"
    },
    "mbReleaseId": {
      "description": "MusicBrainz ID for specific releases (albums, EPs, tracks)",
      "type": "string"
    },
    "other": {
      "description": "Other external ID",
      "type": "string"
    },
    "parentMbReleaseId": {
      "description": "MusicBrainz ID for parent release (e.g., album for a track)",
      "type": "string"
    },
    "seasonNumber": {
      "description": "Season number for TV shows or series",
      "type": "integer"
    },
    "tmdbId": {
      "description": "TMDb ID for movies/TV shows",
      "type": "string"
    },
    "tmdbTvSeriesId": {
      "description": "TMDb ID for TV series",
      "type": "string"
    }
  },
  "type": "object"
}
watchedEpisode object

No description available.

Properties

episodeNumber integer Required

No description available.

seasonNumber integer Required

No description available.

tmdbId string Optional

No description available.

View raw schema 
{
  "properties": {
    "episodeNumber": {
      "type": "integer"
    },
    "seasonNumber": {
      "type": "integer"
    },
    "tmdbId": {
      "type": "string"
    }
  },
  "required": [
    "seasonNumber",
    "episodeNumber"
  ],
  "type": "object"
}

Lexicon Garden

@