api.mouse.rip

Shops

What every location's shop sells, the gold and items each costs, and what a hunter must own to buy it.

Get all shops

GEThttps://api.mouse.rip/shops

Filters narrow both the shops and their items; shops left with no items are dropped.

Query parameters

  • Name
    location
    Type
    string
    Description
    Location type. Comma-separated or repeated.
  • Name
    item
    Type
    string
    Description
    ID or type of an item the shop sells. Comma-separated or repeated.
  • Name
    cost
    Type
    string
    Description
    ID or type of an item used to pay. Comma-separated or repeated.
  • Name
    category
    Type
    string
    Description
    Shop tab, e.g. bait, weapon, map_piece. Comma-separated or repeated.
  • Name
    q
    Type
    string
    Description
    Partial item name or type.

Properties

  • Name
    id
    Type
    string
    Description
    Location type.
  • Name
    name
    Type
    string
    Description
    Location name.
  • Name
    items
    Type
    array of object
    Description
    What the shop sells.
  • Name
    id
    Type
    integer
    Description
  • Name
    type
    Type
    string
    Description
    Item type.
  • Name
    name
    Type
    string
    Description
    Item name.
  • Name
    category
    Type
    string
    Description
    The shop tab.
  • Name
    gold_cost
    Type
    integer
    Description
    Price in gold.
  • Name
    refund
    Type
    integer
    Description
    Gold refunded when the item is sold back.
  • Name
    item_costs
    Type
    array of ItemRef
    Description
    Items it costs, besides gold.
  • Name
    id
    Type
    integer
    Description
    Item ID, or 0 if the item isn't known.
  • Name
    type
    Type
    string
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    quantity
    Type
    integer
    Description
  • Name
    requirements
    Type
    array of ItemRef
    Description
    Items the hunter must own, including adventure progress items such as complete_queso_river.
  • Name
    id
    Type
    integer
    Description
    Item ID, or 0 if the item isn't known.
  • Name
    type
    Type
    string
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    quantity
    Type
    integer
    Description

    • Request

    GET
    https://api.mouse.rip/shops?item=sky_cheese
    const response = await fetch('https://api.mouse.rip/shops?item=sky_cheese')

    Response

    [
  {
    "id": "floating_islands",
    "name": "Floating Islands",
    "items": [
      {
        "id": 3089,
        "type": "sky_cheese",
        "name": "Cloud Cheesecake",
        "category": "bait",
        "gold_cost": 1000,
        "refund": 0,
        "item_costs": [...],
        "requirements": []
      }
    ]
  }
]

    Get a location's shop

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

    Accepts a location type. Takes the same filters as /shops, which narrow the shop's items. Returns 404 for an unknown location, or when the filters match no items.

    Query parameters

    • Name
      item
      Type
      string
      Description
      ID or type of an item the shop sells. Comma-separated or repeated.
    • Name
      cost
      Type
      string
      Description
      ID or type of an item used to pay. Comma-separated or repeated.
    • Name
      category
      Type
      string
      Description
      Shop tab, e.g. bait, weapon, map_piece. Comma-separated or repeated.
    • Name
      q
      Type
      string
      Description
      Partial item name or type.

    Properties

    • Name
      id
      Type
      string
      Description
      Location type.
    • Name
      name
      Type
      string
      Description
      Location name.
    • Name
      items
      Type
      array of object
      Description
      What the shop sells.
    • Name
      id
      Type
      integer
      Description
    • Name
      type
      Type
      string
      Description
      Item type.
    • Name
      name
      Type
      string
      Description
      Item name.
    • Name
      category
      Type
      string
      Description
      The shop tab.
    • Name
      gold_cost
      Type
      integer
      Description
      Price in gold.
    • Name
      refund
      Type
      integer
      Description
      Gold refunded when the item is sold back.
    • Name
      item_costs
      Type
      array of ItemRef
      Description
      Items it costs, besides gold.
    • Name
      id
      Type
      integer
      Description
      Item ID, or 0 if the item isn't known.
    • Name
      type
      Type
      string
      Description
    • Name
      name
      Type
      string
      Description
    • Name
      quantity
      Type
      integer
      Description
  • Name
    requirements
    Type
    array of ItemRef
    Description
    Items the hunter must own, including adventure progress items such as complete_queso_river.
  • Name
    id
    Type
    integer
    Description
    Item ID, or 0 if the item isn't known.
  • Name
    type
    Type
    string
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    quantity
    Type
    integer
    Description

    • Request

    GET
    https://api.mouse.rip/shops/floating_islands
    const response = await fetch('https://api.mouse.rip/shops/floating_islands')

    Response

    {
  "id": "floating_islands",
  "name": "Floating Islands",
  "items": [
    {
      "id": 3271,
      "type": "empyrean_codex_stat_item",
      "name": "Empyrean Codex",
      "category": "crafting_item",
      "gold_cost": 900000,
      "refund": 0,
      "item_costs": [
        {...}
      ],
      "requirements": []
    },
    {
      "id": 3070,
      "type": "bottled_wind_stat_item",
      "name": "Bottled Wind",
      "category": "crafting_item",
      "gold_cost": 900,
      "refund": 0,
      "item_costs": [
        {...},
        {...}
      ],
      "requirements": []
    },
    ...
  ]
}