Requests data from the server for the list of auctions meeting given search criteria. If any search criterion is omitted or
nil, the search will include all possible values for that criterion.
Search queries are throttled, preventing abuse of the server by clients sending too many queries in short succession. Normal queries can be sent once every few seconds; mass queries return all results in the auction house instead of one "page" at a time, and can only be sent once every several minutes.
Query results are not returned immediately: the
AUCTION_ITEM_LIST_UPDATE event fires once data is available; listing information can then be retrieved using
GetAuctionItemInfo() or other Auction APIs.
See also Auction functions.
name- Full or partial item name to limit search results; will match any item whose name contains this string (
minLevel- Minimum required character level of items to limit search results (
maxLevel- Maximum required character level of items to limit search results (
invTypeIndex- Index of an item inventory type to limit search results (note that
GetAuctionInvTypes(classIndex, subClassIndex)returns a list of
token, displaypairs for each inventory type; thus, to convert a token index from that list for use here, divide by 2 and round up) (
classIndex- Index of an item class to limit search results (in the list returned by
subClassIndex- Index of an item subclass to limit search results (in the list returned by
page- Which "page" of search results to list, if more than
NUM_AUCTION_ITEMS_PER_PAGE(50) auctions are available; nil to query the first (or only) page (
isUsable- True to limit search results to only items which can be used or equipped by the player character; otherwise false (
minQuality- Minimum quality (rarity) level of items to limit search results (
getAll- True to perform a mass query (returning all listings at once); false to perform a normal query (returning a large number of listings in "pages" of
NUM_AUCTION_ITEMS_PER_PAGE at a time) (