GET qbreader.org/api/query

Query the QB Reader database for questions.

• questionType: "tossup" | "bonus" | "all" required
  The type of question to search for.

  • "tossup" - only tossups
  • "bonus" - only bonuses
  • "all" - both tossups and bonuses
• searchType: "question" | "answer" | "all" required
  Where to search for the query string.

  • "question" - only search question bodies
  • "answer" - only search answerlines
  • "all" - search both question bodies and answerlines
• queryString: string default: ""
  The string to search for.
• ignoreDiacritics: boolean default: false
  Ignore or transliterate diacritical marks in queryString.
• regex: boolean default: false
  Treat queryString as a regular expression.
• randomize: boolean default: false
  Randomize result order.
• setName: string default: undefined
  The name of the set to search in.

  • If undefined then all sets are searched.
• difficulties: number | string default: undefined
  The difficulties to search for.

  • To pass multiple difficulties, separate values by a comma.
  • If undefined then all difficulties are allowed.
  • Can also be a string or number if there is only 1 difficulty.
• categories: string default: undefined
  The categories to search for.

  • To pass multiple categories, separate values by a comma.
  • If undefined then all categories are allowed.
  • Can also be a string if there is only 1 category.
  • Take special care to ensure that the first letter of each word of the category is capitalized.
• subcategories: string default: undefined
  The subcategories to search for.

  • To pass multiple subcategories, separate values by a comma.
  • If undefined then all subcategories are allowed.
  • Can also be a string if there is only 1 subcategory.
  • Take special care to ensure that the first letter of each word of the subcategory is capitalized.
  • This API endpoint does not check for consistency between categories and subcategories.
  • For example, requesting the "History" and the "Biology" and "Chemistry" subcategories will return no questions.
• maxReturnLength: number default: 25
  The maximum number of questions to return.

  • If 0 or negative, then the default is 50
  • If greater than 200, the query will return no more than 200 questions.
• tossupPagination: number default: 1
  The page of tossups to return.

  • Limited to a max of 4000 / maxReturnLength, rounded down.
• bonusPagination: number default: 1
  The page of bonuses to return.

  • Limited to a max of 4000 / maxReturnLength, rounded down.

• tossups: object

  • count: number
    The number of tossups that match the query.
  • questionArray: Tossup[]
    An array of Tossups that match the query.
• bonuses: object

  • count: number
    The number of bonuses that match the query.
  • questionArray: Bonus[]
    An array of Bonuses that match the query.
• queryString: string
  The exact string used to search the MongoDB database. This may differ from the queryString passed in as a parameter:

  • If regex is false, then regex characters are escaped.
  • If ignoreDiacritics is true, then diacritic substitutions are made.