Skip to content
Tyler Lartonoix edited this page Mar 12, 2018 · 5 revisions

Endpoints

Endpoint Description
/charms Returns a collection of all charms.
/charms/{idOrSlug} Returns a charm matching the specified ID or slug.

Fields

Field Type Description
id Integer The charm's ID
slug String A human readable unique identifier
name String The name of the charm
skills Collection<SkillRank> A collection of skills that the charm provides

Examples

Retrive all charms

curl -G https://mhw-db.com/charms

Output:

[

  {
    "name": "Poison Charm 1",
    "skills": [
      {
        "skill": 1,
        "level": 1,
        "description": "Reduces the duration of poison by 30%.",
        "modifiers": [
          
        ],
        "id": 1,
        "slug": "poison-resistance-rank-1"
      }
    ],
    "id": 1,
    "slug": "poison-charm-1"
  },
  ...
]

Retrieve charm by ID or slug

curl -G https://mhw-db.com/charms/1
curl -G https://mhw-db.com/charms/poison-charm-1
{
  "name": "Poison Charm 1",
  "skills": [
    {
      "skill": 1,
      "level": 1,
      "description": "Reduces the duration of poison by 30%.",
      "modifiers": [
        
      ],
      "id": 1,
      "slug": "poison-resistance-rank-1"
    }
  ],
  "id": 1,
  "slug": "poison-charm-1"
}

Retrieve charms that augment attack

curl -G https://mhw-db.com/charms --data-urlencode 'q={"skills.modifiers.attack": {"$exists": true}}'

Output:

[
  {
    "name": "Attack Charm 1",
    "skills": [
      {
        "skill": 15,
        "level": 1,
        "description": "Attack +3",
        "modifiers": {
          "attack": "3"
        },
        "id": 39,
        "slug": "attack-boost-rank-1"
      }
    ],
    "id": 4,
    "slug": "attack-charm-1"
  },
  ...
]