Releases: TeKrop/overfast-api
Releases · TeKrop/overfast-api
Version 2.3.0
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
orconsole
) and gamemode (quickplay
orcompetitive
).- 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
- If the player is only playing on one platform, the
⚠️ 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).
Version 2.2.0
Version 2.1.1
Changelog
- Fixed a conflict issue in parsers when using the same Blizzard URL (invalid parser cache)
Version 2.1.0
Changelog
- Refactored codebase in order to be able to parse several Blizzard pages data for one OverFast API endpoint. Updated the cache system and the documentation accordingly.
- Added
portrait
attribute in/heroes/{hero_key}
endpoint (issue #2, PR #3) - Added better handling of version number (
pyproject.toml
is the only source) - Updated main dependencies :
- FastAPI (v0.85 -> v0.87)
- requests (v2.27.1 -> v2.28.1)
- httpx (v0.23.0 -> v0.23.1)
- Updated dev dependencies :
- pytest (v7.1.3 -> v7.2.0)
- fakeredis (v1.10.0 -> v2.0.0)
- ruff (v0.0.124 -> v0.0.128)
Miscellaneous
- Added isort badge in README
- Added dynamic badges update using GitHub Actions
- Dropped pylint in favor of ruff for code quality checking : https://github.com/charliermarsh/ruff
Version 2.0.3
- Updated to Python 3.11
Version 2.0.2
- Using fakeredis for testing now
Version 2.0.1
Changelog
- Improved codebase and parser error handling
Version 2.0.0
Changelog
- OverFast API now supports new Blizzard pages after Overwatch 2 update (breaking changes)
- Implemented heroes endpoints, roles endpoint and gamemodes list endpoint
- Updated dependencies and codebase accordingly
- Added a career page comeback check using Discord notification (checks every hour)
Pending
- Blizzard career pages and players search are still under maintenance
Version 1.0
Version 1.0, compatible with Overwatch 1.x pages