Skip to content
Tyler Lartonoix edited this page May 1, 2018 · 31 revisions

Important

The docs wiki is no longer being maintained. For up-to-date documentation, please visit our GitHub Pages site. Thanks!

Basic Info

This API is currently in development. As such, some information may be incomplete or missing. Please feel free to contact me at [email protected] with any feedback or requests!

I'm not currently planning on rate limiting or otherwise restricting access to the API, so please use it respectfully. This is a hobby project that I'm maintaining out of my own pocket, and I'd like to keep it as open as possible.

Available Endpoints

The base domain for the API is https://mhw-db.com. Both HTTP and HTTPS connections are supported.

Endpoint Description Further Reading
/armor Returns a collection of all armor pieces Link
/armor/sets Returns a collection of all armor sets Link
/charms Returns a collection of all charms Link
/decorations Returns a collection of all decorations Link
/items Returns a collection of all items Link
/skills Returns a collection of all skills and their ranks Link
/weapons Returns a collection of all weapons Link

Updates

I'll be pushing out updates as frequently as I can, with the goal of getting as much information into the API as possible. Whenever I make a change, I'll be posting a new release on this repository's releases page. In the future, I'll also be posting updates to my Twitter account, in order to make upcoming changes a bit more visible for people who might not be constantly watching for updates on GitHub.

Planned Features

You can check out what's currently in progress on the project's Trello board.

Contributing

The source code for the backend software can be found at LartTyler/MHWDB-API. If you would like to contribute to the project, please check out the contributing guide.

Reporting Bugs / Mistakes

Please use the issue tracker on this repository to report any issues, or to request any new features.