Ergast v Official API

[BrightDV]

Ergast references both the deprecated Ergast API and its replacement Jolpica-F1 API (which is compliant with the deprecated API).
Official API references the API used in the official mobile app and on the official website.

Why is it so complicated to choose one?

Both APIs have downsides, no one is perfect...
So here is the recap:

• Ergast's downsides:
  • Ergast can be slow to show results: it scrapes FIA's PDFs then processes the data, so it needs some time to show latest results. The Official API have been much faster in my experience: results are shown (with missing information) minutes after the end of a session and are updated after according to the final ones published on FIA's website.
  • Ergast does not have Free Practices nor Sprint Qualifying data yet. (https://github.com/jolpica/jolpica-f1/blob/main/docs/README.md#endpoints-and-documentation)
  • Ergast does not have any image links. I used to write static converters to give image links for every driver/circuit which was a bit of a hassle for me and which raised many issues (missing driver image, missing circuit image...) ([BUG] Missing image at the top of upcoming racing #141, Full 2023 Season Support #69 and releases notes). Updating one link would require a full update of the app...
• Official API's downsides:
  • Relies on not documented API so it can break at any time and there are no other FOSS projects using it (or I didn't find one yet), so another obstacle for new contributors.
  • Does not have driver and team results when seeing their details (UI & API Error: Driver & Team Standings > Results/Information error #200).

So why not use both?

I used to do that, but it was really hard to maintain. Each season required a brand-new converter linking every circuit from Ergast to the Official API's version, every driver to its image, every circuit to its image... (see https://github.com/BrightDV/BoxBox/blob/main/lib/helpers/convert_ergast_and_formula_one.dart and winter updates)
Therefore, there were many converters, which meant many things to maintain, needing a full app update on every change.

My current goal is to remove the need for a maintainer on the data, so even if I can't work on the app (and that there are no breaking changes in the API) the app can still work flawlessly.

Solutions

As you may have seen, I lately pushed towards using only the Official API (now default setting on fresh install). Since Ergast's deprecation (not Jolpica's) at the end of 2024, I wrote the app with the Official API only in mind. (best example: the new Circuit Screen).
However, an issue was raised when I removed the results tab from the Details Screen (#200) leading to this discussion. Thus, the need of a better solution is needed.

Side-note: there are currently no analytics in the app (and this won't change!), but I don't know what are the (most) used part of the app. Whenever I remove something, it is because it is either broken or because I never use it, so I think that it is the case for many users… Therefore, I may create a poll every year to understand better how the app is used and what could be improved/added (the main feedback I have of the app is my feedback…).

Current ideas

The 3rd idea is the one I am currently planning to do.

1. A JSON converter file hosted on GitHub, and a refresh button in the app. This would allow a one-click update of the converter of the app, without the need of a new update. For instance, a popup could be shown when the file is updated asking the user to update his converter and maybe an auto-update setting too.
2. Completely dropping Ergast API and relying only on the Official API. As there are not many projects using this API, it would make it even more difficult to have new contributors and remove some wanted features (UI & API Error: Driver & Team Standings > Results/Information error #200).
3. Having a setting to choose between the two as it is currently, but without any converter. This would mean no driver details and no driver/team/circuit images when using the Ergast API and no driver/team results when using the Official API.

Plans for the future

I will not have more time next year to work on the app as I would want to, but it should be better in 2 or 3 years.

I want to make Box, Box! a universal app for motorsport racing, supporting many championships! It would require a huge rewrite of many part of the app, but I already started this when adding Formula E. With this done, both API could be used to follow the same championship (third idea).
I know that many apps die under huge rewrites, so I will not rewrite it from scratch, but rather adapt the code.

If you read this to the end, well done…
If you have any idea or suggestion, please share it!