Hunter Data

Get Hunter data

GEThttps://api.mouse.rip/hunter/:id

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
Type
string
Description
Hunter ID.
Name
name
Type
string
Description
Name.
Name
title
Type
string
Description
Hunter title. Includes rank and rank percent
Name
rank
Type
string
Description
Rank.
Name
rank_percent
Type
float
Description
Rank percent.
Name
last_active
Type
string
Description
Last active time string.
Name
joined
Type
timestamp
Description
Joined timestamp.
Name
joined_formatted
Type
string
Description
Formatted joined time.
Name
gold
Type
integer
Description
Gold amount.
Name
gold_formatted
Type
string
Description
Gold amount formatted.
Name
points
Type
integer
Description
Points amount.
Name
points_formatted
Type
string
Description
Points amount formatted.
Name
location
Type
string
Description
Current location.
Name
lgs
Type
string
Description
Whether or not the Hunter has LGS (Lucky Golden Shield).
Name
lgs_duration
Type
integer
Description
LGS Duration in seconds.
Name
lgs_duration_formatted
Type
string
Description
LGS Duration formatted.
Name
team
Type
string
Description
Whether or not the Hunter is on a team.
Name
team_id
Type
integer
Description
Team ID.
Name
team_name
Type
string
Description
Team name.
Name
map
Type
string
Description
Whether or not the Hunter is on a map.
Name
map_name
Type
string
Description
Map name.
Name
map_id
Type
integer
Description
Map ID.
Name
clues
Type
integer
Description
Clues found.
Name
clues_rank
Type
integer
Description
Global clues found rank.
Name
setup
Type
object
Description
Hunter setup.
Name
setup[type]
Type
object
Description
Trap, base, bait, charm, and skin.
Name
setup[type].name
Type
string
Description
Name.
Name
setup[type].equipped
Type
string
Description
Equipped status.
Name
setup[type].quantity
Type
string
Description
Bait or Charm Quantity.
Name
setup.formatted
Type
string
Description
Formatted setup string.
Name
trap
Type
object
Description
Trap stats.
Name
trap.power
Type
integer
Description
Trap power amount.
Name
trap.power_formatted
Type
string
Description
Trap power amount formatted.
Name
trap.power_type
Type
string
Description
Trap power type.
Name
trap.luck
Type
integer
Description
Trap luck amount.
Name
trap.attraction
Type
integer
Description
Trap attraction bonus percent.
Name
trap.attraction_formatted
Type
string
Description
Trap attraction amount formatted.
Name
trap.cheese_effect
Type
string
Description
Trap cheese effect.
Name
trap_images
Type
object
Description
Trap images.
Name
trap_images.base
Type
string
Description
Base image URL.
Name
trap_images.weapon
Type
string
Description
Weapon image URL.
Name
trap_images.bait
Type
string
Description
Bait image URL.
Name
auras
Type
array
Description
Active auras.
Name
auras[].name
Type
string
Description
Aura name.
Name
auras[].end_date
Type
timestamp
Description
Aura end timestamp.
Name
auras[].end_date_formatted
Type
string
Description
Formatted aura end time.
Name
mice_caught
Type
object
Description
Mice caught.
Name
mice_caught.breeds
Type
integer
Description
Breeds caught.
Name
mice_caught.total
Type
integer
Description
Total mice caught.
Name
mice_caught.event
Type
integer
Description
Event mice caught.
Name
horns
Type
object
Description
Horns.
Name
horns.horns
Type
integer
Description
Self-hunts.
Name
horns.trap_checks
Type
integer
Description
Trap checks.
Name
horns.friend_hunts
Type
integer
Description
Friend hunts.
Name
horns.total
Type
integer
Description
Total hunts.
Name
favorite_mice
Type
array
Description
Favorite mice.
Name
favorite_mice[].id
Type
string
Description
Mouse type.
Name
favorite_mice[].name
Type
string
Description
Mouse name.
Name
favorite_mice[].catches
Type
string
Description
Number of catches.
Name
favorite_mice[].misses
Type
string
Description
Number of misses.
Name
favorite_mice[].crown
Type
string
Description
Crown type.
Name
favorite_mice[].image
Type
string
Description
Mouse image URL.
Name
journal_entries
Type
object
Description
Journal entries.
Name
journal_entries[id]
Type
object
Description
Journal entry.
Name
journal_entries[id].id
Type
integer
Description
Journal entry ID.
Name
journal_entries[id].type
Type
array
Description
Journal entry type.
Name
journal_entries[id].image
Type
string
Description
Journal entry image URL.
Name
journal_entries[id].date
Type
timestamp
Description
Journal entry timestamp.
Name
journal_entries[id].date_formatted
Type
string
Description
Formatted entry time.
Name
journal_entries[id].location
Type
string
Description
Journal location.
Name
journal_entries[id].text
Type
string
Description
Journal text.
Name
banned
Type
object
Description
Banned status.
Name
banned.is_banned
Type
boolean
Description
Whether or not the Hunter is banned.
Name
banned.restrictions
Type
string
Description
Ban restrictions.

Request

GET

https://api.mouse.rip/hunter/8209591

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

GEThttps://api.mouse.rip/hunter/:id/setup

Replace :id with the Hunter ID.

Properties

Name
id
Type
string
Description
Hunter ID.
Name
rank
Type
string
Description
Hunter rank.
Name
location
Type
string
Description
Current location.
Name
setup
Type
string
Description
Hunter trap setup.
Name
auras
Type
string
Description
Active auras.

Request

GET

https://api.mouse.rip/hunter/:id/setup

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

GEThttps://api.mouse.rip/hunter/:id/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
Type
object
Description
Collected items.
Name
collected.weapons
Type
array
Description
Collected weapons.
Name
collected.weapons[].id
Type
integer
Description
Weapon ID.
Name
collected.weapons[].slug
Type
string
Description
Weapon type.
Name
collected.weapons[].name
Type
string
Description
Weapon name.
Name
collected.bases
Type
array
Description
Collected bases.
Name
collected.bases[].id
Type
integer
Description
Base ID.
Name
collected.bases[].slug
Type
string
Description
Base type.
Name
collected.bases[].name
Type
string
Description
Base name.
Name
collected.map_pieces
Type
array
Description
Collected map pieces.
Name
collected.map_pieces[].id
Type
integer
Description
Map piece ID.
Name
collected.map_pieces[].slug
Type
string
Description
Map piece type.
Name
collected.map_pieces[].name
Type
string
Description
Map piece name.
Name
collected.collectibles
Type
array
Description
Collected collectibles.
Name
collected.collectibles[].id
Type
integer
Description
Collectible ID.
Name
collected.collectibles[].slug
Type
string
Description
Collectible type.
Name
collected.collectibles[].name
Type
string
Description
Collectible name.
Name
collected.skins
Type
array
Description
Collected skins.
Name
collected.skins[].id
Type
integer
Description
Skin ID.
Name
collected.skins[].slug
Type
string
Description
Skin type.
Name
collected.skins[].name
Type
string
Description
Skin name.
Name
uncollected
Type
object
Description
Uncollected items.

Request

GET

https://api.mouse.rip/hunter/:id/items

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

GEThttps://api.mouse.rip/hunter/:id/trap

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

GET

https://api.mouse.rip/hunter/:id/trap

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.