Package-level declarations

Types

Link copied to clipboard
@Serializable
data class AchievementEntry(val name: String, val isSecret: Boolean)

An achievement in an Auction.

Link copied to clipboard
interface AjaxPaginator<T> : Paginated<T>

A paginator that can be fetched via AJAX requests.

Link copied to clipboard
@Serializable
data class Auction(val name: String, val auctionId: Int, val level: Int, val world: String, val vocation: Vocation, val sex: Sex, val outfit: OutfitImage, val displayedItems: List<ItemEntry>, val salesArguments: List<SalesArgument>, val startsAt: Instant, val endsAt: Instant, val bid: Int, val bidType: BidType, val status: AuctionStatus, val details: AuctionDetails?)

An auction in the CharacterBazaar.

Link copied to clipboard

The possible BattlEye protection type filters for auctions.

Link copied to clipboard
sealed interface AuctionCreatureEntry

A creature entry of an Auction character, could be a bestiary or bosstiary entry.

Link copied to clipboard
@Serializable
data class AuctionDetails(val hitPoints: Int, val mana: Int, val capacity: Int, val speed: Int, val blessingsCount: Int, val mountsCount: Int, val outfitsCount: Int, val titlesCount: Int, val skills: AuctionSkills, val characterCreatedAt: Instant, val experience: Long, val gold: Long, val achievementPoints: Int, val regularWorldTransfersUnlockAt: Instant?, val hasCharmExpansion: Boolean, val availableCharmPoints: Int, val spentCharmPoints: Int, val availableMinorCharmEchoes: Int, val spentMinorCharmEchoes: Int, val dailyRewardStreak: Int, val huntingTaskPoints: Int, val permanentWeeklyTaskExpansion: Boolean, val permanentPreySlots: Int, val preyWildcards: Int, val hirelings: Int, val hirelingJobs: Int, val hirelingOutfits: Int, val exaltedDust: Int, val exaltedDustLimit: Int, val bossPoints: Int, val bonusPromotionPoints: Int, val animusMasteriesUnlocked: Int, val items: ItemSummary, val storeItems: ItemSummary, val mounts: Mounts, val storeMounts: Mounts, val outfits: Outfits, val storeOutfits: Outfits, val familiars: Familiars, val blessings: List<BlessingEntry>, val imbuements: List<String>, val charms: List<CharmEntry>, val completedCyclopediaMapAreas: List<String>, val completedQuestLines: List<String>, val titles: List<String>, val achievements: List<AchievementEntry>, val bestiaryProgress: List<BestiaryEntry>, val bosstiaryProgress: List<BosstiaryEntry>, val revealedGems: List<RevealedGem>, val fragmentProgress: List<FragmentProgressEntry>, val proficiencies: List<WeaponProficiency>)

An auction's details.

Link copied to clipboard

The possible fields you can order auctions by.

Link copied to clipboard

The possible ordering directions for auctions.

Link copied to clipboard
Link copied to clipboard

The types of search for the input field in the character bazaar.

Link copied to clipboard

The possible skills to filter auctions by.

Link copied to clipboard
@Serializable
data class AuctionSkills(val axeFighting: Double, val clubFighting: Double, val distanceFighting: Double, val fishing: Double, val fistFighting: Double, val magicLevel: Double, val shielding: Double, val swordFighting: Double)

The skill levels of the character in the auction.

Link copied to clipboard

The possible values an auction might have.

Link copied to clipboard

The possible vocations to filter auction results.

Link copied to clipboard
interface BaseOutfit

A base outfit displayed in auctions.

Link copied to clipboard
@Serializable
data class BazaarFilters(val world: String? = null, val pvpType: PvpType? = null, val battlEyeType: AuctionBattlEyeFilter? = null, val vocation: AuctionVocationFilter? = null, val minimumLevel: Int? = null, val maximumLevel: Int? = null, val skill: AuctionSkillFilter? = null, val minimumSkillLevel: Int? = null, val maximumSkillLevel: Int? = null, val orderDirection: AuctionOrderDirection? = null, val orderBy: AuctionOrderBy? = null, val searchString: String? = null, val searchType: AuctionSearchType? = null)

Filtering parameters for the CharacterBazaar

Link copied to clipboard

The types of bazaar views.

Link copied to clipboard
@Serializable
data class BestiaryEntry(val name: String, val kills: Long, val step: Int, val isMasteryUnlocked: Boolean) : AuctionCreatureEntry

A bestiary entry of an Auction character.

Link copied to clipboard

The possible bid types an auction might have.

Link copied to clipboard
@Serializable
data class BlessingEntry(val name: String, val amount: Int)

A blessing of an Auction character.

Link copied to clipboard
@Serializable
data class BosstiaryEntry(val name: String, val kills: Long, val step: Int) : AuctionCreatureEntry

A bosstiary entry of an Auction character.

Link copied to clipboard
@Serializable
data class CharacterBazaar(val type: BazaarType, val filters: BazaarFilters = BazaarFilters(), val currentPage: Int, val totalPages: Int, val resultsCount: Int, val entries: List<Auction>) : PaginatedWithUrl<Auction>

The Character Bazaar.

Link copied to clipboard
@Serializable
data class CharmEntry(val name: String, val cost: Int, val currency: String, val type: String, val grade: Int)

A charm of an auctioned character.

Link copied to clipboard
@Serializable
data class FamiliarEntry(val name: String, val familiarId: Int)

A familiar of an Auction character.

Link copied to clipboard
@Serializable
data class Familiars(val currentPage: Int, val totalPages: Int, val resultsCount: Int, val entries: List<FamiliarEntry>, val isFullyFetched: Boolean) : AjaxPaginator<FamiliarEntry>

The familiars of a character in an Auction.

Link copied to clipboard
@Serializable
data class FragmentProgressEntry(val grade: Int, val effect: String, val modType: String)

Represents the progress of a fragment in an auctioned character's details.

Link copied to clipboard
@Serializable
data class ItemEntry(val itemId: Int, val name: String, val description: String?, val count: Int, val tier: Int)

An in-game item in an Auction.

Link copied to clipboard
@Serializable
data class ItemSummary(val currentPage: Int, val totalPages: Int, val resultsCount: Int, val entries: List<ItemEntry>, val isFullyFetched: Boolean) : AjaxPaginator<ItemEntry>

A collection of items of an auctioned character.

Link copied to clipboard
@Serializable
data class MountEntry(val name: String, val mountId: Int)

A mount in an Auction character.

Link copied to clipboard
@Serializable
data class Mounts(val currentPage: Int, val totalPages: Int, val resultsCount: Int, val entries: List<MountEntry>, val isFullyFetched: Boolean) : AjaxPaginator<MountEntry>

The mounts owned by an Auction character.

Link copied to clipboard
@Serializable
data class OutfitEntry(val name: String, val outfitId: Int, val addons: Int) : BaseOutfit

An outfit owned or unlocked by a character in an Auction.

Link copied to clipboard
@Serializable
data class OutfitImage(val outfitId: Int, val addons: Int) : BaseOutfit

The currently selected outfit of a character in an Auction.

Link copied to clipboard
@Serializable
data class Outfits(val currentPage: Int, val totalPages: Int, val resultsCount: Int, val entries: List<OutfitEntry>, val isFullyFetched: Boolean) : AjaxPaginator<OutfitEntry>

The outfits of a character in an Auction.

Link copied to clipboard
@Serializable
data class RevealedGem(val gemType: String, val mods: List<RevealedGemMod>)

A gem that has been revealed for the character.

Link copied to clipboard
@Serializable
data class RevealedGemMod(val effects: List<String>)

A mod for a revealed gem.

Link copied to clipboard
@Serializable
data class SalesArgument(val categoryId: Int, val content: String)

A special highlight or description of the auction, selected by the author.

Link copied to clipboard
@Serializable
data class WeaponProficiency(val name: String, val level: Int, val maxLevel: Int, val totalProgress: Int, val hasMastery: Boolean)

Represents a character's proficiency with a weapon in the game.