Models

Data models returned by API methods. All models are dataclasses with full type hints.

Response

class valopy.models.Result(status_code, message='None', data=<factory>)[source]

Bases: object

HTTP request result wrapper.

status_code

The HTTP status code of the response.

Type:: int

message

The HTTP status message.

Type:: str

data

The response data.

Type:: dict

Account

class valopy.models.AccountV1(puuid, region, account_level, name, tag, card, last_update, last_update_raw)[source]

Bases: object

Account V1 information.

puuid

The player’s unique identifier.

Type:: str

region

The player’s region.

Type:: str

account_level

The player’s account level.

Type:: int

name

The player’s game name.

Type:: str

tag

The player’s tag.

Type:: str

card

The player’s card data with image URLs.

Type:: CardData

last_update

Last update timestamp.

Type:: str

last_update_raw

Last update timestamp (raw).

Type:: int

class valopy.models.AccountV2(puuid, region, account_level, name, tag, card, title, platforms, updated_at)[source]

Bases: object

Account V2 information.

puuid

The player’s unique identifier.

Type:: str

region

The player’s region.

Type:: str

account_level

The player’s account level.

Type:: int

name

The player’s game name.

Type:: str

tag

The player’s tag.

Type:: str

card

The player’s card ID.

Type:: str

title

The player’s title.

Type:: str

platforms

Available platforms.

Type:: List[str]

updated_at

Update timestamp.

Type:: str

class valopy.models.CardData(small, large, wide, id)[source]

Bases: object

Player card data.

small

Small card image URL.

Type:: str

large

Large card image URL.

Type:: str

wide

Wide card image URL.

Type:: str

id

Card ID.

Type:: str

Content

class valopy.models.Content(version, characters=<factory>, maps=<factory>, chromas=<factory>, skins=<factory>, skinLevels=<factory>, equips=<factory>, gameModes=<factory>, sprays=<factory>, sprayLevels=<factory>, charms=<factory>, charmLevels=<factory>, playerCards=<factory>, playerTitles=<factory>, acts=<factory>, ceremonies=<factory>)[source]

Bases: object

In-game content data.

version

Content version.

Type:: str

characters

Available characters.

Type:: List[ContentCharacter]

maps

Available maps.

Type:: List[ContentMap]

chromas

Available chromas.

Type:: List[ContentItem]

skins

Available skins.

Type:: List[ContentItem]

skin_levels

Available skin levels.

Type:: List[ContentItem]

equips

Available equips.

Type:: List[ContentItem]

game_modes

Available game modes.

Type:: List[ContentItem]

sprays

Available sprays.

Type:: List[ContentItem]

spray_levels

Available spray levels.

Type:: List[ContentItem]

charms

Available charms.

Type:: List[ContentItem]

charm_levels

Available charm levels.

Type:: List[ContentItem]

player_cards

Available player cards.

Type:: List[ContentItem]

player_titles

Available player titles.

Type:: List[ContentPlayerTitle]

acts

Available acts.

Type:: List[ContentAct]

ceremonies

Available ceremonies.

Type:: List[ContentItem]

class valopy.models.ContentItem(name, id, assetName='', assetPath='', localizedNames=<factory>)[source]

Bases: object

Generic content item structure.

name

Item name.

Type:: str

id

Item ID.

Type:: str

assetName

Asset name.

Type:: str

assetPath

Asset path.

Type:: str

localizedNames

Item names in different locales.

Type:: Dict[str, str]

class valopy.models.ContentCharacter(name, id, assetName='', localizedNames=<factory>, isPlayableCharacter=False)[source]

Bases: object

Content character structure.

name

Character name.

Type:: str

id

Character ID.

Type:: str

assetName

Asset name.

Type:: str

localizedNames

Character names in different locales.

Type:: Dict[str, str]

isPlayableCharacter

Whether character is playable.

Type:: bool

class valopy.models.ContentMap(name, id, assetName='', assetPath='', localizedNames=<factory>)[source]

Bases: object

Content map structure.

name

Map name.

Type:: str

id

Map ID.

Type:: str

assetName

Asset name.

Type:: str

assetPath

Asset path.

Type:: str

localizedNames

Map names in different locales.

Type:: Dict[str, str]

class valopy.models.ContentAct(name, id, localizedNames=<factory>, isActive=False)[source]

Bases: object

Content act structure.

name

Act name.

Type:: str

id

Act ID.

Type:: str

localizedNames

Act names in different locales.

Type:: Dict[str, str]

isActive

Whether the act is currently active.

Type:: bool

class valopy.models.ContentPlayerTitle(name, id, assetName='', titleText='')[source]

Bases: object

Content player title structure.

name

Title name.

Type:: str

id

Title ID.

Type:: str

assetName

Asset name.

Type:: str

titleText

Display text for the title.

Type:: str