Ctrlk
HomeDiscord
For the complete documentation index, see llms.txt. This page is also available as Markdown.

/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:

    {
  "totalAuctions" : 3,
  "totalPages" : 1,
  "currentPage" : 1,
  "auctions" : [ {
    "randomSort" : 0,
    "originalPrice" : 1000.0,
    "internalCurrency" : null,
    "auctionPlayer" : {
      "logs" : [ ],
      "backpack" : [ ],
      "staticAuctions" : 0,
      "blacklistedPlayers" : [ ],
      "madeOffline" : [ ],
      "maximumAuctions" : 9223372036854775807,
      "prettyMaximumAuctions" : "Unlimited",
      "sellPrice" : 500.0,
      "uuid" : "5ca251ab-589d-4f04-8f0c-28404d0686b0",
      "messages" : [ ],
      "name" : "ForgotUrPassword",
      "language" : null
    },
    "auctionCategories" : [ {
      "minPrice" : -1.0,
      "maxPrice" : -1.0,
      "all" : false,
      "icon" : {
        "type" : "DIRT",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Blocks\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"yellow\"},{\"text\":\" to view all the blocks.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "PublicBukkitValues" : "{\n    \"playerauctions:itemtag_item\": \"1\"\n}"
        }
      },
      "name" : "blocks",
      "displayName" : "Blocks"
    } ],
    "bidder" : null,
    "price" : 1000.0,
    "bidding" : false,
    "auctionDate" : 1736121811679,
    "expireTime" : 172799000,
    "auctionServer" : "PA_SERVER",
    "itemAmount" : 64,
    "uuid" : "5ca251ab-589d-4f04-8f0c-28404d0686b0",
    "world" : "world",
    "unlimited" : false,
    "currency" : {
      "integrated" : false,
      "version" : "1.1.0-pre2",
      "minPricePurchaseAmount" : -1.0,
      "minPriceSellAmount" : 1000.0,
      "maxPriceSellAmount" : 9999999.0,
      "minPriceBidAmount" : 1000.0,
      "name" : "Vault Currency",
      "enabled" : true,
      "currencyName" : "money",
      "internalCurrencies" : [ ]
    },
    "id" : 1,
    "item" : {
      "type" : "DIRT",
      "amount" : 64
    }
  }, {
    "randomSort" : 0,
    "originalPrice" : 5000.0,
    "internalCurrency" : null,
    "auctionPlayer" : {
      "logs" : [ ],
      "backpack" : [ ],
      "staticAuctions" : 0,
      "blacklistedPlayers" : [ ],
      "madeOffline" : [ ],
      "maximumAuctions" : 9223372036854775807,
      "prettyMaximumAuctions" : "Unlimited",
      "sellPrice" : 500.0,
      "uuid" : "5ca251ab-589d-4f04-8f0c-28404d0686b0",
      "messages" : [ ],
      "name" : "ForgotUrPassword",
      "language" : null
    },
    "auctionCategories" : [ {
      "minPrice" : -1.0,
      "maxPrice" : -1.0,
      "all" : false,
      "icon" : {
        "type" : "DIAMOND_PICKAXE",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Tools\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"yellow\"},{\"text\":\" to view all the tools.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "attribute-modifiers" : { },
          "ItemFlags" : [ "HIDE_ATTRIBUTES" ],
          "PublicBukkitValues" : "{\n    \"playerauctions:itemtag_item\": \"1\"\n}"
        }
      },
      "name" : "tools",
      "displayName" : "Tools"
    } ],
    "bidder" : null,
    "price" : 5000.0,
    "bidding" : false,
    "auctionDate" : 1736121853583,
    "expireTime" : 172799000,
    "auctionServer" : "PA_SERVER",
    "itemAmount" : 1,
    "uuid" : "5ca251ab-589d-4f04-8f0c-28404d0686b0",
    "world" : "world",
    "unlimited" : false,
    "currency" : {
      "integrated" : false,
      "version" : "1.1.0-pre2",
      "minPricePurchaseAmount" : -1.0,
      "minPriceSellAmount" : 1000.0,
      "maxPriceSellAmount" : 9999999.0,
      "minPriceBidAmount" : 1000.0,
      "name" : "Vault Currency",
      "enabled" : true,
      "currencyName" : "money",
      "internalCurrencies" : [ ]
    },
    "id" : 2,
    "item" : {
      "type" : "DIAMOND_SWORD"
    }
  }, {
    "randomSort" : 0,
    "originalPrice" : 50000.0,
    "internalCurrency" : null,
    "auctionPlayer" : {
      "logs" : [ ],
      "backpack" : [ ],
      "staticAuctions" : 0,
      "blacklistedPlayers" : [ ],
      "madeOffline" : [ ],
      "maximumAuctions" : 9223372036854775807,
      "prettyMaximumAuctions" : "Unlimited",
      "sellPrice" : 500.0,
      "uuid" : "5ca251ab-589d-4f04-8f0c-28404d0686b0",
      "messages" : [ ],
      "name" : "ForgotUrPassword",
      "language" : null
    },
    "auctionCategories" : [ {
      "minPrice" : -1.0,
      "maxPrice" : -1.0,
      "all" : false,
      "icon" : {
        "type" : "DIAMOND_HELMET",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Armor\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"yellow\"},{\"text\":\" to view all the armor.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "attribute-modifiers" : { },
          "ItemFlags" : [ "HIDE_ATTRIBUTES" ],
          "PublicBukkitValues" : "{\n    \"playerauctions:itemtag_item\": \"1\"\n}"
        }
      },
      "name" : "armor",
      "displayName" : "Armor"
    } ],
    "bidder" : null,
    "price" : 50000.0,
    "bidding" : false,
    "auctionDate" : 1736121916482,
    "expireTime" : 172799000,
    "auctionServer" : "PA_SERVER",
    "itemAmount" : 1,
    "uuid" : "5ca251ab-589d-4f04-8f0c-28404d0686b0",
    "world" : "world",
    "unlimited" : false,
    "currency" : {
      "integrated" : false,
      "version" : "1.1.0-pre2",
      "minPricePurchaseAmount" : -1.0,
      "minPriceSellAmount" : 1000.0,
      "maxPriceSellAmount" : 9999999.0,
      "minPriceBidAmount" : 1000.0,
      "name" : "Vault Currency",
      "enabled" : true,
      "currencyName" : "money",
      "internalCurrencies" : [ ]
    },
    "id" : 3,
    "item" : {
      "type" : "DIAMOND_CHESTPLATE",
      "meta" : {
        "enchants" : {
          "minecraft:mending" : 1,
          "minecraft:protection" : 5,
          "minecraft:unbreaking" : 3
        }
      }
    }
  } ]
}

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.

Previous/api/playerauctions/getRecentAuctionsByUUID/{page}
Next/api/playerauctions/getAuctionCategoryByName/{categoryname}

Last updated