diff --git a/client/api-docs/bonus-by-id.html b/client/api-docs/bonus-by-id.html index 56c6d389..2a73a141 100644 --- a/client/api-docs/bonus-by-id.html +++ b/client/api-docs/bonus-by-id.html @@ -104,6 +104,9 @@
Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/check-answer.html b/client/api-docs/check-answer.html index f0e18b1a..11572e92 100644 --- a/client/api-docs/check-answer.html +++ b/client/api-docs/check-answer.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/frequency-list.html b/client/api-docs/frequency-list.html new file mode 100644 index 00000000..33d65684 --- /dev/null +++ b/client/api-docs/frequency-list.html @@ -0,0 +1,191 @@ + + + + + QB Reader + + + + + + + + + + + + + + + + +
    +
    + +
    +

    API Reference

    + +
    + +
    +

    +
    GET qbreader.org/api/frequency-list
    +

    + +

    + Get the most frequent tossup and bonus answers for the given subcategory. +

    + + +

    Parameters

    +     +
      +
    • +
      + subcategory: string + required +
      +
      + The subcategory to get the list for. +
      +
      • +
    • +
      + limit: number + default: 100 +
      +
      + The maximum number of answers to return. +
      +
      • +
    + + +

    Returns

    +     +
    + A JSON object with the following properties: +
    +
      +
    • +
      + frequencyList: object[] +
      +
      + An array of objects with the following properties, sorted by decreasing frequency: +
      +
        +
      • + answer: string +
        • +
      • + frequency: number +
        • +
      +
      • +
    +
    +
    + + + + + + diff --git a/client/api-docs/index.html b/client/api-docs/index.html index f708a70e..76dd28e6 100644 --- a/client/api-docs/index.html +++ b/client/api-docs/index.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list @@ -197,12 +200,24 @@
    Database
    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
    diff --git a/client/api-docs/multiplayer/room-list.html b/client/api-docs/multiplayer/room-list.html index ba58cd91..dce8107b 100644 --- a/client/api-docs/multiplayer/room-list.html +++ b/client/api-docs/multiplayer/room-list.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/num-packets.html b/client/api-docs/num-packets.html index f03617ed..419256ce 100644 --- a/client/api-docs/num-packets.html +++ b/client/api-docs/num-packets.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/packet-bonuses.html b/client/api-docs/packet-bonuses.html index 7f1d44d3..f4858f53 100644 --- a/client/api-docs/packet-bonuses.html +++ b/client/api-docs/packet-bonuses.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/packet-tossups.html b/client/api-docs/packet-tossups.html index 86b7cfcd..6b0f5e94 100644 --- a/client/api-docs/packet-tossups.html +++ b/client/api-docs/packet-tossups.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/packet.html b/client/api-docs/packet.html index 57ed27db..6c26b1ec 100644 --- a/client/api-docs/packet.html +++ b/client/api-docs/packet.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/query.html b/client/api-docs/query.html index 4b23ebac..5a0b7038 100644 --- a/client/api-docs/query.html +++ b/client/api-docs/query.html @@ -113,6 +113,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/random-bonus.html b/client/api-docs/random-bonus.html index 8e2b0f08..520a1a23 100644 --- a/client/api-docs/random-bonus.html +++ b/client/api-docs/random-bonus.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/random-name.html b/client/api-docs/random-name.html index d582a2cf..12a25975 100644 --- a/client/api-docs/random-name.html +++ b/client/api-docs/random-name.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/random-tossup.html b/client/api-docs/random-tossup.html index ed4aa02f..671384a8 100644 --- a/client/api-docs/random-tossup.html +++ b/client/api-docs/random-tossup.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/report-question.html b/client/api-docs/report-question.html index f4a8be91..51d28bbd 100644 --- a/client/api-docs/report-question.html +++ b/client/api-docs/report-question.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/schemas.html b/client/api-docs/schemas.html index 64ca3811..78338f8d 100644 --- a/client/api-docs/schemas.html +++ b/client/api-docs/schemas.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/set-list.html b/client/api-docs/set-list.html index e991a71b..372c778b 100644 --- a/client/api-docs/set-list.html +++ b/client/api-docs/set-list.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list diff --git a/client/api-docs/tossup-by-id.html b/client/api-docs/tossup-by-id.html index 8160192d..01ae3c0f 100644 --- a/client/api-docs/tossup-by-id.html +++ b/client/api-docs/tossup-by-id.html @@ -104,6 +104,9 @@
    Database
  • tossup-by-id
    • +
  • + frequency-list +
    • Multiplayer
  • room-list