-
Notifications
You must be signed in to change notification settings - Fork 6
Armor
Tyler Lartonoix edited this page Apr 21, 2018
·
17 revisions
| Endpoint | Description |
|---|---|
| /armor | Returns a collection of all armor pieces. |
| /armor/{idOrSlug} | Returns an armor piece matching the specified ID or slug. |
| Field | Type | Description |
|---|---|---|
| id | Integer | The armor piece's ID |
| slug | String | A human readable unique identifier |
| name | String | The name of the armor piece |
| type | Enum<ArmorType> | The type of the armor piece |
| rank | Enum<ArmorRank> | The rank of the armor piece |
| rarity | Integer | The armor piece's rarity |
| defense | See Defense | Defense information for the armor piece |
| resistances | See Resistances | Elemental resistance information |
| slots | See Slots | Decoration slot information |
| attributes | Attributes | An object describing how the armor affects player attributes |
| skills | Collection<SkillRank> | A collection of skills that the armor provides |
| assets | ArmorAssets | A collection of image assets available for the armor piece |
A sample Armor object looks like this.
{
"id": 1,
"slug": "leather-headgear",
"name": "Leather Headgear",
"type": "head",
"rank": "low",
"rarity": 1,
"defense": {
"base": 2,
"max": 38,
"augmented": 68
},
"resistances": {
"fire": 2,
"water": 0,
"ice": 0,
"thunder": 0,
"dragon": 0
},
"slots": [
],
"attributes": {
"defense": 2,
"resistFire": 2
},
"skills": [
{
"id": 207,
"slug": "hunger-resistance-rank-1",
"level": 1,
"description": "Extends the time until your stamina cap decreases by 30%.",
"modifiers": [
],
"skill": 67,
"skillName": "Hunger Resistance"
}
],
"armorSet": {
"id": 1,
"name": "Leather",
"rank": "low",
"pieces": [
1,
2,
3,
4,
5
]
},
"assets": {
"imageMale": "https://assets.mhw-db.com/armor/0c3c7586ed8b763a29b0fb6cb1b11518.e5f105b7b926b37b9deb7261b9b5429618850e33.png",
"imageFemale": "https://assets.mhw-db.com/armor/5fa9899019adb65261129059e30504b1.9c3d0741692bc8b3b96e92e75feb2ba8a68110d4.png"
}
}| Field | Type | Description |
|---|---|---|
| base | Integer | The base defense value |
| max | Integer | The defense value at max level |
| augmented | Integer | The defense value when augmented |
| Field | Type | Description |
|---|---|---|
| fire | Integer | The armor's fire resistance |
| water | Integer | The armor's water resistance |
| ice | Integer | The armor's ice resistance |
| thunder | Integer | The armor's thunder resistance |
| dragon | Integer | The armor's dragon resistance |
The slots field is an array of objects with the following structure.
| Field | Type | Description |
|---|---|---|
| rank | Integer | The rank of the slot |
There may be between 0 and 3 items in the slots array, representing the slot layout of the slots on the armor.
| Field | Type | Description |
|---|---|---|
| imageMale | String | The URL for the male version of the image asset |
| imageFemale | String | The URL for the female version of the image asset |
You are free to hotlink directly to the image assets, and do not need to cache them locally if you don't want to. Please bear in mind, the image URLs may change following an update.
An armor type is one of the following values:
- head
- chest
- gloves
- waist
- legs
An armor rank is one of the following values:
- low
- high
curl -G https://mhw-db.com/armorOutput:
[
{
"id": 1,
"slug": "leather-headgear",
"name": "Leather Headgear",
"type": "head",
"rank": "low",
"rarity": 1,
"attributes": {
"defense": 2,
"resistFire": 2
},
"skills": [
{
"id": 207,
"slug": "hunger-resistance-rank-1",
"skill": 67,
"level": 1,
"description": "Extends the time until your stamina cap decreases by 30%.",
"modifiers": [
]
}
],
"armorSet": {
"id": 1,
"name": "Leather",
"rank": "low",
"pieces": [
1,
2,
3,
4,
5
]
},
"assets": {
"imageMale": "https://assets.mhw-db.com/armor/0c3c7586ed8b763a29b0fb6cb1b11518.e5f105b7b926b37b9deb7261b9b5429618850e33.png",
"imageFemale": "https://assets.mhw-db.com/armor/5fa9899019adb65261129059e30504b1.9c3d0741692bc8b3b96e92e75feb2ba8a68110d4.png"
}
},
...
]
curl -G https://mhw-db.com/armor/1
curl -G https://mhw-db.com/armor/leather-headgearOutput:
{
"id": 1,
"slug": "leather-headgear",
"name": "Leather Headgear",
"type": "head",
"rank": "low",
"rarity": 1,
"attributes": {
"defense": 2,
"resistFire": 2
},
"skills": [
{
"id": 207,
"slug": "hunger-resistance-rank-1",
"skill": 67,
"level": 1,
"description": "Extends the time until your stamina cap decreases by 30%.",
"modifiers": [
]
}
],
"armorSet": {
"id": 1,
"name": "Leather",
"rank": "low",
"pieces": [
1,
2,
3,
4,
5
]
},
"assets": {
"imageMale": "https://assets.mhw-db.com/armor/0c3c7586ed8b763a29b0fb6cb1b11518.e5f105b7b926b37b9deb7261b9b5429618850e33.png",
"imageFemale": "https://assets.mhw-db.com/armor/5fa9899019adb65261129059e30504b1.9c3d0741692bc8b3b96e92e75feb2ba8a68110d4.png"
}
}curl -G https://mhw-db.com/armor \
--data-urlencode 'q={"rank": "high"}'Output:
[
{
"name": "Leather Headgear Alpha",
"type": "head",
"skills": [
{
"skill": 67,
"level": 2,
"description": "Extends the time until your stamina cap decreases by 60%.",
"modifiers": [
],
"id": 208,
"slug": "hunger-resistance-rank-2"
}
],
"rank": "high",
"rarity": 5,
"id": 154,
"slug": "leather-headgear-alpha",
"attributes": {
"defense": 32,
"resistFire": 2
}
},
...
]
curl -G https://mhw-db.com/armor \
--data-urlencode 'q={"attributes.defense": {"$gte": 50}}'Output:
[
{
"id": 361,
"slug": "rath-heart-helm-alpha",
"name": "Rath Heart Helm Alpha",
"type": "head",
"rank": "high",
"rarity": 6,
"attributes": {
"defense": 52,
"resistFire": 3,
"resistThunder": -3,
"resistDragon": -4
},
"skills": [
{
"id": 105,
"slug": "poison-attack-rank-1",
"skill": 31,
"level": 1,
"description": "Poison buildup +5% Bonus: +10",
"modifiers": [
]
},
{
"id": 215,
"slug": "evade-extender-rank-1",
"skill": 69,
"level": 1,
"description": "Slightly extends evasion distance.",
"modifiers": [
]
}
],
"armorSet": {
"id": 81,
"name": "Rath Heart Alpha",
"rank": "high",
"pieces": [
361,
362,
363,
364,
365
]
},
"assets": {
"imageMale": "https://assets.mhw-db.com/armor/36aeb667c06ac8733a72a386fee3dc95.aa788d0fffd68233364791a058d1893e041267e6.png",
"imageFemale": "https://assets.mhw-db.com/armor/a6ac7d90584e815661301f4b6bba05ea.167231c9a0a5b128451443b4eb891c5ed79cd50f.png"
}
},
...
]
curl -G https://mhw-db.com/armor \
--data-urlencode 'q={"skills.skill.name": "Master Mounter"}'Output
[
{
"id": 100,
"slug": "lumu-mail",
"name": "Lumu Mail",
"type": "chest",
"rank": "low",
"rarity": 3,
"attributes": {
"defense": 20,
"resistFire": -3,
"resistWater": 2,
"resistIce": 1
},
"skills": [
{
"id": 159,
"slug": "master-mounter-rank-1",
"skill": 49,
"level": 1,
"description": "Makes it easier to mount monsters and down mounted monsters.",
"modifiers": [
]
}
],
"armorSet": {
"id": 23,
"name": "Lumu",
"rank": "low",
"pieces": [
99,
100,
101,
102,
103
]
},
"assets": {
"imageMale": "https://assets.mhw-db.com/armor/27e504fba6635bf7fd4dbe64442bca3b.c22ce56ea07c382a55106dfc86d93cb536f41536.png",
"imageFemale": "https://assets.mhw-db.com/armor/6a322ccd540b0290f25df2e1f2ed5058.2eafe1c11dfce458567a5af97361a6cc01696a19.png"
}
},
...
]
These documents are currently a work in progress. If you notice any mistakes, typos, or if you find any issues in the API itself, please open an issue, or contact me at tyler@lartonoix.com.