| Name | Type | Deprecated | Secure | Description |
|---|---|---|---|---|
| Command.Auction.Analyze | function | Requests auction statistics from the server. The results will be sent to Event.Auction.Statistics... | ||
| Command.Auction.Bid | function | Bids or buys out an auction. | ||
| Command.Auction.Cancel | function | Cancels an auction. | ||
| Command.Auction.Fulfill | function | Fulfills an existing buy order. | ||
| Command.Auction.Order | function | Posts a new buy order. | ||
| Command.Auction.Post | function | Posts a new auction. | ||
| Command.Auction.Scan | function | Requests an auction house scan. For type "search", if "index" is omitted then this function will ... | ||
| Event.Auction.Scan | Signals incoming auction data. | |||
| Event.Auction.Statistics | Signals receipt of auction statistics. | |||
| Inspect.Auction.Detail | function | Provides detailed information about auctions. | ||
| Utility.Auction.Cost | function | deprecated | Returns the amount of silver it will cost to post a given auction. | |
| Utility.Auction.CostOrder | function | Returns the amount of silver it will cost to post a given order. | ||
| Utility.Auction.CostPost | function | Returns the amount of silver it will cost to post a given auction. |
Requests auction statistics from the server. The results will be sent to Event.Auction.Statistics. This command is throttled by the "auctionanalyze" throttle type, proportional to the number of days requested.
Interaction category: auction
| Command.Auction.Analyze(itemtype, begin, end) | |||
| Command.Auction.Analyze(itemtype, begin, end, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| begin | parameter | number | UNIX timestamp to begin analysis at. |
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| end | parameter | number | UNIX timestamp to end analysis at. |
| itemtype | parameter | itemtype | Item type to analyze. |
Bids or buys out an auction.
Interaction category: auction
Throttled.
| Command.Auction.Bid(auction, bid) | |||
| Command.Auction.Bid(auction, bid, quantity) | |||
| Command.Auction.Bid(auction, bid, callback) | |||
| Command.Auction.Bid(auction, bid, quantity, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| auction | parameter | auction | The auction to be targeted. |
| bid | parameter | number | The amount to bid. To place a buyout, simply bid the buyout value. |
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| quantity | parameter | number | How many items to purchase. If omitted, defaults to the entire auction quantity. |
Cancels an auction.
Interaction category: auction
Throttled.
| Command.Auction.Cancel(auction) | |||
| Command.Auction.Cancel(auction, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| auction | parameter | auction | The auction to be targeted. |
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
Fulfills an existing buy order.
Interaction category: auction
Throttled.
| Command.Auction.Fulfill(auction, item, quantity) | |||
| Command.Auction.Fulfill(auction, item, quantity, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| auction | parameter | auction | The auction to be targeted. |
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| item | parameter | item | The ID of the item to be taken. |
| quantity | parameter | number | Stack size to fulfill. |
Posts a new buy order.
Interaction category: auction
Throttled.
| Command.Auction.Order(itemtype, quantity, time, buyout) | |||
| Command.Auction.Order(itemtype, quantity, time, buyout, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| buyout | parameter | number | The total buyout for the new auction, in silver. Must be evenly divisible by quantity. |
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| itemtype | parameter | itemtype | The item type to be ordered. |
| quantity | parameter | number | The number of items to be ordered. |
| time | parameter | number | The duration that the order should last, in hours. Valid values are limited to 12, 24, and 48. |
Posts a new auction.
Interaction category: auction
Throttled.
| Command.Auction.Post(item, time, bid, buyout) | |||
| Command.Auction.Post(item, time, bid, buyout, partial) | |||
| Command.Auction.Post(item, time, bid, buyout, callback) | |||
| Command.Auction.Post(item, time, bid, buyout, partial, callback) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| bid | parameter | number/nil | The minimum bid for the new auction, in silver. nil if no bid is desired. |
| buyout | parameter | number/nil | The buyout for the new auction, in silver. nil if no buyout is desired. |
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| item | parameter | item | The ID of the item to be auctioned. |
| partial | parameter | boolean | Whether partial buyouts should be permitted. Must be "false" if a buyout is not provided or if a bid is provided that is different from the buyout. If this parameter is omitted, will default to "true" when possible, or "false" otherwise. |
| time | parameter | number | The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48. |
Requests an auction house scan. For type "search", if "index" is omitted then this function will error if the "auctionfullscan" queue is not ready. Type "search" with "index" will throttle on the "auction" command queue. Other types throttle on the "global" command queue.
Interaction category: auction
| Command.Auction.Scan(parameters) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| parameters | parameter | table | Table containing data about the requested scan. type: Type of scan to perform. One of "bids", "buy", "mine", "orders", or "search". If type is "bids", "mine", or "orders", no other parameters are allowed. If type is "search": 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", "warrior", or "primalist". Optional. statType: Which stat to filter based on. One of "armor", "block", "critPower", "critSpell", "dexterity", "dodge", "endurance", "health", "hit", "intelligence", "mana", "powerAttack", "powerSpell", "resistAir", "resistDeath", "resistEarth", "resistFire", "resistLife", "resistWater", "strength", or "wisdom". Optional. If provided, statMin and statMax must also be provided. statMax: Maximum allowed value for the filter stat. Optional. If provided, statType and statMin must also be provided. statMin: Minimum allowed value for the filter stat. Optional. If provided, statType and statMax must also be provided. 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", "buy", "mine", or "bids". If "mine" or "bids", must be the only member in the table. If type is "buy": category: Category to search for. Same as the "category" member returned by Inspect.Item.Detail(). Optional. text: A string to search for in the item name. Optional. |
Signals incoming auction data.
| Event.Auction.Scan(type, auctions) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| auctions | parameter | <nope> | A table of the auctions returned from this scan. |
| type | parameter | variant | A table containing information on this scan. In the same format as the parameter to Command.Auction.Scan(). |
Signals receipt of auction statistics.
| Event.Auction.Statistics(itemtype, data) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| data | parameter | <nope> | Table containing a series of tables with different timestamps, each containing data for a single day. |
| itemtype | parameter | variant | Item type that the attached statistics refer to. |
| priceAverage | Average item price during this day. |
|---|---|
| priceMax | Maximum item price during this day. |
| priceMin | Minimum item price during this day. |
| priceVariance | Variance in item price during this day. |
| time | UNIX timestamp of the day. |
| volume | Quantity of items traded during this day. |
Provides detailed information about auctions.
Interaction category: auction
| detail = Inspect.Auction.Detail(auction) | |||
| details = Inspect.Auction.Detail(auctions) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| auction | parameter | auction | An identifier for the auction to retrieve detail for. |
| auctions | parameter | table | A table containing auction identifiers to retrieve details for. The value is the sort order. |
| detail | result | table | Detail table for a single auction. |
| details | result | table | Detail tables for all requested auctions. The key is the auction ID, the value is the auction's detail table. |
| 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. |
| partial | Whether partial buyouts are permitted. |
| remaining | Time remaining in the auction, as a number of seconds. |
| seller | The name of the auction's seller. |
Returns the amount of silver it will cost to post a given auction.
| cost = Utility.Auction.Cost(item, time, bid, buyout) | |||
| cost = Utility.Auction.Cost(item, time, bid, buyout, partial) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| bid | parameter | number/nil | The minimum bid for the new auction, in silver. nil if no bid is desired. |
| buyout | parameter | number/nil | The buyout for the new auction, in silver. nil if no buyout is desired. |
| item | parameter | item | The ID of the item to be auctioned. |
| partial | parameter | boolean | Whether partial buyouts should be permitted. Must be "false" if a buyout is not provided or if a bid is provided that is different from the buyout. If this parameter is omitted, will default to "true" when possible, or "false" otherwise. |
| time | parameter | number | The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48. |
| cost | result | number | The cost of posting this auction, in silver. |
Returns the amount of silver it will cost to post a given order.
| cost = Utility.Auction.CostOrder(itemtype, quantity, time, buyout) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| buyout | parameter | number | The total buyout for the new auction, in silver. Must be evenly divisible by quantity. |
| itemtype | parameter | itemtype | The item type to be ordered. |
| quantity | parameter | number | The number of items to be ordered. |
| time | parameter | number | The duration that the order should last, in hours. Valid values are limited to 12, 24, and 48. |
| cost | result | number | The cost of posting this order, in silver. Includes the full deposit for the items. |
Returns the amount of silver it will cost to post a given auction.
| cost = Utility.Auction.CostPost(item, time, bid, buyout) | |||
| cost = Utility.Auction.CostPost(item, time, bid, buyout, partial) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| bid | parameter | number/nil | The minimum bid for the new auction, in silver. nil if no bid is desired. |
| buyout | parameter | number/nil | The buyout for the new auction, in silver. nil if no buyout is desired. |
| item | parameter | item | The ID of the item to be auctioned. |
| partial | parameter | boolean | Whether partial buyouts should be permitted. Must be "false" if a buyout is not provided or if a bid is provided that is different from the buyout. If this parameter is omitted, will default to "true" when possible, or "false" otherwise. |
| time | parameter | number | The duration that the auction should last, in hours. Valid values are limited to 12, 24, and 48. |
| cost | result | number | The cost of posting this auction, in silver. |