ktuniversalis/cloud.drakon.ktuniversalis/getMarketBoardSaleHistoryAsync

getMarketBoardSaleHistoryAsync

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.

This function is designed to be used from JavaScript. For use within Kotlin, see getMarketBoardSaleHistory.

Parameters

world

The World to retrieve data for.

itemId

The item ID to retrieve data for.

entriesToReturn

The number of entries to return. By default, this is set to 1800, but may be set to a maximum of 999999.

statsWithin

The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.

entriesWithin

The amount of time before now to take entries within, in seconds. Negative values will be ignored.

Throws

The item requested is invalid.

The Universalis API returned an unexpected return code.

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.

This function is designed to be used from JavaScript. For use within Kotlin, see getMarketBoardSaleHistory.

Parameters

dataCenter

The DataCenter to retrieve data for.

itemId

The item ID to retrieve data for.

entriesToReturn

The number of entries to return. By default, this is set to 1800, but may be set to a maximum of 999999.

statsWithin

The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.

entriesWithin

The amount of time before now to take entries within, in seconds. Negative values will be ignored.

Throws

The item requested is invalid.

The Universalis API returned an unexpected return code.

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.

This function is designed to be used from JavaScript. For use within Kotlin, see getMarketBoardSaleHistory.

Parameters

region

The Region to retrieve data for.

itemId

The item ID to retrieve data for.

entriesToReturn

The number of entries to return. By default, this is set to 1800, but may be set to a maximum of 999999.

statsWithin

The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.

entriesWithin

The amount of time before now to take entries within, in seconds. Negative values will be ignored.

Throws

The item requested is invalid.

The Universalis API returned an unexpected return code.

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

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

This function is designed to be used from non-Kotlin JVM languages. For use within Kotlin, see getMarketBoardSaleHistory.

Parameters

world

The World to retrieve data for.

itemId

The array of item IDs to retrieve data for.

entriesToReturn

The number of entries to return. By default, this is set to 1800, but may be set to a maximum of 999999.

statsWithin

The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.

entriesWithin

The amount of time before now to take entries within, in seconds. Negative values will be ignored.

Throws

The item requested is invalid.

The Universalis API returned an unexpected return code.

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

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

This function is designed to be used from non-Kotlin JVM languages. For use within Kotlin, see getMarketBoardSaleHistory.

Parameters

dataCenter

The DataCenter to retrieve data for.

itemId

The array of item IDs to retrieve data for.

entriesToReturn

The number of entries to return. By default, this is set to 1800, but may be set to a maximum of 999999.

statsWithin

The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.

entriesWithin

The amount of time before now to take entries within, in seconds. Negative values will be ignored.

Throws

The item requested is invalid.

The Universalis API returned an unexpected return code.

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

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

This function is designed to be used from non-Kotlin JVM languages. For use within Kotlin, see getMarketBoardSaleHistory.

Parameters

region

The Region to retrieve data for.

itemId

The array of item IDs to retrieve data for.

entriesToReturn

The number of entries to return. By default, this is set to 1800, but may be set to a maximum of 999999.

statsWithin

The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.

entriesWithin

The amount of time before now to take entries within, in seconds. Negative values will be ignored.

Throws

The item requested is invalid.

The Universalis API returned an unexpected return code.

@JvmName(name = "getMarketBoardSaleHistory")
@JvmOverloads
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.

This function is designed to be used from non-Kotlin JVM languages. For use within Kotlin, see getMarketBoardSaleHistory.

Parameters

world

The World to retrieve data for.

itemIds

The array of item IDs to retrieve data for.

entriesToReturn

The number of entries to return. By default, this is set to 1800, but may be set to a maximum of 999999.

statsWithin

The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.

entriesWithin

The amount of time before now to take entries within, in seconds. Negative values will be ignored.

Throws

The Universalis API returned an unexpected return code.

@JvmName(name = "getMarketBoardSaleHistory")
@JvmOverloads
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.

This function is designed to be used from non-Kotlin JVM languages. For use within Kotlin, see getMarketBoardSaleHistory.

Parameters

dataCenter

The DataCenter to retrieve data for.

itemIds

The array of item IDs to retrieve data for.

entriesToReturn

The number of entries to return. By default, this is set to 1800, but may be set to a maximum of 999999.

statsWithin

The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.

entriesWithin

The amount of time before now to take entries within, in seconds. Negative values will be ignored.

Throws

The Universalis API returned an unexpected return code.

@JvmName(name = "getMarketBoardSaleHistory")
@JvmOverloads
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.

This function is designed to be used from non-Kotlin JVM languages. For use within Kotlin, see getMarketBoardSaleHistory.

Parameters

region

The Region to retrieve data for.

itemIds

The array of item IDs to retrieve data for.

entriesToReturn

The number of entries to return. By default, this is set to 1800, but may be set to a maximum of 999999.

statsWithin

The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.

entriesWithin

The amount of time before now to take entries within, in seconds. Negative values will be ignored.

Throws

The Universalis API returned an unexpected return code.