valo_api_official.endpoints package

get_account_by_name(version, name, tag, **kwargs)

Get the account details for a player using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
name (str) – The name of the player to get the account details for.
tag (str) – The tag of the player to get the account details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Account details fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

get_account_by_puuid_v1(puuid, **kwargs)

Get the account details for a player using version 1 of the endpoint.

This is the same as get_account_details_by_puuid(version="v1", puuid=puuid, **kwargs)

Parameters:

puuid (str) – The PUUID of the player to get the account details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Account details fetched from the API.

Return type:

get_account_by_puuid(version, puuid, **kwargs)

Get the account details for a player using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
puuid (str) – The PUUID of the player to get the account details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Account details fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

valo_api_official.endpoints.active_shards module

Functions:

`get_active_shards_v1`(puuid, **kwargs)	Get the active shards for a player using version 1 of the endpoint.
`get_active_shards`(version, puuid, **kwargs)	Get the active shards for a player using a specific version of the endpoint.

get_active_shards_v1(puuid, **kwargs)

Get the active shards for a player using version 1 of the endpoint.

This is the same as get_active_shards(version="v1", puuid=puuid, **kwargs)

Parameters:

puuid (str) – The PUUID of the player to get the active shards for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Active Shards fetched from the API.

Return type:

get_active_shards(version, puuid, **kwargs)

Get the active shards for a player using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
puuid (str) – The PUUID of the player to get the active shards for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Active Shards fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

valo_api_official.endpoints.content module

Functions:

`get_content_v1`([locale])	Get the content for a specific locale using version 1 of the endpoint.
`get_content`(version[, locale])	Get the content for a specific locale using a specific version of the endpoint.

get_content_v1(locale=None, **kwargs)

Get the content for a specific locale using version 1 of the endpoint.

This is the same as get_content(version="v1", locale=locale, **kwargs)

Parameters:

locale (Optional[str]) – The locale to get the content for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Content fetched from the API.

Return type:

get_content(version, locale=None, **kwargs)

Get the content for a specific locale using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
locale (Optional[str]) – The locale to get the content for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Content fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

valo_api_official.endpoints.leaderboard module

Functions:

`get_leaderboard_v1`(region[, act_id, start, size])	Get the leaderboard for a region using version 1 of the endpoint.
`get_leaderboard`(version, region[, act_id, ...])	Get the leaderboard for a region using a specific version of the endpoint.

get_leaderboard_v1(region, act_id=None, start=None, size=None, **kwargs)

Get the leaderboard for a region using version 1 of the endpoint.

This is the same as get_leaderboard(version="v1", region=region, puuid=puuid, name=name, tag=tag, **kwargs)

You can also filter by puuid or name and tag.

Parameters:

region (str) – The region to get the leaderboard for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
act_id (Optional[str]) – The season ID to get the leaderboard for.
start (Optional[int]) – The start index of the leaderboard. Can be used for pagination.
size (Optional[int]) – The size of the leaderboard.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

The leaderboard for the region.

Return type:

get_leaderboard(version, region, act_id=None, start=None, size=None, **kwargs)

Get the leaderboard for a region using a specific version of the endpoint.

You can also filter by puuid or name and tag if you are using v1.

Parameters:

version (str) – The version of the endpoint. One of the following: v1 (Version 1)
region (str) – The region to get the leaderboard for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
act_id (Optional[str]) – The act ID to get the leaderboard for.
start (Optional[int]) – The start index of the leaderboard. Can be used for pagination.
size (Optional[int]) – The size of the leaderboard.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

The leaderboard for the region.

Return type:

Raises:

ValoAPIException – If the request failed.

valo_api_official.endpoints.match_details module

Functions:

`get_match_details_v1`(region, match_id, **kwargs)	Get the match details for a match using version 1 of the endpoint.
`get_match_details`(version, region, match_id, ...)	Get the match details for a match using a specific version of the endpoint.

get_match_details_v1(region, match_id, **kwargs)

Get the match details for a match using version 1 of the endpoint.

This is the same as get_match_details(version="v1", matchId=matchId, **kwargs)

Parameters:

region (str) – The region to get the leaderboard for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
match_id (str) – The match ID to get the details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Match details fetched from the API.

Return type:

get_match_details(version, region, match_id, **kwargs)

Get the match details for a match using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
region (str) – The region to get the leaderboard for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
match_id (str) – The match ID to get the details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Match details fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

valo_api_official.endpoints.match_history module

Functions:

`get_match_history_v1`(region, puuid, **kwargs)	Get the match history for a player using version 1 of the endpoint.
`get_match_history`(version, region, puuid, ...)	Get the match history for a player using a specific version of the endpoint.

get_match_history_v1(region, puuid, **kwargs)

Get the match history for a player using version 1 of the endpoint.

This is the same as get_match_history(version="v1", region=region, puuid=puuid, size=size, game_mode=game_mode, **kwargs)

Parameters:

region (str) – The region of the player. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
puuid (str) – The puuid of the player.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Match History for a player by puuid.

Return type:

get_match_history(version, region, puuid, **kwargs)

Get the match history for a player using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
region (str) – The region of the player. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
puuid (str) – The puuid of the player.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Match History for a player by puuid.

Return type:

Raises:

ValoAPIException – If the request failed.

valo_api_official.endpoints.recent_matches module

Functions:

`get_recent_matches_v1`(region, queue, **kwargs)	Get recent matches for a match queue using version 1 of the endpoint.
`get_recent_matches`(version, region, queue, ...)	Get recent matches for a match queue.

get_recent_matches_v1(region, queue, **kwargs)

Get recent matches for a match queue using version 1 of the endpoint.

This is the same as get_recent_matches(version="v1", queue=queue, **kwargs)

Parameters:

region (str) – The region to get the recent matches for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
queue (str) – The queue to get recent matches for. One of the following: competitive, unrated, spikerush, tournamentmode, deathmatch, onefa, ggteam
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Recent matches fetched from the API.

Return type:

get_recent_matches(version, region, queue, **kwargs)

Get recent matches for a match queue.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
region (str) – The region to get the recent matches for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
queue (str) – The queue to get recent matches for. One of the following: competitive, unrated, spikerush, tournamentmode, deathmatch, onefa, ggteam
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Recent matches fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

valo_api_official.endpoints.status module

Functions:

`get_status_v1`(region, **kwargs)	Get the status for a specific region using version 1 of the endpoint.
`get_status`(version, region, **kwargs)	Get the status for a specific region.

get_status_v1(region, **kwargs)

Get the status for a specific region using version 1 of the endpoint.

This is the same as get_status(version="v1", region=region, **kwargs)

Parameters:

region (str) – The region to get the status for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Status fetched from the API.

Return type:

get_status(version, region, **kwargs)

Get the status for a specific region.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
region (str) – The region to get the status for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Status fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

Module contents

Functions:

`get_account_by_name_v1`(name, tag, **kwargs)	Get the account details for a player using version 1 of the endpoint.
`get_account_by_name`(version, name, tag, **kwargs)	Get the account details for a player using a specific version of the endpoint.
`get_account_by_puuid_v1`(puuid, **kwargs)	Get the account details for a player using version 1 of the endpoint.
`get_account_by_puuid`(version, puuid, **kwargs)	Get the account details for a player using a specific version of the endpoint.
`get_active_shards_v1`(puuid, **kwargs)	Get the active shards for a player using version 1 of the endpoint.
`get_active_shards`(version, puuid, **kwargs)	Get the active shards for a player using a specific version of the endpoint.
`get_content_v1`([locale])	Get the content for a specific locale using version 1 of the endpoint.
`get_content`(version[, locale])	Get the content for a specific locale using a specific version of the endpoint.
`get_leaderboard_v1`(region[, act_id, start, size])	Get the leaderboard for a region using version 1 of the endpoint.
`get_leaderboard`(version, region[, act_id, ...])	Get the leaderboard for a region using a specific version of the endpoint.
`get_match_details_v1`(region, match_id, **kwargs)	Get the match details for a match using version 1 of the endpoint.
`get_match_details`(version, region, match_id, ...)	Get the match details for a match using a specific version of the endpoint.
`get_match_history_v1`(region, puuid, **kwargs)	Get the match history for a player using version 1 of the endpoint.
`get_match_history`(version, region, puuid, ...)	Get the match history for a player using a specific version of the endpoint.
`get_recent_matches_v1`(region, queue, **kwargs)	Get recent matches for a match queue using version 1 of the endpoint.
`get_recent_matches`(version, region, queue, ...)	Get recent matches for a match queue.
`get_status_v1`(region, **kwargs)	Get the status for a specific region using version 1 of the endpoint.
`get_status`(version, region, **kwargs)	Get the status for a specific region.

get_account_by_name_v1(name, tag, **kwargs)

Get the account details for a player using version 1 of the endpoint.

This is the same as get_account_details_by_name(version="v1", name=name, tag=tag, **kwargs)

Parameters:

name (str) – The name of the player to get the account details for.
tag (str) – The tag of the player to get the account details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Account details fetched from the API.

Return type:

get_account_by_name(version, name, tag, **kwargs)

Get the account details for a player using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
name (str) – The name of the player to get the account details for.
tag (str) – The tag of the player to get the account details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Account details fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

get_account_by_puuid_v1(puuid, **kwargs)

Get the account details for a player using version 1 of the endpoint.

This is the same as get_account_details_by_puuid(version="v1", puuid=puuid, **kwargs)

Parameters:

puuid (str) – The PUUID of the player to get the account details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Account details fetched from the API.

Return type:

get_account_by_puuid(version, puuid, **kwargs)

Get the account details for a player using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
puuid (str) – The PUUID of the player to get the account details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Account details fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

get_active_shards_v1(puuid, **kwargs)

Get the active shards for a player using version 1 of the endpoint.

This is the same as get_active_shards(version="v1", puuid=puuid, **kwargs)

Parameters:

puuid (str) – The PUUID of the player to get the active shards for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Active Shards fetched from the API.

Return type:

get_active_shards(version, puuid, **kwargs)

Get the active shards for a player using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
puuid (str) – The PUUID of the player to get the active shards for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Active Shards fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

get_content_v1(locale=None, **kwargs)

Get the content for a specific locale using version 1 of the endpoint.

This is the same as get_content(version="v1", locale=locale, **kwargs)

Parameters:

locale (Optional[str]) – The locale to get the content for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Content fetched from the API.

Return type:

get_content(version, locale=None, **kwargs)

Get the content for a specific locale using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
locale (Optional[str]) – The locale to get the content for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Content fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

get_leaderboard_v1(region, act_id=None, start=None, size=None, **kwargs)

Get the leaderboard for a region using version 1 of the endpoint.

This is the same as get_leaderboard(version="v1", region=region, puuid=puuid, name=name, tag=tag, **kwargs)

You can also filter by puuid or name and tag.

Parameters:

region (str) – The region to get the leaderboard for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
act_id (Optional[str]) – The season ID to get the leaderboard for.
start (Optional[int]) – The start index of the leaderboard. Can be used for pagination.
size (Optional[int]) – The size of the leaderboard.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

The leaderboard for the region.

Return type:

get_leaderboard(version, region, act_id=None, start=None, size=None, **kwargs)

Get the leaderboard for a region using a specific version of the endpoint.

You can also filter by puuid or name and tag if you are using v1.

Parameters:

version (str) – The version of the endpoint. One of the following: v1 (Version 1)
region (str) – The region to get the leaderboard for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
act_id (Optional[str]) – The act ID to get the leaderboard for.
start (Optional[int]) – The start index of the leaderboard. Can be used for pagination.
size (Optional[int]) – The size of the leaderboard.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

The leaderboard for the region.

Return type:

Raises:

ValoAPIException – If the request failed.

get_match_details_v1(region, match_id, **kwargs)

Get the match details for a match using version 1 of the endpoint.

This is the same as get_match_details(version="v1", matchId=matchId, **kwargs)

Parameters:

region (str) – The region to get the leaderboard for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
match_id (str) – The match ID to get the details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Match details fetched from the API.

Return type:

get_match_details(version, region, match_id, **kwargs)

Get the match details for a match using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
region (str) – The region to get the leaderboard for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
match_id (str) – The match ID to get the details for.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Match details fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

get_match_history_v1(region, puuid, **kwargs)

Get the match history for a player using version 1 of the endpoint.

This is the same as get_match_history(version="v1", region=region, puuid=puuid, size=size, game_mode=game_mode, **kwargs)

Parameters:

region (str) – The region of the player. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
puuid (str) – The puuid of the player.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Match History for a player by puuid.

Return type:

get_match_history(version, region, puuid, **kwargs)

Get the match history for a player using a specific version of the endpoint.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
region (str) – The region of the player. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
puuid (str) – The puuid of the player.
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Match History for a player by puuid.

Return type:

Raises:

ValoAPIException – If the request failed.

get_recent_matches_v1(region, queue, **kwargs)

Get recent matches for a match queue using version 1 of the endpoint.

This is the same as get_recent_matches(version="v1", queue=queue, **kwargs)

Parameters:

region (str) – The region to get the recent matches for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
queue (str) – The queue to get recent matches for. One of the following: competitive, unrated, spikerush, tournamentmode, deathmatch, onefa, ggteam
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Recent matches fetched from the API.

Return type:

get_recent_matches(version, region, queue, **kwargs)

Get recent matches for a match queue.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
region (str) – The region to get the recent matches for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
queue (str) – The queue to get recent matches for. One of the following: competitive, unrated, spikerush, tournamentmode, deathmatch, onefa, ggteam
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Recent matches fetched from the API.

Return type:

Raises:

ValoAPIException – If the request failed.

get_status_v1(region, **kwargs)

Get the status for a specific region using version 1 of the endpoint.

This is the same as get_status(version="v1", region=region, **kwargs)

Parameters:

region (str) – The region to get the status for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Status fetched from the API.

Return type:

get_status(version, region, **kwargs)

Get the status for a specific region.

Parameters:

version (str) – The version of the endpoint to use. One of the following: v1 (Version 1)
region (str) – The region to get the status for. One of the following: eu (Europe), na (North America), ap (Asia Pacific), kr (Korea), latam (Latin America), br (Brazil)
**kwargs – Any additional arguments to pass to the endpoint.

Returns:

Status fetched from the API.

Return type: