/api/playerauctions/getPlayerAuctionByID/{id}
Retrieve an auction's information by its auction ID.
Parameters:
id: The ID of the auction to retrieve.
Response:
The response will return a JSON object with the following structure:
Fields:
id (Number): The unique identifier for this auction entry.
auctionCategories (Array): A list of auction categories.
name (String): The name of the category.
minPrice (Number): The minimum price for the category.
maxPrice (Number): The maximum price for the category.
all (Boolean): Whether all auctions are included.
icon (Object): The icon associated with the category.
type (String): The type of icon.
meta (Object): Metadata for the icon.
display-name (String): A formatted string for the display name.
lore (Array of Strings): A list of lore strings for the item.
PublicBukkitValues (String): A string containing public Bukkit values.
displayName (String): The display name for the category.
price (Number): The price of the auction item.
originalPrice (Number): The original price before any adjustments.
currency (Object): Information about the auction currency.
integrated (Boolean): Whether the currency is integrated.
version (String): The version of the currency system.
minPricePurchaseAmount (Number): The minimum price for purchasing.
minPriceSellAmount (Number): The minimum price for selling.
maxPriceSellAmount (Number): The maximum price for selling.
minPriceBidAmount (Number): The minimum bid amount.
name (String): The name of the currency
enabled (Boolean): Whether the currency is enabled.
currencyName (String): The name of the currency.
internalCurrencies (Array): A list of internal currencies.
internalCurrency (Null or Object): The internal currency used for the auction, if applicable.
expireTime (Number): The expiration time of the auction in milliseconds.
bidding (Boolean): Whether bidding is enabled for the auction.
randomSort (Number): A random sorting value for the auction.
world (String): The world associated with the auction.
auctionPlayer (Object): Information about the player who created the auction.
uuid (String): The unique identifier for the player.
messages (Array): A list of messages for the player.
madeOffline (Array): A list of times the player was made offline.
staticAuctions (Number): The number of static auctions for the player.
logs (Array): A list of logs for the player.
backpack (Array): A list of items in the player's backpack.
blacklistedPlayers (Array): A list of blacklisted players.
maximumAuctions (Number): The maximum number of auctions the player can create.
prettyMaximumAuctions (String): The human-readable version of the maximum auctions.
sellPrice (Number): The price at which the player sells items.
name (String): The name of the player.
language (Null or String): The language setting for the player.
bidder (Null or Object): Information about the bidder, if any.
auctionDate (Number): The auction creation date in milliseconds.
auctionServer (String): The server where the auction is hosted.
itemAmount (Number): The amount of items in the auction.
unlimited (Boolean): Whether the auction has unlimited items.
item (Object): The item being auctioned.
type (String): The type of the item.
amount (Number): The amount of the item being auctioned.
Note:
Based on server settings, you may not be able to access auction information if you do not own the auction.
Last updated
Was this helpful?