The API documentation for QB Reader.

For Python developers, a Python API wrapper providing both synchronous and asynchronous interfaces is available on our GitHub, as well as PyPI under the name qbreader. Documentation for the library can be found on Read the Docs.

Base URL: https://www.qbreader.org/api

The base URL for the multiplayer API is qbreader.org/api/multiplayer (Note: There is only one multiplayer API endpoint.)

New rooms are created on the server when a WebSocket connection is established.

GET requests should always have parameters passed through the URI, and POST requests should have parameters passed through the body.

The API is rate-limited to 20 requests per second.

Endpoints

Database

• GET /query
  Query the database.
• GET /random-bonus
  Get random bonuses from the database.
• GET /random-tossup
  Get random tossups from the database.
• GET /packet
  Get a specific packet from a set.
• GET /packet-tossups
  Get only tossups from a packet.
• GET /packet-bonuses
  Get only bonuses from a packet.
• GET /num-packets
  Get the number of packets in a set.
• GET /set-list
  Get a list of all sets in the database.
• GET /bonus-by-id
  Get a single bonus by its ID.
• GET /tossup-by-id
  Get a single tossup by its ID.
• GET /frequency-list
  Get the most frequent tossup and bonus answers for the given subcategory.

Multiplayer

• GET /multiplayer/room-list
  Get all public rooms.

Other

• GET /check-answer
  Judge an answer to be correct, incorrect, or prompt, given an answerline.
• POST /report-question
  Report a question.
• GET /random-name
  Get a random adjective-noun pair that can be used as a name.