REST API for Dominions 5 data via the dom5inspector. Although this project is in an early phase, you are already welcome to use it. If you'd like some particular endpoint or other feature for whatever project you're working on, please let me know and I'll make sure to prioritise it. The API is available at dom5api.illwiki.com.
Get item by ID: GET /items/337
{"id":337,
"name":"Lightless Lantern",
"type":"misc",
"constlevel":6,
"mainlevel":1,
"mpath":"F1",
"gemcost":"5F",
"screenshot":"/items/337/screenshot"
}
Get unit by exact name: GET /units?name=sauromancer
{"units":[
{"id":161,
"name":"Sauromancer",
"hp":12,
"size":2,
"screenshot":"/unit/161/screenshot"
},
{"id":1036,
"name":"Sauromancer",
"hp":11,
"size":2,
"screenshot":"/unit/1036/screenshot"
}
]}
Get sites by fuzzy name matching: GET /sites?name=flying+monks&match=fuzzy
{"sites":[
{"id":896,
"name":"Temple of Flying Monkeys",
"path":"Holy",
"level":1,
"rarity":"Rare",
"screenshot":"/sites/896/screenshot"
}
]}
Endpoint | Response | Description |
---|---|---|
By ID | ||
/items/:id | Item | Get item by ID |
/spells/:id | Spell | Get spell by ID |
/units/:id | Unit | Get unit by ID |
/sites/:id | Site | Get site by ID |
/mercs/:id | Merc | Get mercenary by ID |
By exact name | ||
/items?name=:name | List of Items | Get items by exact name match |
/spells?name=:name | List of Spells | Get spells by exact name match |
/units?name=:name | List of Units | Get units by exact name match |
/sites?name=:name | List of Sites | Get sites by exact name match |
/mercs?name=:name | List of Mercs | Get mercenaries by exact name match |
By approximate name | ||
/items?name=:name&match=fuzzy | List of Items | Get items by fuzzy name search |
/spells?name=:name&match=fuzzy | List of Spells | Get spells by fuzzy name search |
/units?name=:name&match=fuzzy | List of Units | Get units by fuzzy name search |
/sites?name=:name&match=fuzzy | List of Sites | Get sites by fuzzy name search |
/mercs?name=:name&match=fuzzy | List of Mercs | Get mercenaries by fuzzy name search |
Inspector screenshots | ||
/items/:id/screenshot | Image | Get dom5inspector screenshot of item by ID |
/spells/:id/screenshot | Image | Get dom5inspector screenshot of spell by ID |
/units/:id/screenshot | Image | Get dom5inspector screenshot of unit by ID |
/sites/:id/screenshot | Image | Get dom5inspector screenshot of site by ID |
/mercs/:id/screenshot | Image | Get dom5inspector screenshot of mercenary by ID |
All responses are JSON-encoded. The returned objects are currently bare-bones, but I aim to include all the information supplied by the dom5inspector. Property names are mostly the same as those used by the inspector.
Property | Example value | Notes |
---|---|---|
id | 337 | |
name | Lightless lantern | |
type | misc | Slot type, one of: 1-h wpn, 2-h wpn, shield, helm, crown, armor, boots, misc. |
constlevel | 6 | |
mpath | F1 | |
gemcost | 5F | |
screenshot | /items/337/screenshot | Link to dom5inspector screenshot |
Property | Example value | Notes |
---|---|---|
id | 808 | |
name | Acashic Knowledge | |
type | Ritual | Combat or Ritual |
mpath | S3 | |
gemcost | 25S | |
school | Conjuration | |
researchlevel | 6 | |
screenshot | /spells/808/screenshot | Link to dom5inspector screenshot |
Property | Example value | Notes |
---|---|---|
id | 785 | |
name | Gygja | |
hp | 38 | |
size | 4 | |
randompaths | {paths: 'SDNB', levels: '1', chance: '100'}, {paths: 'SDNB', levels: '1', chance: '100'}, {paths: 'SDNB', levels: '1', chance: '10'} | Appears only for units with random paths, returned as an array of objects |
screenshot | /units/785/screenshot | Link to dom5inspector screenshot |
Property | Example value | Notes |
---|---|---|
id | 584 | |
name | Library | |
path | Astral | |
level | 0 | |
rarity | Uncommon | Possible values are Common , Uncommon , Rare , Never random , Throne lvl1 , Throne lvl2 and Throne lvl3 , corresponding to 0, 1, 2, 5, 11, 12, 13 as defined in Illwinter's Modding Manual. |
screenshot | /sites/584/screenshot | Link to dom5inspector screenshot |
Property | Example value | Notes |
---|---|---|
id | 60 | |
name | Nergash's Damned Legion | |
bossname | Nergash | |
commander_id | 310 | Key to /units/:id endpoint. |
unit_id | 195 | Key to /units/:id endpoint. |
nrunits | 80 | |
screenshot | /mercs/60/screenshot | Link to dom5inspector screenshot |