Skip to content

Releases: TeKrop/overfast-api

Version 2.7.1

13 Feb 20:12
cc11a84
Compare
Choose a tag to compare

Changelog

PR #14 (issue #13)

Version 2.7.0

29 Jan 16:07
88ccc40
Compare
Choose a tag to compare

Changelog

PR #12

  • Added key attribute in /gamemodes endpoint
  • Added new /maps endpoint exposing a list of available maps on Overwatch. Data is taken from local data in the project.

Version 2.6.0

25 Jan 20:52
748948c
Compare
Choose a tag to compare

Changelog

PR #10

  • Added locale optional query parameter on some routes, with translations made available by Blizzard. Default is en-us (same as before the update). Available locales : de-de, en-gb, en-us, es-es, es-mx, fr-fr, it-it, ja-jp, ko-kr, pl-pl, pt-br, ru-ru and zh-tw.
  • Updated routes with locale parameter :
    • Get a list of heroes (/heroes?locale=xx-xx)
    • Get hero data (/heroes/ana?locale=xx-xx)
    • Get a list of roles (/roles?locale=xx-xx)
    • Get a list of gamemodes (/gamemodes?locale=xx-xx)

Version 2.5.0

23 Jan 17:46
be707a0
Compare
Choose a tag to compare

Changelog

PR : #9

  • Refactored Cache System to reduce complexity and improve memory usage :
    • Parser Cache is now compressed and is the only cache refreshed in background.
    • API Cache is now only generated on-demand (API call) and not refreshed in background. When expired, the next call will use the refreshed Parser Cache to generate a new API Cache.
  • Updated dependencies
  • Fixed various minor issues

Version 2.4.0

08 Jan 19:39
fedd44d
Compare
Choose a tag to compare

Changelog

PR : #8

  • Added stats summary endpoint (/players/{player_id}/stats/summary) :
    • Get a summary of essential stats you would need to track your progress : games played, time played, winrate, kda, eliminations, assists, deaths, damage, healing.
    • You can retrieve data for a specific hero, but it's also calculated for each role and in general
    • Filter on the gamemode and/or platform you want, or retrieve the sum of the data for every gamemode and/or platform (default behaviour)
  • Moved /heroes/roles endpoint to /roles
  • Updated documentation structure and various routes descriptions

Version 2.3.4

03 Jan 21:59
Compare
Choose a tag to compare

Changelog

  • Various bugfixes
  • Updated readme as Blizzard's servers seems stable for two weeks. I'll let the actual values on production (1h of caching) for now.
  • Updated tests

Version 2.3.3

19 Dec 08:44
eceb5da
Compare
Choose a tag to compare

Changelog

  • PR #7 (fix for #6)

Version 2.3.2

11 Dec 15:21
Compare
Choose a tag to compare

Changelog

  • Removed API Cache refresh for players search : it was not relevant as this is a unique request and will most likely not be done on a regular basis, unlike players career stats for example
  • Fixed an issue with API Cache refresh system when dealing with 404 errors from Blizzard on existing players who have been retrieved at least one time with the API.

Additional notes

I'm aware there are still some issues from Blizzard, when the API is sending you an HTTP 504 error saying Blizzard didn't respond in 10 seconds. I'll continue to monitor these errors in the following days, and will update caching settings accordingly after studying the frequency and the duration of these server issues from Blizzard.

Version 2.3.1

09 Dec 10:30
Compare
Choose a tag to compare

Changelog

  • Fixed an issue with profiles containing invalid time values on Blizzard pages (negative)

image

Version 2.3.0

08 Dec 15:33
ea9b376
Compare
Choose a tag to compare

Changelog

  • Added dotenv and updated instructions for Docker Compose deployment
  • Added players search endpoint (/players)
  • Added players career data endpoint (/players/{player_id}) for summary and statistics
  • Added specific endpoint for player summary (/players/{player_id}/stats)
  • Added specific endpoint for players statistics on a given platform (pc or console) and gamemode (quickplay or competitive).
    • If the player is only playing on one platform, the platform parameter is optional
    • It's possible to only retrieve data for a specific hero with the hero parameter

⚠️ Disclaimer concerning career pages ⚠️

Players statistics are cached for performance purposes, as Blizzard pages take ~2-3 seconds to load. Since the pages are back, I noticed it's very unstable on their side, we often have a "504 Gateway Time-out" error, either on players search or career pages, sometimes a "404 Page Not Found" error even if the player exists and its profile is public.

As a consequence, I configured my cache system in order to prevent (in most cases) any issue regarding pages load :

  • Career data is cached for ~2 hours
  • Instead of trying to update the cache 5 min before its expiration, it's trying to update it starting from one hour before its expiration (one try per minute).

I'll try to adjust these values depending on Blizzard pages stability, but don't hesitate to contact me if you have a recurring issue concerning career endpoints loading time (only the first time should be long).