Skip to content

DorielRivalet/ezlion

Repository files navigation

EZlion

Data retrieval, made easy.

  • NuGet NuGet
  • npm npm

A data retrieval and translation project for Monster Hunter Frontier Z

API

It is recommended to host the API yourself. You can do so by doing the following:

  1. Fork the repository.
  2. Deploy the project following the instructions here. Select app/ as the root of the project in Vercel Settings.
  3. Confirm if it worked correctly by checking the API Reference at https://yourprojectname.vercel.app/docs.

Usage

The API is static, you can only use the GET HTTP method.

We provide the following data, for example:

  • Request: Get monster by id
curl https://yourprojectname.vercel.app/api/v0/monsters/1
  • Response:
{ "id": 1, "name": "Rathian" }
  • Request: Get monsters
curl https://yourprojectname.vercel.app/api/v0/monsters
  • Response:
{
  "results": [
    { "id": 0, "name": "None" },
    { "id": 1, "name": "Rathian" },
    { "id": 2, "name": "Rathalos" }
  ],
  "metadata": {
    "readonly": true,
    "repository": "https://github.com/DorielRivalet/ezlion"
  }
}

For more information, consult the documentation here.