All notable changes to this project will be documented in this file.
- Fixed the sync version of the wrapper to not raise a RuntimeWarning due to using
asyncio.sleep()
instead oftime.sleep()
- New brawler tick
- Renamed ricochet to rico
- Fixed the sync client when not using
prevent_ratelimit
- Bibi!
- Changed the Base URL back to the new URL.
- Now waits the number of seconds instead of raising a
RateLimitError
when a rate limit will be detected BEFORE it requests.
- Changed the BASE URL to the old API URL. VERSION 2.3.6 WILL NOT WORK DUE TO API TIMEOUT ISSUES. PLEASE UPDATE.
- Rosa to the brawler list
prevent_ratelimit
option when initializing a client to wait when chaining requests
- Base URL for requests to the new API URL
- Ratelimit updated to API's 3 requests per second
- Fixed the rate limit handler when error code 429 was returned by the API.
- Fixed a mistake where
time()
was being called directly (instead oftime.time()
)
- Added carl to the brawler list
- Renamed
Profile
class toPlayer
- Allows users to pass in a connector for the async client which fixes issue #19.
- Creates requests with gzip encoding enabled to cut request times.
- Detect a rate limit before it requests from the API.
- Changed the request log.
- No longer imports itself in
utils.py
for the version number.
- Added caching that clears after 180 seconds to not spam the API with the same requests.
- Fixed debug on the sync client.
- Added the text that the API returns when an
UnexpectedError
is raised. If you see this, you should report the error to the discord server
- Fixed the club search request URL
- Fixed sync
search_club
- Fixed issue #20
- Removed
pytest
from the package requirements.
- Club search actually returns a list now.
- Added wrapper and python version numbers to the User Agent when making API requests.
url
param in the client changed tobase_url
debug
option to pass in when intializingbrawlstats.core.Client
to log requests.
- Fixed installation error where the
constants.json
info key was removed.
- Added gene to the list of brawlers to get for the brawler leaderboard.
- Fixed
search_club()
- Fixed some attribute typos in docs for the Misc category
- Providing no loop while setting
is_async
toTrue
now correctly defaults toasyncio.get_event_loop()
- Fixed the URL for
get_club()
- Fixed some typos in docs
- Fixed attribute charts in docs
- Change the way you get a brawler with
get_leaderboard()
- Updated documentation for added keys
- Search Clubs (
search_club()
) - Season and Shop Data (
get_misc()
)
- Loop parameter for the client for aiohttp sessions if one has not yet been specified. If you specify a session, you must set the loop to that session before you pass it in otherwise the loop will not be applied.
- MaintenanceError raised when the game is undergoing maintenance.
- Fix any data that involves a list (Leaderboard)
get_datetime
function for easier date and time conversions
- No longer need to access a players or clubs attribute when getting a leaderboard
- Fixed a bug in the sync version of
get_constants()
where there was an extraawait
- Constants extracted from the Brawl Stars App using
Client.get_constants
BREAKING CHANGES: Brawl Stars dev team changed "Band" to "Club". This update fixes all of that.
Band
has been changed toClub
SimpleBand
has been changed toPartialClub
- Documentation has been updated for this
- All methods that originally had "band" in them have been changed to "club"
- All attributes that originally had "band" in them have been changed to "club"
RateLimitError
to handle the 2 requests/sec ratelimit of the API.
- Remove warnings and stuff to prevent memory leaks and fix session initialization (PR from Kyber)
- Resp accessible in data models via
Model.resp
- Added documentation for below change and new attributes that the API introduced.
InvalidTag
changed toNotFoundError
- Allows developers to change the base URL to make request to. This addresses issue #6
- Synchronous support! You can now set if you want an async client by using
is_async=True
asyncio.TimeoutError
now properly raisesServerError
BadRequest
andNotFoundError
(negates v2.0.6). These were found to not be needed
- Support for the new
/events
endpoint for current and upcoming event rotations
- Change the Unauthorized code from 403 to 401 due to API error code changes
BadRequest
andNotFoundError
for more API versatility
- Leaderboards fixed
- Support for the brand new API at https://brawlapi.cf/api