Characters

API for managing characters.

class artifacts.api.characters.CharactersAPI[source]

Bases: object

Character management endpoints.

__init__(http)[source]
Parameters:

http (HttpClient)

async create(name, skin)[source]

POST /characters/create – create a new character (max 5).

Return type:

CharacterSchema

Parameters:
async delete(name)[source]

POST /characters/delete – delete a character.

Return type:

CharacterSchema

Parameters:

name (str)

async get_active(*, page=1, size=50)[source]

GET /characters/active

Return type:

DataPage[ActiveCharacterSchema]

Parameters:
  • page (int)

  • size (int)

async get(name)[source]

GET /characters/{name}

Return type:

CharacterSchema

Parameters:

name (str)