Hunter Data
Get Hunter data
Get all publicly available data for a Hunter.
Replace :id
with the Hunter ID.
Notes
journal_entries
are limited to the first page.airship
is only available when the Hunter is in the Floating Islands.
Properties
- Name
id
TypestringDescriptionHunter ID.
- Name
name
TypestringDescriptionName.
- Name
title
TypestringDescriptionHunter title. Includes rank and rank percent
- Name
rank
TypestringDescriptionRank.
- Name
rank_percent
TypefloatDescriptionRank percent.
- Name
last_active
TypestringDescriptionLast active time string.
- Name
joined
TypetimestampDescriptionJoined timestamp.
- Name
joined_formatted
TypestringDescriptionFormatted joined time.
- Name
gold
TypeintegerDescriptionGold amount.
- Name
gold_formatted
TypestringDescriptionGold amount formatted.
- Name
points
TypeintegerDescriptionPoints amount.
- Name
points_formatted
TypestringDescriptionPoints amount formatted.
- Name
location
TypestringDescriptionCurrent location.
- Name
lgs
TypestringDescriptionWhether or not the Hunter has LGS (Lucky Golden Shield).
- Name
lgs_duration
TypeintegerDescriptionLGS Duration in seconds.
- Name
lgs_duration_formatted
TypestringDescriptionLGS Duration formatted.
- Name
team
TypestringDescriptionWhether or not the Hunter is on a team.
- Name
team_id
TypeintegerDescriptionTeam ID.
- Name
team_name
TypestringDescriptionTeam name.
- Name
map
TypestringDescriptionWhether or not the Hunter is on a map.
- Name
map_name
TypestringDescriptionMap name.
- Name
map_id
TypeintegerDescriptionMap ID.
- Name
clues
TypeintegerDescriptionClues found.
- Name
clues_rank
TypeintegerDescriptionGlobal clues found rank.
- Name
setup
TypeobjectDescriptionHunter setup.
- Name
setup[type]
TypeobjectDescriptionTrap, base, bait, charm, and skin.
- Name
setup[type].name
TypestringDescriptionName.
- Name
setup[type].equipped
TypestringDescriptionEquipped status.
- Name
setup[type].quantity
TypestringDescriptionBait or Charm Quantity.
- Name
setup.formatted
TypestringDescriptionFormatted setup string.
- Name
trap
TypeobjectDescriptionTrap stats.
- Name
trap.power
TypeintegerDescriptionTrap power amount.
- Name
trap.power_formatted
TypestringDescriptionTrap power amount formatted.
- Name
trap.power_type
TypestringDescriptionTrap power type.
- Name
trap.luck
TypeintegerDescriptionTrap luck amount.
- Name
trap.attraction
TypeintegerDescriptionTrap attraction bonus percent.
- Name
trap.attraction_formatted
TypestringDescriptionTrap attraction amount formatted.
- Name
trap.cheese_effect
TypestringDescriptionTrap cheese effect.
- Name
trap_images
TypeobjectDescriptionTrap images.
- Name
trap_images.base
TypestringDescriptionBase image URL.
- Name
trap_images.weapon
TypestringDescriptionWeapon image URL.
- Name
trap_images.bait
TypestringDescriptionBait image URL.
- Name
auras
TypearrayDescriptionActive auras.
- Name
auras[].name
TypestringDescriptionAura name.
- Name
auras[].end_date
TypetimestampDescriptionAura end timestamp.
- Name
auras[].end_date_formatted
TypestringDescriptionFormatted aura end time.
- Name
mice_caught
TypeobjectDescriptionMice caught.
- Name
mice_caught.breeds
TypeintegerDescriptionBreeds caught.
- Name
mice_caught.total
TypeintegerDescriptionTotal mice caught.
- Name
mice_caught.event
TypeintegerDescriptionEvent mice caught.
- Name
horns
TypeobjectDescriptionHorns.
- Name
horns.horns
TypeintegerDescriptionSelf-hunts.
- Name
horns.trap_checks
TypeintegerDescriptionTrap checks.
- Name
horns.friend_hunts
TypeintegerDescriptionFriend hunts.
- Name
horns.total
TypeintegerDescriptionTotal hunts.
- Name
favorite_mice
TypearrayDescriptionFavorite mice.
- Name
favorite_mice[].id
TypestringDescriptionMouse type.
- Name
favorite_mice[].name
TypestringDescriptionMouse name.
- Name
favorite_mice[].catches
TypestringDescriptionNumber of catches.
- Name
favorite_mice[].misses
TypestringDescriptionNumber of misses.
- Name
favorite_mice[].crown
TypestringDescriptionCrown type.
- Name
favorite_mice[].image
TypestringDescriptionMouse image URL.
- Name
journal_entries
TypeobjectDescriptionJournal entries.
- Name
journal_entries[id]
TypeobjectDescriptionJournal entry.
- Name
journal_entries[id].id
TypeintegerDescriptionJournal entry ID.
- Name
journal_entries[id].type
TypearrayDescriptionJournal entry type.
- Name
journal_entries[id].image
TypestringDescriptionJournal entry image URL.
- Name
journal_entries[id].date
TypetimestampDescriptionJournal entry timestamp.
- Name
journal_entries[id].date_formatted
TypestringDescriptionFormatted entry time.
- Name
journal_entries[id].location
TypestringDescriptionJournal location.
- Name
journal_entries[id].text
TypestringDescriptionJournal text.
- Name
banned
TypeobjectDescriptionBanned status.
- Name
banned.is_banned
TypebooleanDescriptionWhether or not the Hunter is banned.
- Name
banned.restrictions
TypestringDescriptionBan restrictions.
Request
const endpoint = 'https://api.mouse.rip/hunter/8209591'
const hunterData = await fetch(endpoint)
console.log(hunterData)
Response
{
"id": 8209591,
"name": "brad 🎉️",
"title": "Viceroy (46.93%)",
"rank": "Viceroy",
"rank_percent": 46.93,
"last_active": "5 minutes",
"joined": 1641168000,
"joined_formatted": "Jan 3, 2022",
"gold": 48837187,
"gold_formatted": "48,837,187",
"points": 3170828922,
"points_formatted": "3,170,828,922",
"location": "Burroughs Rift",
"lgs": true,
"lgs_duration": 1897860,
"lgs_duration_formatted": "3 weeks 23 hours 11 minutes",
"team": true,
"team_id": 125504,
"team_name": "",
"map": true,
"map_name": "Arduous Chrome Slayer Treasure Map",
"map_id": 5576310,
"clues": 2973,
"clues_rank": 7397,
"setup": {
"trap": {
"name": "Timesplit Dissonance Trap",
"equipped": true,
"quantity": 1
},
"base": {
"name": "Alchemist's Cookbook Base",
"equipped": true,
"quantity": 1
},
"bait": {
"name": "Magical String Cheese",
"equipped": true,
"quantity": 1565,
},
"charm": {
"name": "Unstable Charm",
"equipped": true,
"quantity": 5485,
},
"skin": {
"name": "Terrifying Terrorsplit Squash Trap Skin",
"equipped": true,
"quantity": 1
},
"formatted": "Timesplit Dissonance Trap, Alchemist's Cookbook Base, Magical String Cheese (1565), Unstable Charm (5485), Terrifying Terrorsplit Squash Trap Skin"
},
"trap": {
"power": 5025,
"power_formatted": "5,025",
"power_type": "Rift",
"luck": 36,
"attraction": 20,
"attraction_formatted": "20%",
"cheese_effect": "No Effect"
},
"trap_images": {
"base": "https://www.mousehuntgame.com/images/items/bases/trap_small/82ab52084e56b184b00e60737affe528.png",
"weapon": "https://www.mousehuntgame.com/images/items/skins/trap_small/0f3511c466b951da71e2850d1c0687cb.png",
"bait": "https://www.mousehuntgame.com/images/items/bait/trap_small/f16095a5a8f2ae5b406a90144b44e071.png"
},
"auras": [
{
"name": "Anniversary",
"end_date": 1709769600,
"end_date_formatted": "March 7, 2024"
}
],
"mice_caught": {
"breeds": 924,
"event": 175,
"total": 47345
},
"horns": {
"horns": 20823,
"trap_checks": 14353,
"friend_hunts": 14438,
"total": 49614
},
"favorite_mice": [
{
"id": "glazed",
"name": "Glazy Mouse",
"catches": "100",
"misses": "0",
"crown": "silver",
"image": "https://www.mousehuntgame.com/images/mice/thumb/c7b5297963b8a56265cb5d7c3483e6cc.gif"
}
],
"journal_entries": {
"162471": {
"id": 162471,
"type": [
"catchsuccess"
],
"image": "https://www.mousehuntgame.com/images/mice/thumb/7da77ad10f719afce4f17453cb964f40.gif",
"date": 1693179840,
"date_formatted": "Aug 27 11:44 pm",
"location": "Burroughs Rift",
"text": "I sounded the Hunter's Horn and was successful in the hunt! I caught a 9 oz. Boulder Biter Mouse worth 70,000 points and 14,000 gold."
}
},
"banned": {
"is_banned": false,
"restrictions": ""
}
}
Get Hunter setup
Replace :id
with the Hunter ID.
Properties
- Name
id
TypestringDescriptionHunter ID.
- Name
rank
TypestringDescriptionHunter rank.
- Name
location
TypestringDescriptionCurrent location.
- Name
setup
TypestringDescriptionHunter trap setup.
- Name
auras
TypestringDescriptionActive auras.
Request
const hunterData = await fetch('https://api.mouse.rip/hunter/8209591/setup')
console.log(hunterData)
Response
{
"id": 8209591,
"rank": "Viceroy (46.93%)",
"location": "Burroughs Rift",
"setup": "Timesplit Dissonance Trap, Alchemist's Cookbook Base, Magical String Cheese (1565), Unstable Charm (5485), Terrifying Terrorsplit Squash Trap Skin",
"auras": "Lucky Golden Shield, Slayer, Chrome, Lightning, Anniversary"
}
Get Hunter items
Get the "checkmark" items for a Hunter.
The collected
property contains all items that the Hunter has collected and the uncollected
property contains all items that the Hunter has not collected.
The properties for the uncollected items are the same as the collected items described below.
Replace :id
with the Hunter ID.
Properties
- Name
collected
TypeobjectDescriptionCollected items.
- Name
collected.weapons
TypearrayDescriptionCollected weapons.
- Name
collected.weapons[].id
TypeintegerDescriptionWeapon ID.
- Name
collected.weapons[].slug
TypestringDescriptionWeapon type.
- Name
collected.weapons[].name
TypestringDescriptionWeapon name.
- Name
collected.bases
TypearrayDescriptionCollected bases.
- Name
collected.bases[].id
TypeintegerDescriptionBase ID.
- Name
collected.bases[].slug
TypestringDescriptionBase type.
- Name
collected.bases[].name
TypestringDescriptionBase name.
- Name
collected.map_pieces
TypearrayDescriptionCollected map pieces.
- Name
collected.map_pieces[].id
TypeintegerDescriptionMap piece ID.
- Name
collected.map_pieces[].slug
TypestringDescriptionMap piece type.
- Name
collected.map_pieces[].name
TypestringDescriptionMap piece name.
- Name
collected.collectibles
TypearrayDescriptionCollected collectibles.
- Name
collected.collectibles[].id
TypeintegerDescriptionCollectible ID.
- Name
collected.collectibles[].slug
TypestringDescriptionCollectible type.
- Name
collected.collectibles[].name
TypestringDescriptionCollectible name.
- Name
collected.skins
TypearrayDescriptionCollected skins.
- Name
collected.skins[].id
TypeintegerDescriptionSkin ID.
- Name
collected.skins[].slug
TypestringDescriptionSkin type.
- Name
collected.skins[].name
TypestringDescriptionSkin name.
- Name
uncollected
TypeobjectDescriptionUncollected items.
Request
const items = await fetch('https://api.mouse.rip/hunter/8209591/items')
console.log(items)
Response
{
"collected": {
"weapons": [
{
"id": 1168,
"slug": "hot_tub_weapon",
"name": "Mouse Hot Tub"
}
],
"bases": [
{
"id": 3080,
"slug": "empyrean_jewel_base",
"name": "Adorned Empyrean Refractor Base"
}
],
"map_pieces": [
{
"id": 1,
"slug": "balack_lantern_map_piece",
"name": "Balack's Lantern"
}
],
"collectibles": [
{
"id": 280,
"slug": "dlu_collectible",
"name": "DLU+"
}
],
"skins": [
{
"id": 2586,
"slug": "tenth_birthday_storm_wrought_ballista_skin",
"name": "10th Birthday Storm Wrought Ballista Trap Skin"
}
]
},
"uncollected": {
"weapons": [
{
"id": 3591,
"slug": "legendary_kingbot_weapon",
"name": "Legendary KingBot"
}
],
"bases": [
{
"id": 3589,
"slug": "royal_ruby_refractor_base",
"name": "Royal Ruby Refractor Base"
}
],
"collectibles": [
{
"id": 1542,
"slug": "contaminated_crumb_cake_collectible",
"name": "Contaminated Crumb Cake"
}
],
"skins": []
}
}
Get Hunter trap image
This endpoint allows you to retrieve a rendered image of a Hunter's trap.
You can append .png
to the endpoint to embed the image directly.
Replace :id
with the Hunter ID.
Request
const image = document.createElement('img')
image.src = 'https://api.mouse.rip/hunter/8209591/trap.png'
document.body.appendChild(image)
Response
Binary data with content type image/png.