Last updated
Last updated
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:
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:
Based on server settings, you may not be able to access warp information if you do not own the warp.
is required to access this endpoint.
Retrieve a paginated list of player warps.