Domain Reference

Bank

class artifacts.domains.BankDomain(name, http, *, auto_wait=True, cooldown_ref)[source]

Manage bank operations.

Accessed via character.bank:

await char.bank.deposit_gold(quantity=500)
await char.bank.withdraw_items(items=[SimpleItemSchema(code="iron_ore", quantity=10)])
await char.bank.buy_expansion()
Parameters:

  • name (str)

  • http (HttpClient)

  • auto_wait (Union[bool, list])

  • cooldown_ref (List[Optional[float]])

async deposit_gold(*, quantity)[source]

Deposit gold into the bank.

Parameters:

quantity (int)

Return type:

BankGoldTransactionSchema

async withdraw_gold(*, quantity)[source]

Withdraw gold from the bank.

Parameters:

quantity (int)

Return type:

BankGoldTransactionSchema

async deposit_items(items)[source]

Deposit items into the bank.

Parameters:

items (list[SimpleItemSchema])

Return type:

BankItemTransactionSchema

async withdraw_items(items)[source]

Withdraw items from the bank.

Parameters:

items (list[SimpleItemSchema])

Return type:

BankItemTransactionSchema

async buy_expansion()[source]

Purchase a 20-slot bank expansion.

Return type:

BankExtensionTransactionSchema

Equipment

class artifacts.domains.EquipmentDomain(name, http, *, auto_wait=True, cooldown_ref)[source]

Manage character equipment.

Accessed via character.equipment:

await char.equipment.equip(code="iron_sword", slot=ItemSlot.WEAPON)
await char.equipment.unequip(slot=ItemSlot.HELMET)
Parameters:

  • name (str)

  • http (HttpClient)

  • auto_wait (Union[bool, list])

  • cooldown_ref (List[Optional[float]])

async equip(*, code, slot, quantity=1)[source]

Equip an item into a slot.

Parameters:

  • code (str)

  • slot (ItemSlot)

  • quantity (int)

Return type:

EquipRequestSchema

async unequip(*, slot, quantity=1)[source]

Unequip an item from a slot.

Parameters:

  • slot (ItemSlot)

  • quantity (int)

Return type:

EquipRequestSchema

Skills

class artifacts.domains.SkillsDomain(name, http, *, auto_wait=True, cooldown_ref)[source]

Manage skill actions (gathering, crafting, recycling).

Accessed via character.skills:

await char.skills.gather()
await char.skills.craft(code="iron_sword", quantity=2)
await char.skills.recycle(code="wooden_shield")
Parameters:

  • name (str)

  • http (HttpClient)

  • auto_wait (Union[bool, list])

  • cooldown_ref (List[Optional[float]])

async gather()[source]

Gather a resource at the current map location.

Return type:

SkillDataSchema

async craft(*, code, quantity=1)[source]

Craft an item.

Parameters:
Return type:

SkillDataSchema

async recycle(*, code, quantity=1)[source]

Recycle an item into materials.

Parameters:
Return type:

RecyclingDataSchema

Grand Exchange

class artifacts.domains.GrandExchangeDomain(name, http, *, auto_wait=True, cooldown_ref)[source]

Manage Grand Exchange operations.

Accessed via character.ge:

await char.ge.sell(code="iron_ore", quantity=10, price=5)
await char.ge.buy(id="order-123", quantity=5)
await char.ge.cancel(id="order-123")
Parameters:

  • name (str)

  • http (HttpClient)

  • auto_wait (Union[bool, list])

  • cooldown_ref (List[Optional[float]])

async buy(*, id, quantity)[source]

Buy items from an existing sell order.

Parameters:
Return type:

GETransactionListSchema

async sell(*, code, quantity, price)[source]

Create a sell order on the Grand Exchange.

Parameters:
Return type:

GEOrderTransactionSchema

async create_buy_order(*, code, quantity, price)[source]

Create a buy order on the Grand Exchange.

Parameters:
Return type:

GEOrderTransactionSchema

async fill(*, id, quantity)[source]

Fill an existing buy order.

Parameters:
Return type:

GETransactionListSchema

async cancel(*, id)[source]

Cancel an existing order.

Parameters:

id (str)

Return type:

GEOrderTransactionSchema

Inventory

class artifacts.domains.InventoryDomain(name, http, *, auto_wait=True, cooldown_ref)[source]

Manage inventory items.

Accessed via character.inventory:

await char.inventory.use(code="cooked_chicken", quantity=2)
await char.inventory.delete(code="old_sword")
Parameters:

  • name (str)

  • http (HttpClient)

  • auto_wait (Union[bool, list])

  • cooldown_ref (List[Optional[float]])

async use(*, code, quantity=1)[source]

Use a consumable item from inventory.

Parameters:
Return type:

UseItemSchema

async delete(*, code, quantity=1)[source]

Permanently delete an item from inventory.

Parameters:
Return type:

DeleteItemSchema

Tasks

class artifacts.domains.TasksDomain(name, http, *, auto_wait=True, cooldown_ref)[source]

Manage tasks from the Tasks Master.

Accessed via character.tasks:

await char.tasks.new()
await char.tasks.trade(code="iron_ore", quantity=10)
await char.tasks.complete()
await char.tasks.exchange()
Parameters:

  • name (str)

  • http (HttpClient)

  • auto_wait (Union[bool, list])

  • cooldown_ref (List[Optional[float]])

async new()[source]

Accept a new task from the Tasks Master.

Return type:

TaskDataSchema

async complete()[source]

Complete and turn in the current task.

Return type:

RewardDataSchema

async exchange()[source]

Exchange 6 task coins for a reward.

Return type:

RewardDataSchema

async trade(*, code, quantity)[source]

Trade items with the Tasks Master.

Parameters:
Return type:

TaskTradeDataSchema

async cancel()[source]

Cancel the current task (costs 1 task coin).

Return type:

TaskCancelledSchema

Trading

class artifacts.domains.TradingDomain(name, http, *, auto_wait=True, cooldown_ref)[source]

Manage NPC trading and player-to-player transfers.

Accessed via character.trading:

await char.trading.npc_buy(code="healing_potion", quantity=5)
await char.trading.npc_sell(code="iron_ore", quantity=10)
await char.trading.give_gold(quantity=100, character="Friend")
Parameters:

  • name (str)

  • http (HttpClient)

  • auto_wait (Union[bool, list])

  • cooldown_ref (List[Optional[float]])

async npc_buy(*, code, quantity=1)[source]

Buy from an NPC merchant.

Parameters:
Return type:

NpcMerchantTransactionSchema

async npc_sell(*, code, quantity=1)[source]

Sell to an NPC merchant.

Parameters:
Return type:

NpcMerchantTransactionSchema

async give_gold(*, quantity, character)[source]

Give gold to another character.

Parameters:

  • quantity (int)

  • character (str)

Return type:

GiveGoldDataSchema

async give_items(*, items, character)[source]

Give items to another character.

Parameters:

  • items (list[SimpleItemSchema])

  • character (str)

Return type:

GiveItemDataSchema