Statuses¶
-
class
arez.
ServerStatus
[source]¶ An object representing the current HiRez server’s status.
You can get this from the
PaladinsAPI.get_server_status
method.-
timestamp
¶ A UTC timestamp denoting when this status was fetched.
- Type
-
limited_access
¶ True
if at least one live server has limited access,False
otherwise.Note that this doesn’t include PTS.
- Type
-
status
¶ The overall server status description.
This represents the worst status of all individual server statuses.
Under Maintenance
is considered second worst.- Type
Literal[“Operational”, “Under Maintenance”, “Degraded Performance”, “Partial Outage”, “Major Outage”]
-
color
¶ The color associated with the current overall server status.
There is an alias for this under
colour
.- Type
-
statuses
¶ A dictionary of all individual available server statuses.
The usual keys you should be able to find here are:
pc
,ps4
,xbox
,switch
,epic
andpts
.
-
maintenances
¶ A list of maintenances that will (or are) affect the server status in the future.
- Type
-
-
class
arez.
Status
[source]¶ Represets a single server status.
You can find these on the
ServerStatus
object.-
platform
¶ A string denoting which platform this status is for.
- Type
Literal[“PC”, “PS4”, “Xbox”, “Switch”, “PTS”]
-
version
¶ The current version of this server.
This will be an empty string if the information wasn’t available.
- Type
-
status
¶ This server’s status description.
- Type
Literal[“Operational”, “Under Maintenance”, “Degraded Performance”, “Partial Outage”, “Major Outage”]
-
-
class
arez.
PlayerStatus
[source]¶ Represents a Player’s in-game status.
You can get this from the
PartialPlayer.get_status
method.-
player
¶ The player this status is for.
- Type
PartialPlayer | Player
-
live_match_id
¶ ID of the live match the player is currently in.
None
if the player isn’t in a match.- Type
int | None
-
queue
¶ The queue the player is currently playing in.
None
if the player isn’t in a match.- Type
Queue | None
-
await
get_live_match
(language=None, *, expand_players=False)[source]¶ Fetches a live match the player is currently in.
Uses up a single request.
- Parameters
language (Language) –
The language to fetch the match in.
Default language is used if not provided.
expand_players (bool) –
When set to
True
, partial player objects in the returned match object will automatically be expanded into fullPlayer
objects, if possible.Uses an addtional request to do the expansion.
Defaults to
False
.
- Returns
The live match requested.
None
is returned if the player isn’t in a live match, or the match is played in an unsupported queue (customs).- Return type
LiveMatch | None
-