WoW:API QueryAuctionItems - Revision history

Move page script: Move page script moved page API QueryAuctionItems to WoW:API QueryAuctionItems without leaving a redirect

2023-08-15T04:47:04Z

Move page script moved page API QueryAuctionItems to API QueryAuctionItems without leaving a redirect

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

WoWWiki>Namestook: Removed quotes from name in function arguments

2018-09-02T16:25:22Z

Removed quotes from name in function arguments

Show changes

WoWWiki>Fandyllic: /* Arguments */

2017-05-08T21:45:29Z

Arguments

← Older revision		Revision as of 21:45, 8 May 2017
Line 11:		Line 11:
	:(string type, integer type, integer type, integer type, boolean type, integer type, integer type, integer type, integer type, boolean type)		:(string type, integer type, integer type, integer type, boolean type, integer type, integer type, integer type, integer type, boolean type)

	;name : A part of the item's name (or the complete name) or "" for no retrenchment. Must be 63 bytes or less.		:;name : A part of the item's name (or the complete name) or "" for no retrenchment. Must be 63 bytes or less.
	:;minLevel : Items below this level won't be returned. Either a number or nil for no restrictions.		:;minLevel : Items below this level won't be returned. Either a number or nil for no restrictions.
	:;maxLevel : Items above this level won't be returned. Either a number or nil for no restrictions.		:;maxLevel : Items above this level won't be returned. Either a number or nil for no restrictions.
Line 40:		Line 40:
	-- not filtering by category, leave nil for all		-- not filtering by category, leave nil for all
	end		end

	== Examples ==		== Examples ==
	QueryAuctionItems("", 10, 19, 0, nil, 0, false, nil)		QueryAuctionItems("", 10, 19, 0, nil, 0, false, nil)
Line 49:		Line 50:
	:also, the First page is page (0) zero		:also, the First page is page (0) zero

	/script QueryAuctionItems("Nobles", 0, 0, 0, nil, ~~false~~, false, nil)		/script QueryAuctionItems("Nobles", 0, 0, 0, nil, 3, false, nil)

	=== Result ===		=== Result ===

193.105.201.11: Core.lua:28: bad argument #6 to 'QueryAuctionItems' (number expected, got boolean)

2017-05-07T21:39:48Z

Core.lua:28: bad argument #6 to 'QueryAuctionItems' (number expected, got boolean)

← Older revision		Revision as of 21:39, 7 May 2017
Line 41:		Line 41:
	end		end
	== Examples ==		== Examples ==
	QueryAuctionItems("", 10, 19, 0, nil, ~~false~~, false, nil)		QueryAuctionItems("", 10, 19, 0, nil, 0, false, nil)

	=== Script ===		=== Script ===

WoWWiki>Fandyllic: keep pre-7.0.3 data around until 7.0.3 info is more complete

2016-07-25T20:50:45Z

keep pre-7.0.3 data around until 7.0.3 info is more complete

@@ Line 1: / Line 1: @@
 {{wowapi}}
@@ Line 7: / Line 8: @@
+  )
 == Arguments ==
 :(string type, integer type, integer type, integer type, boolean type, integer type, integer type, integer type, integer type, boolean type)
@@ Line 42: / Line 43: @@
   QueryAuctionItems("", 10, 19, 0, nil, false, false, nil)
-=== Result ===
+=== Script ===
 :Finds twink gear! (blue armor between lvl 10 and 19)
@@ Line 56: / Line 57: @@
 == Notes ==
 ;If name is longer than 63 bytes, you'll be disconnected from the server.
 :;If any of the entered arguments is of the wrong type, the search assumes a nil value.

212.112.153.155: Updated the function to new arguement structure of 7.0.3.

2016-07-24T18:54:09Z

Updated the function to new arguement structure of 7.0.3.

← Older revision		Revision as of 18:54, 24 July 2016
Line 3:		Line 3:
	Will return information about items in the auction house. There must be a delay of about 0.3 second between regular queries and 15 minutes between getall queries. Use [[API CanSendAuctionQuery\|CanSendAuctionQuery]]() to determine if a query can be done.		Will return information about items in the auction house. There must be a delay of about 0.3 second between regular queries and 15 minutes between getall queries. Use [[API CanSendAuctionQuery\|CanSendAuctionQuery]]() to determine if a query can be done.

	QueryAuctionItems("name", minLevel, maxLevel,		QueryAuctionItems("name", minLevel, maxLevel, page,
	~~invTypeIndex, classIndex, subclassIndex~~,		isUsable, qualityIndex, getAll, exactMatch, filterData
	~~page,~~ isUsable, qualityIndex, getAll
	)		)

	== Arguments ==		== Arguments ==
	:(string type, integer type, integer type, integer type, ~~integer~~ type, integer type, integer type, integer type, integer type, boolean type)		:(string type, integer type, integer type, integer type, boolean type, integer type, integer type, integer type, integer type, boolean type)

	:;name : A part of the item's name (or the complete name) or "" for no retrenchment. Must be 63 bytes or less.		;name : A part of the item's name (or the complete name) or "" for no retrenchment. Must be 63 bytes or less.
	:;minLevel : Items below this level won't be returned. Either a number or nil for no restrictions.		:;minLevel : Items below this level won't be returned. Either a number or nil for no restrictions.
	:;maxLevel : Items above this level won't be returned. Either a number or nil for no restrictions.		:;maxLevel : Items above this level won't be returned. Either a number or nil for no restrictions.
	~~:;invtypeIndex : Character's slotposition in which the item can be placed in. Can be one of the following values~~
	~~:::;1 - Head slot (INVTYPE_HEAD)~~
	~~:::;2 - Neck slot (INVTYPE_NECK)~~
	~~:::;3 - Shoulder slot (INVTYPE_SHOULDER)~~
	~~:::;4 - Shirt slot (INVTYPE_BODY)~~
	~~:::;5 - Chest slot (INVTYPE_CHEST)~~
	~~:::;6 - Waist slot (INVTYPE_WAIST)~~
	~~:::;7 - Leg slot (INVTYPE_LEGS)~~
	~~:::;8 - Feet slot (INVTYPE_FEET)~~
	~~:::;9 - Wrist slot (INVTYPE_WRIST)~~
	~~:::;10 - Hand slot (INVTYPE_HAND)~~
	~~:::;11 - Finger slot (INVTYPE_FINGER)~~
	~~:::;12 - Trinket slot (INVTYPE_TRINKET)~~
	~~:::;13 - Back slot (INVTYPE_CLOAK)~~
	~~:::;14 - Weapon offhand slot (INVTYPE_HOLDABLE)~~
	~~:::;15 - Weapon mainhand slot (INVTYPE_WEAPONMAINHAND)~~
	~~:::;16 - Robe slot (INVTYPE_ROBE)~~
	~~:::;17 - Tabard slot (INVTYPE_TABARD)~~
	~~:::;18 - Container slot (INVTYPE_BAG)~~
	~~:::;19 - 2handed weapon (takes two slots) (INVTYPE_2HWEAPON)~~
	~~:::;20 - Ranged weapon slot (INVTYPE_RANGED)~~
	~~:::;21 - Shield slot (INVTYPE_SHIELD)~~
	~~:::;22 - Both weapon slots (INVTYPE_WEAPON)~~
	~~:::;0 - no restrictions~~
	~~:;classIndex : Returns only item in this class. Integer corresponds to the row number of the table returned by [[API GetAuctionItemClasses\|GetAuctionItemClasses]]() or 0 for no restrictions.~~
	:;subclassIndex : Returns only items in this subclass. Integer corresponds to the row number of the table returned by [[API GetAuctionItemSubClasses\|GetAuctionItemSubClasses]](index) or 0 for no restrictions.
	:;page : What page in the auctionhouse this shows up. Note that pages start at 0.		:;page : What page in the auctionhouse this shows up. Note that pages start at 0.
	:;isUsable : Is useable by the player (1 = true, 0 = no restrictions)		:;isUsable : Is useable by the player (1 = true, 0 = no restrictions)
Line 52:		Line 25:


			:;exactMatch
			: Should the name be used as an exact match or should it match substrings of the auction items.
			:;filterData : The old invtypeIndex, classIndex, and subclassIndex roled into one.: This is the code that builds the filter value(s) for filterData:
			:
			local filterData;
			if categoryIndex and subCategoryIndex and subSubCategoryIndex then
			filterData = AuctionCategories[categoryIndex].subCategories[subCategoryIndex].subCategories[subSubCategoryIndex].filters;
			elseif categoryIndex and subCategoryIndex then
			filterData = AuctionCategories[categoryIndex].subCategories[subCategoryIndex].filters;
			elseif categoryIndex then
			filterData = AuctionCategories[categoryIndex].filters;
			else
			-- not filtering by category, leave nil for all
			end
	== Examples ==		== Examples ==
	QueryAuctionItems("", 10, 19, 0, 2, 0, 0, ~~0, 3, 0~~)		QueryAuctionItems("", 10, 19, 0, nil, false, false, nil)

	=== Result ===		=== Result ===
Line 61:		Line 48:
	:also, the First page is page (0) zero		:also, the First page is page (0) zero

	/script QueryAuctionItems("Nobles", 0, 0, 0, 0, 0, 0, ~~0, 0, 0~~)		/script QueryAuctionItems("Nobles", 0, 0, 0, nil, false, false, nil)

	=== Result ===		=== Result ===
Line 68:		Line 55:

	== Notes ==		== Notes ==
	:;If name is longer than 63 bytes, you'll be disconnected from the server.		;If name is longer than 63 bytes, you'll be disconnected from the server.
	~~:;invTypeIndex does not appear to work for values past 14~~.
	:;If any of the entered arguments is of the wrong type, the search assumes a nil value.		:;If any of the entered arguments is of the wrong type, the search assumes a nil value.

WoWWiki>Sturn: Updated with new information

2009-01-08T05:10:40Z

Updated with new information

← Older revision		Revision as of 05:10, 8 January 2009
Line 11:		Line 11:
	:(string type, integer type, integer type, integer type, integer type, integer type, integer type, integer type, integer type, boolean type)		:(string type, integer type, integer type, integer type, integer type, integer type, integer type, integer type, integer type, boolean type)

	:;name : A part of the item's name (or the complete name) or "" for no retrenchment.		:;name : A part of the item's name (or the complete name) or "" for no retrenchment. Must be 63 bytes or less.
	:;minLevel : Items below this level won't be returned. Either a number or nil for no restrictions.		:;minLevel : Items below this level won't be returned. Either a number or nil for no restrictions.
	:;maxLevel : Items above this level won't be returned. Either a number or nil for no restrictions.		:;maxLevel : Items above this level won't be returned. Either a number or nil for no restrictions.
Line 68:		Line 68:

	== Notes ==		== Notes ==
			:;If name is longer than 63 bytes, you'll be disconnected from the server.
	:;invTypeIndex does not appear to work for values past 14.		:;invTypeIndex does not appear to work for values past 14.
	:;If any of the entered arguments is of the wrong type, the search assumes a nil value.		:;If any of the entered arguments is of the wrong type, the search assumes a nil value.

WoWWiki>Parl2001: /* Example */

2008-12-21T18:37:56Z

Example

← Older revision		Revision as of 18:37, 21 December 2008
Line 52:		Line 52:


	== ~~Example~~ ==		== Examples ==
	QueryAuctionItems("", 10, 19, 0, 2, 0, 0, 0, 3, 0)		QueryAuctionItems("", 10, 19, 0, 2, 0, 0, 0, 3, 0)

Line 60:		Line 60:
	:		:
	:also, the First page is page (0) zero		:also, the First page is page (0) zero

			/script QueryAuctionItems("Nobles", 0, 0, 0, 0, 0, 0, 0, 0, 0)

			=== Result ===
			:Finds anything on the AH with the word 'Nobles' in it. Useful for hunting down that elusive last and final Darkmoon Card. :)
			:Hint: AH window has to be open before you click the macro.

	== Notes ==		== Notes ==
	:;invTypeIndex does not appear to work for values past 14.		:;invTypeIndex does not appear to work for values past 14.
	:;If any of the entered arguments is of the wrong type, the search assumes a nil value.		:;If any of the entered arguments is of the wrong type, the search assumes a nil value.

WoWWiki>Rothmic: getall is working now...

2008-08-08T20:20:22Z

getall is working now...

← Older revision		Revision as of 20:20, 8 August 2008
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}

	Will return information about items in the auction house. There must be a delay of about 3 second between queries. Use [[API CanSendAuctionQuery\|CanSendAuctionQuery]]() to determine if a query can be done.		Will return information about items in the auction house. There must be a delay of about 0.3 second between regular queries and 15 minutes between getall queries. Use [[API CanSendAuctionQuery\|CanSendAuctionQuery]]() to determine if a query can be done.

	QueryAuctionItems("name", "minLevel", "maxLevel",		QueryAuctionItems("name", minLevel, maxLevel,
	invTypeIndex, classIndex, subclassIndex,		invTypeIndex, classIndex, subclassIndex,
	page, isUsable, qualityIndex, getAll		page, isUsable, qualityIndex, getAll
Line 9:		Line 9:

	== Arguments ==		== Arguments ==
	:(string type, ~~string~~ type, ~~string~~ type, ~~index value~~, )		:(string type, integer type, integer type, integer type, integer type, integer type, integer type, integer type, integer type, boolean type)

	:;name : A part of the item's name (or the complete name) or "" for no retrenchment.		:;name : A part of the item's name (or the complete name) or "" for no retrenchment.
	:;minLevel : Items below this level won't be returned. Either a number or "" for no restrictions.		:;minLevel : Items below this level won't be returned. Either a number or nil for no restrictions.
	:;maxLevel : Items above this level won't be returned. Either a number or "" for no restrictions.		:;maxLevel : Items above this level won't be returned. Either a number or nil for no restrictions.
	:;invtypeIndex : Character's slotposition in which the item can be placed in. Can be one of the following values:		:;invtypeIndex : Character's slotposition in which the item can be placed in. Can be one of the following values
	:::;~~INVTYPE_HEAD :~~ Head slot		:::;1 - Head slot (INVTYPE_HEAD)
	:::;~~INVTYPE_NECK :~~ Neck slot		:::;2 - Neck slot (INVTYPE_NECK)
	:::;~~INVTYPE_SHOULDER :~~ Shoulder slot		:::;3 - Shoulder slot (INVTYPE_SHOULDER)
	:::;INVTYPE_BODY ~~: Body slot~~		:::;4 - Shirt slot (INVTYPE_BODY)
	:::;~~INVTYPE_CHEST :~~ Chest slot		:::;5 - Chest slot (INVTYPE_CHEST)
	:::;~~INVTYPE_WAIST :~~ Waist slot		:::;6 - Waist slot (INVTYPE_WAIST)
	:::;~~INVTYPE_LEGS :~~ Leg slot		:::;7 - Leg slot (INVTYPE_LEGS)
	:::;~~INVTYPE_FEET :~~ Feet slot		:::;8 - Feet slot (INVTYPE_FEET)
	:::;~~INVTYPE_WRIST :~~ Wrist slot		:::;9 - Wrist slot (INVTYPE_WRIST)
	:::;~~INVTYPE_HAND :~~ Hand slot		:::;10 - Hand slot (INVTYPE_HAND)
	:::;~~INVTYPE_FINGER :~~ Finger slot		:::;11 - Finger slot (INVTYPE_FINGER)
	:::;~~INVTYPE_TRINKET :~~ Trinket slot		:::;12 - Trinket slot (INVTYPE_TRINKET)
	:::;INVTYPE_CLOAK ~~: Cloak slot~~		:::;13 - Back slot (INVTYPE_CLOAK)
	:::;INVTYPE_HOLDABLE ~~: unknown~~		:::;14 - Weapon offhand slot (INVTYPE_HOLDABLE)
	:::;~~INVTYPE_WEAPONMAINHAND :~~ Weapon mainhand slot		:::;15 - Weapon mainhand slot (INVTYPE_WEAPONMAINHAND)
	:::;~~INVTYPE_ROBE :~~ Robe slot		:::;16 - Robe slot (INVTYPE_ROBE)
	:::;~~INVTYPE_TABARD :~~ Tabard slot		:::;17 - Tabard slot (INVTYPE_TABARD)
	:::;~~INVTYPE_BAG :~~ Container slot		:::;18 - Container slot (INVTYPE_BAG)
	:::;~~INVTYPE_2HWEAPON :~~ 2handed weapon (takes two slots)		:::;19 - 2handed weapon (takes two slots) (INVTYPE_2HWEAPON)
	:::;~~INVTYPE_RANGED :~~ Ranged weapon slot		:::;20 - Ranged weapon slot (INVTYPE_RANGED)
	:::;~~INVTYPE_SHIELD :~~ Shield slot		:::;21 - Shield slot (INVTYPE_SHIELD)
	:::;~~INVTYPE_WEAPON :~~ Both weapon slots		:::;22 - Both weapon slots (INVTYPE_WEAPON)
	:::;~~nil :~~ no restrictions		:::;0 - no restrictions
	:;classIndex : ~~Items not~~ in this class ~~won't be returned~~. ~~Index~~ corresponds to the ~~index~~ returned by [[API GetAuctionItemClasses\|GetAuctionItemClasses]]() or ~~nil~~ for no restrictions.		:;classIndex : Returns only item in this class. Integer corresponds to the row number of the table returned by [[API GetAuctionItemClasses\|GetAuctionItemClasses]]() or 0 for no restrictions.
	:;subclassIndex : ~~Items not~~ in this subclass ~~won't be returned~~. ~~Index~~ corresponds to the ~~index used in~~ [[API GetAuctionItemSubClasses\|GetAuctionItemSubClasses]](index) or ~~nil~~ for no restrictions.		:;subclassIndex : Returns only items in this subclass. Integer corresponds to the row number of the table returned by [[API GetAuctionItemSubClasses\|GetAuctionItemSubClasses]](index) or 0 for no restrictions.
	:;page : What page in the auctionhouse this shows up		:;page : What page in the auctionhouse this shows up. Note that pages start at 0.
	:;isUsable : Is useable by the player (~~nil~~ = no restrictions)		:;isUsable : Is useable by the player (1 = true, 0 = no restrictions)
	:;qualityIndex : ~~The items' quality~~ (~~nil = no restrictions~~)		:;qualityIndex : Can be one of the following values
	:;getAll : Download the ENTIRE auction house as one single page. Only allowed when [[API CanSendAuctionQuery\|CanSendAuctionQuery]]() returns true as its second return (~every 15 minutes). May disconnect people with low bandwidth. Also see notes on client-to-server traffic in [[API GetAuctionItemInfo\|GetAuctionItemInfo]]() (Added in 2.3~~) While this has been 'added'~~, ~~it is marked as [http://forums.worldofwarcraft.com/thread~~.~~html?topicId=879058320&sid=1 DISABLED UNTIL A FUTURE PATCH ] and does appear~~ to ~~do nothing~~.		:::;0 - No restriction
			:::;1 - Common Quality (white) or better
			:::;2 - Uncommon Quality (green) or better
			:::;3 - Rare Quality (blue) or better
			:::;4 - Epic Quality (purple) or better

			:;getAll : Download the ENTIRE auction house as one single page. Only allowed when [[API CanSendAuctionQuery\|CanSendAuctionQuery]]() returns true as its second return (~every 15 minutes). May disconnect people with low bandwidth. Also see notes on client-to-server traffic in [[API GetAuctionItemInfo\|GetAuctionItemInfo]]() (Added in 2.3, though initially disabled. Appears to be enabled as of 2.4)


	== Example ==		== Example ==
	QueryAuctionItems("",10, 19, "", 2, ~~nil~~, 0, ~~nil~~, 3)		QueryAuctionItems("", 10, 19, 0, 2, 0, 0, 0, 3, 0)

	=== Result ===		=== Result ===

	:Finds twink gear! (blue armor between lvl 10 and 19)		:Finds twink gear! (blue armor between lvl 10 and 19)
	:~~still unsure how to use the forth argument~~		:
	:also, the First page is page (0) zero		:also, the First page is page (0) zero

	== Notes ==		== Notes ==
			:;invTypeIndex does not appear to work for values past 14.
			:;If any of the entered arguments is of the wrong type, the search assumes a nil value.

WoWWiki>Calewyn: Note that getAll param doesn't actually do anything yet.

2008-05-31T13:10:49Z

Note that getAll param doesn't actually do anything yet.

← Older revision		Revision as of 13:10, 31 May 2008
Line 43:		Line 43:
	:;isUsable : Is useable by the player (nil = no restrictions)		:;isUsable : Is useable by the player (nil = no restrictions)
	:;qualityIndex : The items' quality (nil = no restrictions)		:;qualityIndex : The items' quality (nil = no restrictions)
	:;getAll : Download the ENTIRE auction house as one single page. Only allowed when [[API CanSendAuctionQuery\|CanSendAuctionQuery]]() returns true as its second return (~every 15 minutes). May disconnect people with low bandwidth. Also see notes on client-to-server traffic in [[API GetAuctionItemInfo\|GetAuctionItemInfo]]() (Added in 2.3)		:;getAll : Download the ENTIRE auction house as one single page. Only allowed when [[API CanSendAuctionQuery\|CanSendAuctionQuery]]() returns true as its second return (~every 15 minutes). May disconnect people with low bandwidth. Also see notes on client-to-server traffic in [[API GetAuctionItemInfo\|GetAuctionItemInfo]]() (Added in 2.3) While this has been 'added', it is marked as [http://forums.worldofwarcraft.com/thread.html?topicId=879058320&sid=1 DISABLED UNTIL A FUTURE PATCH ] and does appear to do nothing.