Object Schemas

The QB Reader API represents tossups and bonuses as JSON objects. These schemas describe the structure of these objects.

• _id: string
  The internal ID of the tossup.
• question: string
  The question text, formatted with HTML.
• question_sanitized: string
  The question text, unformatted.
• answer: string
  The answerline, formatted with HTML.
• answer_sanitized: string
  The answerline, unformatted.
• category: string
  The category of the question.
• subcategory: string
  The subcategory of the question.
• alternate_subcategory: string optional
  The alternate subcategory of the question. This only exists for the following category: Literature; and for the following subcategories: Other Science, Other Fine Arts, Social Science.
• packet: object
  A JavaScript object with the following properties of the packet the tossup is from:
  • _id: string
    The internal ID of the packet.
  • name: string
    The name of the packet.
  • number: number
    The packet number of the packet. Always a nonnegative integer.
• set: object
  A JavaScript object with the following properties of the set the tossup is from:
  • _id: string
    The internal ID of the set.
  • name: string
    The name of the set.
  • year: number
    The year associated with the set. This always corresponds to the first four characters of the set name.
  • standard: boolean
    Whether or not the set has a "standard" format. This generally means anything that's designed for use at an academic quizbowl tournament, even if it does not have a full distribution. See the packet list for a complete list of what sets are considered standard.
• number: number
  The question number of the tossup in the packet. Always a nonnegative integer.
• createdAt: string
  The date the question was created in the database. ISO 8601 format.
• updatedAt: string
  The date the question was last modified in the database. ISO 8601 format.
• difficulty: number
  The difficulty of the question. Always an integer in [0-10].

• _id: string
  The internal ID of the bonus.
• leadin: string
  The leadin of the bonus, formatted with HTML.
• leadin_sanitized: string
  The leadin of the bonus, unformatted.
• parts: string[]
  The parts of the bonus, formatted with HTML.
• parts_sanitized: string[]
  The parts of the bonus, unformatted. This always has length equal to parts.
• answers: string[]
  The answerlines, formatted with HTML. This should have the same length as parts, but a few bonuses have errors where this is not the case.
• answers_sanitized: string[]
  The answerlines, unformatted. This always has length equal to answers.
• category: string
  The category of the question.
• subcategory: string
  The subcategory of the question.
• alternate_subcategory: string optional
  The alternate subcategory of the question. This only exists for the following category: Literature; and for the following subcategories: Other Science, Other Fine Arts, Social Science.
• packet: object
  A JavaScript object with the following properties of the packet the bonus is from:
  • _id: string
    The internal ID of the packet.
  • name: string
    The name of the packet.
  • number: number
    The packet number of the packet. Always a nonnegative integer.
• set: object
  A JavaScript object with the following properties of the set the bonus is from:
  • _id: string
    The internal ID of the set.
  • name: string
    The name of the set.
  • year: number
    The year associated with the set. This always corresponds to the first four characters of the set name.
  • standard: boolean
    Whether or not the set has a "standard" format. This generally means anything that's designed for use at an academic quizbowl tournament, even if it does not have a full distribution. See the packet list for a complete list of what sets are considered standard.
• number: number
  The question number of the bonus in the packet. Always a nonnegative integer.
• createdAt: string
  The date the question was created in the database. ISO 8601 format.
• updatedAt: string
  The date the question was last modified in the database. ISO 8601 format.
• difficulty: number
  The difficulty of the question. Always an integer in [0-10].