Module my_characters_api 

Structs

AcceptNewTaskParams

struct for passing parameters to the method accept_new_task

ActionTransitionParams

struct for passing parameters to the method action_transition

BuyBankExpansionParams

struct for passing parameters to the method buy_bank_expansion

CancelTaskParams

struct for passing parameters to the method cancel_task

ChangeSkinParams

struct for passing parameters to the method change_skin

CompleteTaskParams

struct for passing parameters to the method complete_task

CraftParams

struct for passing parameters to the method craft

DeleteItemParams

struct for passing parameters to the method delete_item

DepositGoldParams

struct for passing parameters to the method deposit_gold

DepositItemParams

struct for passing parameters to the method deposit_item

EquipItemParams

struct for passing parameters to the method equip_item

FightParams

struct for passing parameters to the method fight

GatherParams

struct for passing parameters to the method gather

GeBuyItemParams

struct for passing parameters to the method ge_buy_item

GeCancelSellOrderParams

struct for passing parameters to the method ge_cancel_sell_order

GeCreateSellOrderParams

struct for passing parameters to the method ge_create_sell_order

GetAllCharactersLogsParams

struct for passing parameters to the method get_all_characters_logs

GetCharacterLogsParams

struct for passing parameters to the method get_character_logs

GiveGoldParams

struct for passing parameters to the method give_gold

GiveItemsParams

struct for passing parameters to the method give_items

MoveCharacterParams

struct for passing parameters to the method move_character

NpcBuyItemParams

struct for passing parameters to the method npc_buy_item

NpcSellItemParams

struct for passing parameters to the method npc_sell_item

RecycleParams

struct for passing parameters to the method recycle

RestCharacterParams

struct for passing parameters to the method rest_character

TaskExchangeParams

struct for passing parameters to the method task_exchange

TaskTradeParams

struct for passing parameters to the method task_trade

UnequipItemParams

struct for passing parameters to the method unequip_item

UseItemParams

struct for passing parameters to the method use_item

WithdrawGoldParams

struct for passing parameters to the method withdraw_gold

WithdrawItemParams

struct for passing parameters to the method withdraw_item

Enums

AcceptNewTaskError

struct for typed errors of method accept_new_task

ActionTransitionError

struct for typed errors of method action_transition

BuyBankExpansionError

struct for typed errors of method buy_bank_expansion

CancelTaskError

struct for typed errors of method cancel_task

ChangeSkinError

struct for typed errors of method change_skin

CompleteTaskError

struct for typed errors of method complete_task

CraftError

struct for typed errors of method craft

DeleteItemError

struct for typed errors of method delete_item

DepositGoldError

struct for typed errors of method deposit_gold

DepositItemError

struct for typed errors of method deposit_item

EquipItemError

struct for typed errors of method equip_item

FightError

struct for typed errors of method fight

GatherError

struct for typed errors of method gather

GeBuyItemError

struct for typed errors of method ge_buy_item

GeCancelSellOrderError

struct for typed errors of method ge_cancel_sell_order

GeCreateSellOrderError

struct for typed errors of method ge_create_sell_order

GetAllCharactersLogsError

struct for typed errors of method get_all_characters_logs

GetCharacterLogsError

struct for typed errors of method get_character_logs

GetMyCharactersError

struct for typed errors of method get_my_characters

GiveGoldError

struct for typed errors of method give_gold

GiveItemsError

struct for typed errors of method give_items

MoveCharacterError

struct for typed errors of method move_character

NpcBuyItemError

struct for typed errors of method npc_buy_item

NpcSellItemError

struct for typed errors of method npc_sell_item

RecycleError

struct for typed errors of method recycle

RestCharacterError

struct for typed errors of method rest_character

TaskExchangeError

struct for typed errors of method task_exchange

TaskTradeError

struct for typed errors of method task_trade

UnequipItemError

struct for typed errors of method unequip_item

UseItemError

struct for typed errors of method use_item

WithdrawGoldError

struct for typed errors of method withdraw_gold

WithdrawItemError

struct for typed errors of method withdraw_item

Functions

accept_new_task

Accepting a new task.

action_transition

Execute a transition from the current map to another layer. The character must be on a map that has a transition available.

buy_bank_expansion

Buy a 20 slots bank expansion.

cancel_task

Cancel a task for 1 tasks coin.

change_skin

Change the skin of your character.

complete_task

Complete a task.

craft

Craft an item. The character must be on a map with a workshop.

delete_item

Delete an item from your character’s inventory.

deposit_gold

Deposit gold in a bank on the character’s map.

deposit_item

Deposit multiple items in a bank on the character’s map. The cooldown will be 3 seconds multiplied by the number of different items deposited.

equip_item

Equip an item on your character.

fight

Start a fight against a monster on the character’s map. Add participants for multi-character fights (up to 3 characters, only for boss).

gather

Harvest a resource on the character’s map.

ge_buy_item

Buy an item at the Grand Exchange on the character’s map.

ge_cancel_sell_order

Cancel a sell order at the Grand Exchange on the character’s map.

ge_create_sell_order

Create a sell order at the Grand Exchange on the character’s map. Please note there is a 3% listing tax, charged at the time of posting, on the total price.

get_all_characters_logs

History of the last 5000 actions of all your characters.

get_character_logs

History of the last actions of your character.

get_my_characters

List of your characters.

give_gold

Give gold to another character in your account on the same map.

give_items

Give items to another character in your account on the same map. The cooldown will be 3 seconds multiplied by the number of different items given.

move_character

Moves a character on the map using either the map’s ID or X and Y position. Provide either ‘map_id’ or both ‘x’ and ‘y’ coordinates in the request body.

npc_buy_item

Buy an item from an NPC on the character’s map.

npc_sell_item

Sell an item to an NPC on the character’s map.

recycle

Recycling an item. The character must be on a map with a workshop (only for equipments and weapons).

rest_character

Recovers hit points by resting. (1 second per 5 HP, minimum 3 seconds)

task_exchange

Exchange 6 tasks coins for a random reward. Rewards are exclusive items or resources.

task_trade

Trading items with a Tasks Master.

unequip_item

Unequip an item on your character.

use_item

Use an item as a consumable.

withdraw_gold

Withdraw gold from your bank.

withdraw_item

Take items from your bank and put them in the character’s inventory. The cooldown will be 3 seconds multiplied by the number of different items withdrawn.