/api/playerwarps/getPlayerWarps/{page}

Retrieve a paginated list of player warps.

Parameters:
- page: The page number to retrieve (for pagination).
- locked: Optional query parameter (true/false) to filter by locked warps. (Default false)

Response:

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

{
  "warps" : [ {
    "id" : 50,
    "warpName" : "testing",
    "warpLocation" : {
      "world" : "world",
      "x" : -1704.254518797315,
      "y" : 81.79549733866219,
      "z" : -90.22482751188485,
      "yaw" : -22.475004,
      "pitch" : 43.49976,
      "locationSafe" : false,
      "warpServer" : "N/A",
      "properLocation" : {
        "world" : "world",
        "x" : -1704.254518797315,
        "y" : 81.79549733866219,
        "z" : -90.22482751188485,
        "yaw" : -22.475004,
        "pitch" : 43.49976
      },
      "worldType" : "world"
    },
    "warpRate" : {
      "earnedRateRewards" : [ ],
      "rates" : { },
      "rateAverage" : 0.0,
      "totalRates" : 0,
      "playersRatedAmount" : 0
    },
    "warpCategory" : [ {
      "name" : "other",
      "teleportPrice" : -1.0,
      "purgeTime" : -1,
      "permission" : "",
      "removeDaysTime" : -1,
      "all" : false,
      "icon" : {
        "type" : "PAPER",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Other Warps\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"light_purple\"},{\"text\":\" to view all the other warps.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "PublicBukkitValues" : "{\n    \"playerwarps:itemtag_item\": \"1\"\n}"
        }
      },
      "displayName" : "Other"
    } ],
    "warpIcon" : {
      "warpIcon" : null
    },
    "warpRent" : {
      "warpLastRent" : 1735593109313,
      "warpNewRent" : 1735679509313
    },
    "warpVisit" : {
      "warpVisits" : 0,
      "purgedWarpVisits" : 0,
      "warpVisitedBoosted" : [ ],
      "warpVisited" : [ ]
    },
    "warpDate" : 1735593109313,
    "warpType" : "NORMAL",
    "warpCost" : null,
    "paid" : [ ],
    "banned" : [ ],
    "whitelisted" : [ ],
    "managers" : [ ],
    "whitelistEnabled" : false,
    "warpLocked" : false,
    "warpPassword" : null,
    "sponsorWarp" : null,
    "sponsorCooldown" : null,
    "randomSort" : 0,
    "warpPlayer" : {
      "uuid" : "5ca251ab-589d-4f04-8f0c-28404d0686b0",
      "messages" : [ ],
      "sponsorCooldown" : null,
      "staticWarps" : 0,
      "logs" : [ ],
      "earnedRateRewards" : [ ],
      "lastPlayed" : 1735593166487,
      "pendingWarp" : null,
      "maxWarpCostPrice" : 500.0,
      "minWarpCostPrice" : -1.0,
      "priceFreeLimit" : -1,
      "waitTeleportTime" : 3,
      "maximumWarps" : 9223372036854775807,
      "prettyMaximumWarps" : "Unlimited",
      "name" : "ForgotUrPassword",
      "language" : "en_gb"
    },
    "favoriteCount" : 0,
    "warpDisplayName" : "testing"
  }, {
    "id" : 51,
    "warpName" : "testing2",
    "warpLocation" : {
      "world" : "world",
      "x" : -1696.604230492617,
      "y" : 85.53986305993527,
      "z" : -71.72780318647382,
      "yaw" : -22.475004,
      "pitch" : 43.49976,
      "locationSafe" : false,
      "warpServer" : "N/A",
      "properLocation" : {
        "world" : "world",
        "x" : -1696.604230492617,
        "y" : 85.53986305993527,
        "z" : -71.72780318647382,
        "yaw" : -22.475004,
        "pitch" : 43.49976
      },
      "worldType" : "world"
    },
    "warpRate" : {
      "earnedRateRewards" : [ ],
      "rates" : { },
      "rateAverage" : 0.0,
      "totalRates" : 0,
      "playersRatedAmount" : 0
    },
    "warpCategory" : [ {
      "name" : "other",
      "teleportPrice" : -1.0,
      "purgeTime" : -1,
      "permission" : "",
      "removeDaysTime" : -1,
      "all" : false,
      "icon" : {
        "type" : "PAPER",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Other Warps\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"light_purple\"},{\"text\":\" to view all the other warps.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "PublicBukkitValues" : "{\n    \"playerwarps:itemtag_item\": \"1\"\n}"
        }
      },
      "displayName" : "Other"
    } ],
    "warpIcon" : {
      "warpIcon" : null
    },
    "warpRent" : {
      "warpLastRent" : 1735593112612,
      "warpNewRent" : 1735679512612
    },
    "warpVisit" : {
      "warpVisits" : 0,
      "purgedWarpVisits" : 0,
      "warpVisitedBoosted" : [ ],
      "warpVisited" : [ ]
    },
    "warpDate" : 1735593112612,
    "warpType" : "NORMAL",
    "warpCost" : null,
    "paid" : [ ],
    "banned" : [ ],
    "whitelisted" : [ ],
    "managers" : [ ],
    "whitelistEnabled" : false,
    "warpLocked" : false,
    "warpPassword" : null,
    "sponsorWarp" : null,
    "sponsorCooldown" : null,
    "randomSort" : 0,
    "warpPlayer" : {
      "uuid" : "5ca251ab-589d-4f04-8f0c-28404d0686b0",
      "messages" : [ ],
      "sponsorCooldown" : null,
      "staticWarps" : 0,
      "logs" : [ ],
      "earnedRateRewards" : [ ],
      "lastPlayed" : 1735593166489,
      "pendingWarp" : null,
      "maxWarpCostPrice" : 500.0,
      "minWarpCostPrice" : -1.0,
      "priceFreeLimit" : -1,
      "waitTeleportTime" : 3,
      "maximumWarps" : 9223372036854775807,
      "prettyMaximumWarps" : "Unlimited",
      "name" : "ForgotUrPassword",
      "language" : "en_gb"
    },
    "favoriteCount" : 0,
    "warpDisplayName" : "testing2"
  }, {
    "id" : 52,
    "warpName" : "testing3",
    "warpLocation" : {
      "world" : "world",
      "x" : -1694.8984907026872,
      "y" : 86.65745599778442,
      "z" : -67.60435649154357,
      "yaw" : -22.475004,
      "pitch" : 43.49976,
      "locationSafe" : false,
      "warpServer" : "N/A",
      "properLocation" : {
        "world" : "world",
        "x" : -1694.8984907026872,
        "y" : 86.65745599778442,
        "z" : -67.60435649154357,
        "yaw" : -22.475004,
        "pitch" : 43.49976
      },
      "worldType" : "world"
    },
    "warpRate" : {
      "earnedRateRewards" : [ ],
      "rates" : { },
      "rateAverage" : 0.0,
      "totalRates" : 0,
      "playersRatedAmount" : 0
    },
    "warpCategory" : [ {
      "name" : "other",
      "teleportPrice" : -1.0,
      "purgeTime" : -1,
      "permission" : "",
      "removeDaysTime" : -1,
      "all" : false,
      "icon" : {
        "type" : "PAPER",
        "meta" : {
          "display-name" : "{\"text\":\"\",\"extra\":[{\"text\":\"Other Warps\",\"obfuscated\":false,\"italic\":false,\"underlined\":false,\"strikethrough\":false,\"color\":\"aqua\",\"bold\":false}]}",
          "lore" : [ "{\"text\":\"\",\"extra\":[{\"text\":\"Click\",\"color\":\"light_purple\"},{\"text\":\" to view all the other warps.\",\"color\":\"aqua\"}],\"italic\":false}" ],
          "PublicBukkitValues" : "{\n    \"playerwarps:itemtag_item\": \"1\"\n}"
        }
      },
      "displayName" : "Other"
    } ],
    "warpIcon" : {
      "warpIcon" : null
    },
    "warpRent" : {
      "warpLastRent" : 1735593113763,
      "warpNewRent" : 1735679513763
    },
    "warpVisit" : {
      "warpVisits" : 0,
      "purgedWarpVisits" : 0,
      "warpVisitedBoosted" : [ ],
      "warpVisited" : [ ]
    },
    "warpDate" : 1735593113763,
    "warpType" : "NORMAL",
    "warpCost" : null,
    "paid" : [ ],
    "banned" : [ ],
    "whitelisted" : [ ],
    "managers" : [ ],
    "whitelistEnabled" : false,
    "warpLocked" : false,
    "warpPassword" : null,
    "sponsorWarp" : null,
    "sponsorCooldown" : null,
    "randomSort" : 0,
    "warpPlayer" : {
      "uuid" : "5ca251ab-589d-4f04-8f0c-28404d0686b0",
      "messages" : [ ],
      "sponsorCooldown" : null,
      "staticWarps" : 0,
      "logs" : [ ],
      "earnedRateRewards" : [ ],
      "lastPlayed" : 1735593166491,
      "pendingWarp" : null,
      "maxWarpCostPrice" : 500.0,
      "minWarpCostPrice" : -1.0,
      "priceFreeLimit" : -1,
      "waitTeleportTime" : 3,
      "maximumWarps" : 9223372036854775807,
      "prettyMaximumWarps" : "Unlimited",
      "name" : "ForgotUrPassword",
      "language" : "en_gb"
    },
    "favoriteCount" : 0,
    "warpDisplayName" : "testing3"
  } ],
  "totalPages" : 1,
  "currentPage" : 1,
  "totalWarps" : 3
}

Fields:

warps (Array of Warp objects):
- id (Number): The ID of the warp.
- warpName (String): The name of the warp.
- warpLocation (Object):
  - world (String): The world of the warp.
  - x (Number): The X coordinate.
  - y (Number): The Y coordinate.
  - z (Number): The Z coordinate.
  - yaw (Number): The yaw of the location.
  - pitch (Number): The pitch of the location.
  - locationSafe (Boolean): Whether the location is safe.
  - warpServer (String): The server of the warp (if applicable).
  - properLocation (Object):
    world (String): The world of the warp.
    x (Number): The X coordinate.
    y (Number): The Y coordinate.
    z (Number): The Z coordinate.
    yaw (Number): The yaw of the location.
    pitch (Number): The pitch of the location.
  - worldType (String): The type of the world.
- warpRate (Object):
  - earnedRateRewards (Array): List of rewards earned.
  - rates (Object): Contains rate information.
  - rateAverage (Number): The average rating.
  - totalRates (Number): Total number of ratings.
  - playersRatedAmount (Number): Number of players who rated.
- warpCategory (Array of Objects):
  - name (String): Category name.
  - teleportPrice (Number): Price to teleport.
  - purgeTime (Number): Time until purge.
  - permission (String): Required permission.
  - removeDaysTime (Number): Time until removal.
  - all (Boolean): Whether it includes all warps.
  - icon (Object):
    type (String): The type of the icon.
    meta (Object):
    display-name (String): The display name of the icon.
    lore (Array of Strings): Lore description.
    PublicBukkitValues (String): Custom Bukkit metadata.
  - displayName (String): Display name of the category.
- warpIcon (Object): Warp icon details.
- warpRent (Object):
  - warpLastRent (Number): Last rent timestamp.
  - warpNewRent (Number): New rent timestamp.
- warpVisit (Object):
  - warpVisits (Number): Number of visits.
  - purgedWarpVisits (Number): Visits purged.
  - warpVisitedBoosted (Array): List of boosted visits.
  - warpVisited (Array): List of visits.
- warpDate (Number): Warp creation date.
- warpType (String): Type of the warp.
- warpCost (Object): Cost details (if applicable).
- paid (Array): List of paid players.
- banned (Array): List of banned players.
- whitelisted (Array): List of whitelisted players.
- managers (Array): List of managers.
- whitelistEnabled (Boolean): Whether whitelist is enabled.
- warpLocked (Boolean): Whether the warp is locked.
- warpPassword (String): Password for the warp (if applicable).
- sponsorWarp (Object): Sponsor warp details.
- sponsorCooldown (Object): Sponsor cooldown details.
- randomSort (Number): Random sort value.
- warpPlayer (Object):
  - uuid (String): Player's UUID.
  - messages (Array): Messages for the player.
  - sponsorCooldown (Object): Sponsor cooldown details.
  - staticWarps (Number): Number of static warps.
  - logs (Array): Logs related to the warp.
  - earnedRateRewards (Array): Rewards earned.
  - lastPlayed (Number): Last played timestamp.
  - pendingWarp (Object): Pending warp details.
  - maxWarpCostPrice (Number): Maximum cost for warp.
  - minWarpCostPrice (Number): Minimum cost for warp.
  - priceFreeLimit (Number): Free price limit.
  - waitTeleportTime (Number): Wait time for teleport.
  - maximumWarps (Number): Maximum number of warps.
  - prettyMaximumWarps (String): Human-readable maximum warps.
  - name (String): Player's name.
  - language (String): Player's language.
- favoriteCount (Number): Number of favorites.
- warpDisplayName (String): Display name of the warp.
- totalPages (Number): Number of pages.
- currentPage (Number): Current page.
- totalWarps (Number): Total amount of warps on the server.

Note:

Authentication is required to access this endpoint.
Based on server settings, you may not be able to access warp information if you do not own the warp.

Previous/api/playerwarps/getPlayerWarpByID/{id}

Next/api/playerwarps/getWarpCategoryByName/{categoryname}

Last updated 1 year ago