C_BlackMarket.GetItemInfoByID

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

	C_BlackMarket.GetItemInfoByID		+ 5.0.4
	C_BlackMarket.GetItemInfoByIndex		+ 5.0.4
	C_BlackMarket.GetHotItem		+ 5.0.4

Returns info for a Black Market auction.

name, texture, quantity, itemType, usable, level, levelType, sellerName, minBid, minIncrement, currBid, youHaveHighBid, numBids, timeLeft, link, marketID, quality
  = C_BlackMarket.GetItemInfoByID(marketID)
  = C_BlackMarket.GetItemInfoByIndex(index)
  = C_BlackMarket.GetHotItem()

You can use GetHotItem to retrieve information about a "Hot Item!" auction picked by the server, GetItemInfoByIndex to iterate through all auctions, and GetItemInfoByID to retrieve information about specific auctions. These three functions have identical return values.

Arguments

GetItemInfoByID

marketID

number - black market auction ID.

GetItemInfoByIndex

index

number - black market auction index, ascending from 1 to C_BlackMarket.GetNumItems()

Returns

name

string - item name; nil if no such auction exists.

texture

string - icon texture path.

quantity

number - amount of the item included in the auction.

itemType

string - item type, e.g. "Quest", "Mail", or "Companion Pet"

usable

boolean

level

number - item level requirement.

levelType

string - e.g. "REQ_LEVEL_ABBR"

sellerName

string - localized name of the NPC "selling" the item.

minBid

number - minimum amount of copper you can bid for this item.

minIncrement

number - minimum amount of copper you must increase the current bid by.

currBid

number - the maximum current bid in copper.

youHaveHighBid

boolean - true if your bid on this item is currently the highest bid, false otherwise.

numBids

number - number of bids made on this item.

timeLeft

number - token indicating remaining auction duration, 0 for completed auctions, larger values indicate larger remaining durations. For a localized text version, use _G["AUCTION_TIME_LEFT" .. timeLeft].

link

string - Chat link of the item being auctioned.

marketID

number - Black Market auction ID of this auction.

quality

number

Details

• These functions will only return information when the black market UI is open (according to the server, i.e. BLACK_MARKET_OPEN has fired, and BLACK_MARKET_CLOSE has not fired since).
• You may refresh available information by calling C_BlackMarket.RequestItems; BLACK_MARKET_ITEM_UPDATE fires to indicate that the return values of these functions may have changed.

Patch changes

• Patch 5.0.4 (2012-08-28): Added.