/api/playerauctions/getPlayerAuctions/{page}
Retrieve a paginated list of player auctions.
Parameters:
page: The page number to retrieve (for pagination).
Response:
The response will return a JSON object with the following structure:
Fields:
totalAuctions (Number): The total number of auctions available.
totalPages (Number): The total number of pages for the auctions.
currentPage (Number): The current page number being viewed.
auctions (Array): A list of auction items.
randomSort (Number): A random sort value for the auction.
originalPrice (Number): The original price of the auction item.
internalCurrency (Null): The internal currency value (null).
auctionPlayer (Object): Information about the player who created the auction.
logs (Array): A list of logs related to the player (empty array).
backpack (Array): A list of items in the player's backpack (empty array).
staticAuctions (Number): Number of static auctions allowed for the player.
blacklistedPlayers (Array): List of blacklisted players (empty array).
madeOffline (Array): A list of times the player was made offline (empty array).
maximumAuctions (Number): The maximum number of auctions the player can create.
prettyMaximumAuctions (String): Human-readable format of maximum auctions.
sellPrice (Number): The price at which the player can sell items.
uuid (String): The unique identifier for the player.
messages (Array): A list of messages related to the player (empty array).
name (String): The name of the player.
language (Null): The language of the player (null).
auctionCategories (Array): A list of auction categories.
minPrice (Number): The minimum price for the auction category.
maxPrice (Number): The maximum price for the auction category.
all (Boolean): Whether the category applies to all auctions.
icon (Object): The icon for the category.
type (String): The type of icon.
meta (Object): Metadata for the icon.
display-name (String): Display name for the category.
lore (Array of Strings): A list of lore descriptions.
PublicBukkitValues (String): A string representing public Bukkit values.
displayName (String): The name displayed for the auction category.
price (Number): The price of the auction item.
originalPrice (Number): The original price of the auction item.
currency (Object): Information about the currency used in the auction.
integrated (Boolean): Whether the currency is integrated into the auction.
version (String): The version of the currency system.
minPricePurchaseAmount (Number): The minimum purchase amount for the auction item.
minPriceSellAmount (Number): The minimum sell amount for the auction item.
maxPriceSellAmount (Number): The maximum sell amount for the auction item.
minPriceBidAmount (Number): The minimum bid amount for the auction item.
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 associated with the auction.
internalCurrency (Null or Object): The internal currency used, if applicable (null or object).
expireTime (Number): The expiration time of the auction item in milliseconds.
bidding (Boolean): Whether bidding is allowed for the auction.
randomSort (Number): A random value used to sort auctions.
world (String): The world associated with the auction.
auctionPlayer (Object): Details of the auction player (see above).
bidder (Null or Object): Information about the bidder, if applicable (null or object).
auctionDate (Number): The date when the auction was created, in milliseconds.
auctionServer (String): The server where the auction is hosted.
itemAmount (Number): The number of items listed in the auction.
unlimited (Boolean): Whether the auction has unlimited items.
item (Object): Details of the item being auctioned.
type (String): The type of the item.
amount (Number): The amount of the item being auctioned.
Note:
Authentication is required to access this endpoint.
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?