/api/playerauctions/getAuctionCategoryByName/{categoryname}

Retrieve an auction category information by the category name.

  • Parameters:

    • categoryname: The name of the category to retrieve.

  • Response:

    The response will return a JSON object with the following structure:

    {
      "minPrice" : -1.0,
      "maxPrice" : -1.0,
      "all" : true,
      "icon" : {
        "type" : "BOOK",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"All Auctions\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"yellow\"},{\"text\":\" to view all the auctions.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "PublicBukkitValues" : "{\n    \"playerauctions:itemtag_item\": \"1\"\n}"
        }
      },
      "name" : "all",
      "displayName" : "All"
    }

Fields:

  • minPrice (Number): The minimum price for the category.

  • maxPrice (Number): The maximum price for the category.

  • all (Boolean): Indicates if this category includes all items.

  • icon (Object): The icon details for the category.

    • type (String): The type of the icon (e.g., BOOK).

    • meta (Object): Metadata for the icon.

      • display-name (String): The JSON string representation of the display name.

      • lore (Array of Strings): Lore text to describe the icon.

      • PublicBukkitValues (String): A JSON string containing custom metadata for Bukkit.

  • name (String): The unique identifier for the category.

  • displayName (String): The display name of the category.

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?