Bingo Resource API and Personal Bingo API improvements

[HacktheTime]

1) Goal Resource API

Given that the official wiki was the only source of the Bingo Goals it would be interestin to get an /resource endpoint for it.

This would require some major changes likely though since sky unfortunately has quite some duplicate goals with obtain_crystal (Nulceus crystals all have the same id) or the FORGE_ITEM with forge a Drill during a Special Bingo.

While a full list would be best having even only the Collection amounts as resources endpoint would be very useful.

2) Public Bingo API changes. (https://api.hypixel.net/v2/resources/skyblock/bingo)

While to public bingo api is pretty cool already there are omse things that could be added still.

Im mayorly thinking of useful stats globally such as the total completions.

In each goal Data for contributors (Community Goal) or completions (Personal). For Community goals maybe the amount needed for each tier right now? Could be interesting.

We have recieved info from skyerzz about these things previously meaning that this Data should is present already and probably not that much effort to add?

Community Goal:

    {
      "id": "kill_dungeon_boss_catacombs_1",
      "name": "Clown Collab",
      "tiers": [
        1000,
        2000,
        3000,
        4000,
        5000
      ],
      "progress": 5612,
      "lore": "§7Defeat §cBonzo §a5,000 §7times.",
      "fullLore": [
        "§7Defeat §cBonzo §a5,000 §7times."
      ],
+     "contributors": 1000,
+     "bracketcontribution": [
+        100, #Top 100 / 1%
+        50, #Top 5%
+        25, #Top...
+        ...
+     ]
    },

Personal:

    {
      "id": "KILL_TRAPPER_MOB",
      "name": "Setting a Trap",
      "lore": "§7Kill a §aTrapper Animal§7.",
      "fullLore": [
        "§7Kill a §aTrapper Animal§7."
      ],
+     "completions": 1000
    }

Secret Bingos

Secret bingo should also add a next tip field that tells us when the next tip is exactly (epoch seconds)

3) Private Bingo API changes. (https://api.hypixel.net/skyblock/bingo?uuid=4fa1228c8dd647c48fe3b04b580311b8&key=)

The API is currently missing contribution Data and Card Data.

Some of this Data might should be put behind a new api section on the profiles or Hypixel Settings. Expose Bingo Data. Optimally not reset each Bingo.

+ bingo rank
* events []
{
* key # The current keys system.
* points
+ completed_goals [] → {}
+ - id → completion time epoch seconds. # completion time would be interesting if its available.
+ card (null if not completed)
+ - Completion Time
+ - Position of Completion
+ - Playtime.
+ Contribution {} # This Data should only after a toggle be exposed publicly during Bingo. Otherwise only after Bingo. (Snipe avasion)
+ - "goal id" : {}
+ - amount
+ - bracket # Like top 100, 25% etc. For higher positions in top 100 it could be cool to make it #10 or #1 for verification purposes.
}

[farfromexact]

These are good ideas, but I would split the proposal into a versioned public resource API and private or delayed profile data. The duplicate-goal issue is especially important: the resource identifier should be stable within a Bingo event, with an event or season namespace, rather than assuming the display goal name is unique.

For the public resource endpoint, I would start with immutable or cacheable goal metadata and explicit fields for collection amounts, tiers, and the next secret-tip time. For live progress, document whether totals are approximate or eventually consistent. For community goals, contributors and contribution brackets should have a clear snapshot timestamp so clients do not interpret a moving ranking as a final result.

For personal data, completed goals should be objects rather than a mix of arrays and maps, for example goal ID plus completion time, and the card should be nullable until completion. The contribution section should follow the privacy rule you mentioned: hidden during an active Bingo unless the player opts in, then available after the event. That avoids turning the endpoint into a live sniping tool.

A small schema proposal with event ID, stable goal ID, data freshness, and visibility rules would make this easier to implement incrementally than adding every statistic to the existing endpoint at once.

[HacktheTime]

The duplicate-goal issue is especially important: the resource identifier should be stable within a Bingo event, with an event or season namespace, rather than assuming the display goal name is unique.

You do realise that that is the case? The main Issue is that it makes problems comparing goals to other bingos since the descriptions and names had typo fixes previously. So no exact matches.

For the public resource endpoint, I would start with immutable or cacheable goal metadata and explicit fields for collection amounts, tiers, and the next secret-tip time. For live progress, document whether totals are approximate or eventually consistent. For community goals, contributors and contribution brackets should have a clear snapshot timestamp so clients do not interpret a moving ranking as a final result.

Collections can be interpreted from the goal id.
Amounts are also in there already with required amount field.

While the time of data for positions etc also matters a timing for that would also be important indeed

For personal data, completed goals should be objects rather than a mix of arrays and maps, for example goal ID plus completion time, and the card should be nullable until completion.

I assumed it to work like previously. I just had the idea to add time to it as well.

A small schema proposal with event ID, stable goal ID, data freshness, and visibility rules would make this easier to implement incrementally than adding every statistic to the existing endpoint at once.

I am pretty sure a lot of the data could be added.

The bingo cards always appear in the players deliveries and those never get deleted. Some data which isn't on the card back then would be lost though.

The public completions data is sth sky has access to already.

Personal contribution info is possible since they store the com goal amounts since bingo without ever deleting them. So they would have to sort and analyze them.