get
Returns the data currently shown on the market board for the requested list of item IDs and world or data center.
Parameters
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 中国.
List 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.
An list of fields that should be included in the response, if omitted will return all fields. For example if you're only interested in the listings price per unit you can set this to listings.pricePerUnit.
Throws
At least one and less than or equal to 100 item IDs are required.
The parameters are invalid.
The world/DC or item requested is invalid.
The Universalis API returned an unexpected return code.
Returns the data currently shown on the market board for the requested list of item IDs and world or data center.
Parameters
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 中国.
List 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.
An list of fields that should be included in the response, if omitted will return all fields. For example if you're only interested in the listings price per unit you can set this to listings.pricePerUnit.
Throws
At least one and less than or equal to 100 item IDs are required.
The parameters are invalid.
The world/DC or item requested is invalid.
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 world or data center.
Parameters
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 中国.
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.
An array of fields that should be included in the response, if omitted will return all fields. For example if you're only interested in the listings price per unit you can set this to listings.pricePerUnit.
Throws
At least one and less than or equal to 100 item IDs are required.
The parameters are invalid.
The world/DC or item requested is invalid.
The Universalis API returned an unexpected return code.