Package-level declarations

Functions

Link copied to clipboard
suspend fun getLeastRecentlyUpdatedItems(dataCenter: DataCenter, entries: Short? = null): RecentlyUpdatedItems

Returns the least-recently updated items on the specified DataCenter, along with the upload times for each item.

suspend fun getLeastRecentlyUpdatedItems(world: World, entries: Short? = null): RecentlyUpdatedItems

Returns the least-recently updated items on the specified World, along with the upload times for each item.

Link copied to clipboard

Returns the least-recently updated items on the specified DataCenter, along with the upload times for each item.

Returns the least-recently updated items on the specified World, along with the upload times for each item.

@JvmName(name = "getLeastRecentlyUpdatedItems")
fun getLeastRecentlyUpdatedItemsAsync(dataCenter: DataCenter, entries: Short? = null): CompletableFuture<RecentlyUpdatedItems>

Returns the least-recently updated items on the specified DataCenter, along with the upload times for each item.

@JvmName(name = "getLeastRecentlyUpdatedItems")
fun getLeastRecentlyUpdatedItemsAsync(world: World, entries: Short? = null): CompletableFuture<RecentlyUpdatedItems>

Returns the least-recently updated items on the specified World, along with the upload times for each item.

Link copied to clipboard

Returns an array of marketable item IDs.

Link copied to clipboard

Returns an array of marketable item IDs.

@JvmName(name = "getMarketableItems")
fun getMarketableItemsAsync(): CompletableFuture<IntArray>

Returns an array of marketable item IDs.

Link copied to clipboard
suspend fun getMarketBoardCurrentData(dataCenter: DataCenter, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CurrentlyShown

Returns the data currently shown on the market board for the requested item ID and DataCenter.

suspend fun getMarketBoardCurrentData(dataCenter: DataCenter, itemIds: IntArray, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<CurrentlyShown>

Returns the data currently shown on the market board for the requested array of item IDs and DataCenter.

suspend fun getMarketBoardCurrentData(region: Region, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CurrentlyShown

Returns the data currently shown on the market board for the requested item ID and Region.

suspend fun getMarketBoardCurrentData(region: Region, itemIds: IntArray, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<CurrentlyShown>

Returns the data currently shown on the market board for the requested array of item IDs and Region.

suspend fun getMarketBoardCurrentData(world: World, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CurrentlyShown

Returns the data currently shown on the market board for the requested item ID and World.

suspend fun getMarketBoardCurrentData(world: World, itemIds: IntArray, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<CurrentlyShown>

Returns the data currently shown on the market board for the requested array of item IDs and World.

Link copied to clipboard
fun getMarketBoardCurrentDataAsync(dataCenter: DataCenter, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and DataCenter.

fun getMarketBoardCurrentDataAsync(region: Region, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and Region.

fun getMarketBoardCurrentDataAsync(world: World, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and World.

@JvmName(name = "getMarketBoardCurrentData")
fun getMarketBoardCurrentDataAsync(dataCenter: DataCenter, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and DataCenter.

@JvmName(name = "getMarketBoardCurrentData")
fun getMarketBoardCurrentDataAsync(dataCenter: DataCenter, itemIds: IntArray, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<Multi<CurrentlyShown>>

Returns the data currently shown on the market board for the requested array of item IDs and DataCenter.

@JvmName(name = "getMarketBoardCurrentData")
fun getMarketBoardCurrentDataAsync(region: Region, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and Region.

@JvmName(name = "getMarketBoardCurrentData")
fun getMarketBoardCurrentDataAsync(region: Region, itemIds: IntArray, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<Multi<CurrentlyShown>>

Returns the data currently shown on the market board for the requested array of item IDs and Region.

@JvmName(name = "getMarketBoardCurrentData")
fun getMarketBoardCurrentDataAsync(world: World, itemId: Int, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<CurrentlyShown>

Returns the data currently shown on the market board for the requested item ID and World.

@JvmName(name = "getMarketBoardCurrentData")
fun getMarketBoardCurrentDataAsync(world: World, itemIds: IntArray, listings: Int? = null, entries: Int? = null, noGst: Boolean? = null, hq: Boolean? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<Multi<CurrentlyShown>>

Returns the data currently shown on the market board for the requested IntArray of item IDs and World.

Link copied to clipboard
suspend fun getMarketBoardSaleHistory(dataCenter: DataCenter, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): History

Returns the history data for the requested item ID and DataCenter.

suspend fun getMarketBoardSaleHistory(dataCenter: DataCenter, itemIds: IntArray, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<History>

Returns the history data for the requested array of item IDs and DataCenter.

suspend fun getMarketBoardSaleHistory(region: Region, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): History

Returns the history data for the requested item ID and Region.

suspend fun getMarketBoardSaleHistory(region: Region, itemIds: IntArray, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<History>

Returns the history data for the requested array of item IDs and Region.

suspend fun getMarketBoardSaleHistory(world: World, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): History

Returns the history data for the requested item ID and World.

suspend fun getMarketBoardSaleHistory(world: World, itemIds: IntArray, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Multi<History>

Returns the history data for the requested array of item IDs and World.

Link copied to clipboard
fun getMarketBoardSaleHistoryAsync(dataCenter: DataCenter, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<History>

Returns the history data for the requested item ID and DataCenter.

fun getMarketBoardSaleHistoryAsync(region: Region, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<History>

Returns the history data for the requested item ID and Region.

fun getMarketBoardSaleHistoryAsync(world: World, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): Promise<History>

Returns the history data for the requested item ID and World.

@JvmName(name = "getMarketBoardSaleHistory")
fun getMarketBoardSaleHistoryAsync(dataCenter: DataCenter, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<History>
@JvmName(name = "getMarketBoardSaleHistory")
fun getMarketBoardSaleHistoryAsync(dataCenter: DataCenter, itemIds: IntArray, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<Multi<History>>

Returns the history data for the requested array of item IDs and DataCenter.

@JvmName(name = "getMarketBoardSaleHistory")
fun getMarketBoardSaleHistoryAsync(region: Region, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<History>
@JvmName(name = "getMarketBoardSaleHistory")
fun getMarketBoardSaleHistoryAsync(region: Region, itemIds: IntArray, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<Multi<History>>

Returns the history data for the requested array of item IDs and Region.

@JvmName(name = "getMarketBoardSaleHistory")
fun getMarketBoardSaleHistoryAsync(world: World, itemId: Int, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<History>
@JvmName(name = "getMarketBoardSaleHistory")
fun getMarketBoardSaleHistoryAsync(world: World, itemIds: IntArray, entriesToReturn: Int? = null, statsWithin: Int? = null, entriesWithin: Int? = null): CompletableFuture<Multi<History>>

Returns the history data for the requested array of item IDs and World.

Link copied to clipboard
suspend fun getMarketTaxRates(world: World): Map<City, Byte>

Returns the current tax rate data for the specified World.

Link copied to clipboard
fun getMarketTaxRatesAsync(world: World): Promise<dynamic>

Returns the current tax rate data for the specified World.

@JvmName(name = "getMarketTaxRates")
fun getMarketTaxRatesAsync(world: World): CompletableFuture<Map<City, Byte>>

Returns the current tax rate data for the specified World.

Link copied to clipboard
suspend fun getMostRecentlyUpdatedItems(dataCenter: DataCenter, entries: Short? = null): RecentlyUpdatedItems

Returns the most-recently updated items on the specified DataCenter, along with the upload times for each item.

suspend fun getMostRecentlyUpdatedItems(world: World, entries: Short? = null): RecentlyUpdatedItems

Returns the most-recently updated items on the specified World, along with the upload times for each item.

Link copied to clipboard

Returns the most-recently updated items on the specified DataCenter, along with the upload times for each item.

Returns the most-recently updated items on the specified World, along with the upload times for each item.

@JvmName(name = "getMostRecentlyUpdatedItems")
fun getMostRecentlyUpdatedItemsAsync(dataCenter: DataCenter, entries: Short? = null): CompletableFuture<RecentlyUpdatedItems>

Returns the most-recently updated items on the specified DataCenter, along with the upload times for each item.

@JvmName(name = "getMostRecentlyUpdatedItems")
fun getMostRecentlyUpdatedItemsAsync(world: World, entries: Short? = null): CompletableFuture<RecentlyUpdatedItems>

Returns the most-recently updated items on the specified World, along with the upload times for each item.

Link copied to clipboard

Returns the total upload counts for each client application that uploads data to Universalis.

Link copied to clipboard

Returns the total upload counts for each client application that uploads data to Universalis.

@JvmName(name = "getUploadCountsByUploadApplication")
fun getUploadCountsByUploadApplicationAsync(): CompletableFuture<Array<SourceUploadCount>>

Returns the total upload counts for each client application that uploads data to Universalis.

Link copied to clipboard

Returns the world upload counts and proportions of the total uploads for each World.

Link copied to clipboard

Returns the world upload counts and proportions of the total uploads for each world.

Returns the world upload counts and proportions of the total uploads for each world.

Link copied to clipboard

Returns the number of uploads per day over the past 30 days.

Link copied to clipboard

Returns the number of uploads per day over the past 30 days.

Returns the number of uploads per day over the past 30 days.