Skip to content

25Karma/expressapi

Repository files navigation

25Karma API

An Express REST API for 25Karma.

Installation

Follow the installation instructions located here.

Endpoints

slug can be the player's username or UUID.

/achievements/slug

Get the information about a player's achievements.

Example: /achievements/Technoblade

{
    "success": true,
    "slug": "Technoblade",
    "mojang": { ... },
    "player": { ... }
}

/cache/slug

Returns the value of the key if it exists in the cache. Returns null if it does not.

Example: /cache/Technoblade

{
    "username": "Technoblade",
    "uuid": "b876ec32-e396-476b-a115-8438d83c67d4",
    "rank": "YOUTUBER",
    "packageRank": "MVP_PLUS",
    "prefix": "§d[PIG§b+++§d]",
    "rankPlusColor": "DARK_PURPLE"
}

/guild/slug

Get the information about a player's guild.

Example: /guild/Technoblade

{
    "success": true,
    "slug": "Technoblade",
    "mojang": { ... },
    "guild": { ... },
    "names": { ... }
}

/name/slug

The name and rank information about a player.

Example: /name/Technoblade

{
    "success": true,
    "slug": "Technoblade",
    "name": { ... }
}

/player/slug

Get all the information about a player.

Example: /player/Technoblade

{
    "success": true,
    "slug": "Technoblade",
    "mojang": { ... },
    "player": { ... },
    "status": { ... },
    "guild": { ... }
}

/pets/slug

Get the information about a player's pets.

Example: /pets/Technoblade

{
    "success": true,
    "slug": "Technoblade",
    "mojang": { ... },
    "player": { ... }
}

/quests/slug

Get the information about a player's quests.

Example: /quests/Technoblade

{
    "success": true,
    "slug": "Technoblade",
    "mojang": { ... },
    "player": { ... }
}