ktuniversalis/cloud.drakon.ktuniversalis/getMarketBoardCurrentData

getMarketBoardCurrentData

suspend fun getMarketBoardCurrentData(worldDcRegion: String, 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 or data center.

Parameters

worldDcRegion

The world, data center, or region to retrieve data for. This may be an ID or a name. Regions should be specified as Japan, Europe, North-America, Oceania, China, or 中国.

itemId

The item ID to retrieve data for.

listings

The number of listings to return. By default, all listings will be returned.

entries

The number of recent history entries to return. By default, a maximum of 5 entries will be returned.

noGst

If the result should not have Gil sales tax (GST) factored in. GST is applied to all consumer purchases in-game, and is separate from the retainer city tax that impacts what sellers receive. By default, GST is factored in.

Filter for HQ listings and entries. By default, both HQ and NQ listings and entries will be returned.

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

UniversalisException

The Universalis API returned an unexpected return code.

suspend fun getMarketBoardCurrentData(worldDcRegion: String, itemIds: List<Int>, 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 list of item IDs and world or data center.