Back to index...

NameTypeDeprecatedSecureDescription
Command.Auction.BidfunctionBids on an auction.
Command.Auction.CancelfunctionCancels an auction.
Command.Auction.PostfunctionPosts a new auction.
Command.Auction.ScanfunctionRequests an auction house scan. If "index" is omitted then this function will error if the "aucti...
Event.Auction.ScanSignals incoming auction data.
Inspect.Auction.DetailfunctionProvides detailed information about auctions.
Utility.Auction.CostfunctionReturns the amount of silver it will cost to post a given auction.

Command.Auction.Bid

Bids on an auction.

Usage:

Interaction category: auction

Command.Auction.Bid(auction, bid)
Command.Auction.Bid(auction, bid, callback)
ParameterTypeDatatypeDescription
auctionparameterauctionThe auction to be targeted.
bidparameternumberThe amount to bid. To place a buyout, simply bid the buyout value.
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
hardwareevent
true

Command.Auction.Cancel

Cancels an auction.

Usage:

Interaction category: auction

Command.Auction.Cancel(auction)
Command.Auction.Cancel(auction, callback)
ParameterTypeDatatypeDescription
auctionparameterauctionThe auction to be targeted.
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
hardwareevent
true

Command.Auction.Post

Posts a new auction.

Usage:

Interaction category: auction

Throttled.

Command.Auction.Post(item, time, bid, buyout)
Command.Auction.Post(item, time, bid, buyout, callback)
ParameterTypeDatatypeDescription
bidparameternumberThe minimum bid for the new auction, in silver.
buyoutparameternumber/nilThe buyout for the new auction, in silver. nil if no buyout is desired.
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
itemparameteritemThe ID of the item to be auctioned.
timeparameternumberThe duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.

Command.Auction.Scan

Requests an auction house scan. If "index" is omitted then this function will error if the "auctionfullscan" queue is not ready. Otherwise, this function is subject to the "global" command queue.

Usage:

Interaction category: auction

Command.Auction.Scan(parameters)
ParameterTypeDatatypeDescription
parametersparametertableTable containing data about the requested scan.
category: Category to search for. Same as the "category" member returned by Inspect.Item.Detail(). Optional.
index: Numeric item index to start the scan at. If provided, the auction scan will return the first 50 items immediately following this index.
levelMax: Maximum level the item must require. Optional.
levelMin: Minimum level the item must require. Optional.
priceMax: Maximum price of the item. Optional.
priceMin: Minimum price of the item. Optional.
rarity: The minimum rarity to search for. Same as the "rarity" member returned by Inspect.Item.Detail(). Optional.
role: The role that the item must be compatible with. One of "mage", "rogue", "cleric", or "warrior". Optional.
sort: Which column the requested items should be sorted based on. One of "rarity", "name", "level", "time", "seller", "pricePerUnit", "bid", "buyout", "stack". Optional.
sortOrder: What order to sort in. One of "ascending" or "descending". Optional.
text: A string to search for in the item name. Optional.
type: Type of scan to perform. One of "search", "mine", or "bids". If "mine" or "bids", must be the only member in the table.
hardwareevent
true

Event.Auction.Scan

Signals incoming auction data.

Usage:

Event.Auction.Scan(type, auctions)
ParameterTypeDatatypeDescription
auctionsparameter<nope>A table of the auctions returned from this scan.
typeparametervariantA table containing information on this scan. In the same format as the parameter to Command.Auction.Scan().

Inspect.Auction.Detail

Provides detailed information about auctions.

Usage:

Interaction category: auction

detail = Inspect.Auction.Detail(auction)
details = Inspect.Auction.Detail(auctions)
ParameterTypeDatatypeDescription
auctionparameterauctionAn identifier for the auction to retrieve detail for.
auctionsparametertableA table containing auction identifiers to retrieve details for. The value is the sort order.
detailresulttableDetail table for a single auction.
detailsresulttableDetail tables for all requested auctions. The key is the auction ID, the value is the auction's detail table.
members
bid The current bid on this auction, in silver.
bidder Current high bidder on this auction. Available only if your current character is the bidder or the seller.
buyout The buyout amount for this auction, in silver.
id The ID of the requested element.
item ID of the item involved in the auction.
itemStack The size of this item stack.
itemType The item's type specifier.
seller The name of the auction's seller.
time Time remaining in the auction, as a string. Either "short", "medium", or "long".

Utility.Auction.Cost

Returns the amount of silver it will cost to post a given auction.

Usage:

cost = Utility.Auction.Cost(item, time, bid, buyout)
ParameterTypeDatatypeDescription
bidparameternumberThe minimum bid for the new auction, in silver.
buyoutparameternumber/nilThe buyout for the new auction, in silver. nil if no buyout is desired.
itemparameteritemThe ID of the item to be auctioned.
timeparameternumberThe duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48.
costresultnumberThe cost of posting this auction, in silver.

Back to index...