Skip to main content

BookMetadataDto

Book metadata DTO

authors object[]

Structured author information as JSON array

  • Array [
  • namestringrequired

    Author's name

    Example: Andy Weir
    roleBookAuthorRole (string)required

    Role of this author

    Possible values: [author, co_author, editor, translator, illustrator, contributor, writer, penciller, inker, colorist, letterer, cover_artist]

    sortNamestring | nullnullable

    Sort name for ordering (e.g., "Weir, Andy")

    Example: Weir, Andy
  • ]
  • awards object[]

    Awards information

  • Array [
  • categorystring | nullnullable

    Award category

    Example: Best Novel
    namestringrequired

    Name of the award

    Example: Hugo Award
    wonbooleanrequired

    Whether the book won (true) or was just nominated (false)

    Example: true
    yearinteger,null<int32>nullable

    Year the award was given/nominated

    Example: 2015
  • ]
  • blackAndWhiteboolean | nullnullable

    Whether the book is black and white

    Example: false
    bookIdstring<uuid>required

    Associated book ID

    Example: 550e8400-e29b-41d4-a716-446655440001
    bookType object
    oneOf
    null
    coloristsstring[]required

    Colorists

    Example: ["Richmond Lewis"]
    countinteger,null<int32>nullable

    Total count in series

    Example: 4
    coverArtistsstring[]required

    Cover artists

    Example: ["David Mazzucchelli"]
    customMetadataobject | nullnullable

    Custom metadata JSON escape hatch

    dayinteger,null<int32>nullable

    Publication day (1-31)

    Example: 1
    editionstring | nullnullable

    Edition information (e.g., "First Edition", "Revised Edition")

    Example: First Edition
    editorsstring[]required

    Editors

    Example: ["Dennis O'Neil"]
    formatDetailstring | nullnullable

    Format details

    Example: Trade Paperback
    genrestring | nullnullable

    Genre

    Example: Superhero
    idstring<uuid>required

    Metadata record ID

    Example: 550e8400-e29b-41d4-a716-446655440003
    imprintstring | nullnullable

    Imprint name

    Example: DC Black Label
    inkersstring[]required

    Inkers

    Example: ["David Mazzucchelli"]
    isbnsstring | nullnullable

    ISBN(s)

    Example: 978-1401207526
    languageIsostring | nullnullable

    ISO language code

    Example: en
    letterersstring[]required

    Letterers

    Example: ["Todd Klein"]
    mangaboolean | nullnullable

    Whether the book is manga format

    Example: false
    monthinteger,null<int32>nullable

    Publication month (1-12)

    Example: 2
    numberstring | nullnullable

    Issue/chapter number from metadata

    Example: 1
    originalTitlestring | nullnullable

    Original title (for translated works)

    Example: 火星の人
    originalYearinteger,null<int32>nullable

    Original publication year (for re-releases or translations)

    Example: 2011
    pageCountinteger,null<int32>nullable

    Page count from metadata

    Example: 32
    pencillersstring[]required

    Pencillers (line artists)

    Example: ["David Mazzucchelli"]
    publisherstring | nullnullable

    Publisher name

    Example: DC Comics
    releaseDatestring,null<date-time>nullable

    Release/publication date

    Example: 1987-02-01T00:00:00Z
    seriesstring | nullnullable

    Series name from metadata

    Example: Batman: Year One
    seriesPositionnumber,null<double>nullable

    Position in a series (e.g., 1.0, 2.5 for .5 volumes)

    Example: 1
    seriesTotalinteger,null<int32>nullable

    Total number of books in the series

    Example: 3
    subjectsstring[]nullable

    Subject/topic tags

    Example: ["Science Fiction","Space Exploration","Survival"]
    subtitlestring | nullnullable

    Book subtitle

    Example: A Novel
    summarystring | nullnullable

    Book summary/description

    Example: Bruce Wayne returns to Gotham City after years abroad to begin his war on crime.
    titlestring | nullnullable

    Book title from metadata

    Example: Batman: Year One #1
    translatorstring | nullnullable

    Translator name

    Example: John Smith
    volumeinteger,null<int32>nullable

    Volume number

    Example: 1
    writersstring[]required

    Writers/authors

    Example: ["Frank Miller"]
    yearinteger,null<int32>nullable

    Publication year

    Example: 1987
    BookMetadataDto
    {
    "authors": [
    {
    "name": "Andy Weir",
    "role": "author",
    "sortName": "Weir, Andy"
    }
    ],
    "awards": [
    {
    "category": "Best Novel",
    "name": "Hugo Award",
    "won": true,
    "year": 2015
    }
    ],
    "blackAndWhite": false,
    "bookId": "550e8400-e29b-41d4-a716-446655440001",
    "bookType": "null",
    "colorists": [
    "Richmond Lewis"
    ],
    "count": 4,
    "coverArtists": [
    "David Mazzucchelli"
    ],
    "customMetadata": "Unknown Type: object,null",
    "day": 1,
    "edition": "First Edition",
    "editors": [
    "Dennis O'Neil"
    ],
    "formatDetail": "Trade Paperback",
    "genre": "Superhero",
    "id": "550e8400-e29b-41d4-a716-446655440003",
    "imprint": "DC Black Label",
    "inkers": [
    "David Mazzucchelli"
    ],
    "isbns": "978-1401207526",
    "languageIso": "en",
    "letterers": [
    "Todd Klein"
    ],
    "manga": false,
    "month": 2,
    "number": "1",
    "originalTitle": "火星の人",
    "originalYear": 2011,
    "pageCount": 32,
    "pencillers": [
    "David Mazzucchelli"
    ],
    "publisher": "DC Comics",
    "releaseDate": "1987-02-01T00:00:00Z",
    "series": "Batman: Year One",
    "seriesPosition": 1,
    "seriesTotal": 3,
    "subjects": [
    "Science Fiction",
    "Space Exploration",
    "Survival"
    ],
    "subtitle": "A Novel",
    "summary": "Bruce Wayne returns to Gotham City after years abroad to begin his war on crime.",
    "title": "Batman: Year One #1",
    "translator": "John Smith",
    "volume": 1,
    "writers": [
    "Frank Miller"
    ],
    "year": 1987
    }