get
Returns the data currently shown on the market board for the requested item ID and World.
This function is designed to be used from JavaScript. For use within Kotlin, see getMarketBoardCurrentData.
Parameters
The World to retrieve data for.
The item ID to retrieve data for.
The number of listings to return. By default, all listings will be returned.
The number of recent history entries to return. By default, a maximum of 5 entries will be returned.
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.
The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
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.
Returns the data currently shown on the market board for the requested item ID and DataCenter.
This function is designed to be used from JavaScript. For use within Kotlin, see getMarketBoardCurrentData.
Parameters
The DataCenter to retrieve data for.
The item ID to retrieve data for.
The number of listings to return. By default, all listings will be returned.
The number of recent history entries to return. By default, a maximum of 5 entries will be returned.
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.
The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
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.
Returns the data currently shown on the market board for the requested item ID and Region.
This function is designed to be used from JavaScript. For use within Kotlin, see getMarketBoardCurrentData.
Parameters
The Region to retrieve data for.
The item ID to retrieve data for.
The number of listings to return. By default, all listings will be returned.
The number of recent history entries to return. By default, a maximum of 5 entries will be returned.
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.
The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
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.
Returns the data currently shown on the market board for the requested item ID and World.
This function is designed to be used from non-Kotlin JVM languages. For use within Kotlin, see getMarketBoardCurrentData.
Parameters
The World to retrieve data for.
The item ID to retrieve data for.
The number of listings to return. By default, all listings will be returned.
The number of recent history entries to return. By default, a maximum of 5 entries will be returned.
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.
The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
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.
Returns the data currently shown on the market board for the requested item ID and DataCenter.
This function is designed to be used from non-Kotlin JVM languages. For use within Kotlin, see getMarketBoardCurrentData.
Parameters
The DataCenter to retrieve data for.
The item ID to retrieve data for.
The number of listings to return. By default, all listings will be returned.
The number of recent history entries to return. By default, a maximum of 5 entries will be returned.
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.
The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
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.
Returns the data currently shown on the market board for the requested item ID and Region.
This function is designed to be used from non-Kotlin JVM languages. For use within Kotlin, see getMarketBoardCurrentData.
Parameters
The Region to retrieve data for.
The item ID to retrieve data for.
The number of listings to return. By default, all listings will be returned.
The number of recent history entries to return. By default, a maximum of 5 entries will be returned.
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.
The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
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.
Returns the data currently shown on the market board for the requested IntArray of item IDs and World.
This function is designed to be used from non-Kotlin JVM languages. For use within Kotlin, see getMarketBoardCurrentData.
Parameters
The World to retrieve data for.
The IntArray of item IDs to retrieve data for.
The number of listings to return. By default, all listings will be returned.
The number of recent history entries to return. By default, a maximum of 5 entries will be returned.
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.
The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
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.
Returns the data currently shown on the market board 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 getMarketBoardCurrentData.
Parameters
The DataCenter to retrieve data for.
The array of item IDs to retrieve data for.
The number of listings to return. By default, all listings will be returned.
The number of recent history entries to return. By default, a maximum of 5 entries will be returned.
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.
The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
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.
Returns the data currently shown on the market board 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 getMarketBoardCurrentData.
Parameters
The Region to retrieve data for.
The array of item IDs to retrieve data for.
The number of listings to return. By default, all listings will be returned.
The number of recent history entries to return. By default, a maximum of 5 entries will be returned.
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.
The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
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.