GET qbreader.org/api/query

Query the QB Reader database for questions.

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

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

  • "question" - only search question bodies
  • "answer" - only search answerlines
  • "all" - search both question bodies and answerlines
• caseSensitive: boolean default: false
  Whether or not the search is case-sensitive.
• exactPhrase: boolean default: false
  Ensure that queryString is not part of another word. Using string interpolation, this is equivalent to the regular expression /\b${queryString}\b/.
• ignoreWordOrder: boolean default: false
  Treat queryString as a set of keywords that can appear in any order. See issue #236.
• 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 | 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 | string[] default: undefined
  The categories to search for.

  • To pass multiple categories, separate values by a comma.
  • If undefined then all categories are allowed / match this field.
  • Can also be a string if there is only 1 category.
  • Take special care to ensure that the first letter of each word of each category is capitalized.
• subcategories: string | string[] default: undefined
  The subcategories to search for. All of the bullet points above apply here, plus:

  • This endpoint returns all questions that match both the categories AND subcategories field.
  • This API endpoint does not check for consistency between categories and subcategories.
  • For example, requesting the "History" category and the "Biology" and "Chemistry" subcategories will return no questions.
• alternateSubcategories: string | string[] default: undefined
  The alternate subcategories to search for. All of the bullet points above apply here, plus:

  • This endpoint returns all questions that match the categories AND subcategories AND alternateSubcategories fields.
  • This endpoint does not check for consistency between categories and subcategories and alternate subcategories.
  • Categories or subcategories that do not have corresponding alternate subcategories can never be excluded by specifying values for alternateSubcategories.
  • For example, requesting the "Science" category and the "Biology" and "Other Science" subcategories and the "Math" alternate subcategory will return questions in both Biology and Math, since Biology questions don't have alternate subcategories.
• minYear: number default:
  The oldest year to search for.
• maxYear: number default:
  The most recent year to search for.
• maxReturnLength: number default: 25
  The maximum number of questions to return. The most this can be is 10000.
• tossupPagination: number default: 1
  The page of tossups to return.

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

  • Limited to a max of 10000 / 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.