Skip to content

Latest commit

 

History

History
67 lines (54 loc) · 2.17 KB

README.md

File metadata and controls

67 lines (54 loc) · 2.17 KB
Raw
Arcadius Banner

An unofficial Arcadius API

Base URL

https://arcadius-azure.vercel.app/

Documentation

soon!

Endpoints

Here are the available endpoints for this API:

  • GET /equipments/fishingrods: Retrieves a list of all fishing rods.
  • GET /equipments/fishingrods/:rodname: Retrieves information about a specific fishing rod.
  • GET /baits: Retrieves a list of all fishing baits.
  • GET /baits/:baitname: Retrieves information about a specific fishing bait.
  • GET /islands: Retrieves a list of all islands.
  • GET /islands/:islandname: Retrieves information about a specific island.
  • GET /plants: Retrieves a list of all plants.
  • GET /plants/:plantname: Retrieves information about a specific plant.

And more endpoints are available in the API documentation.

Examples

Here are some example requests using cURL:

Retrieves a list of all fishing rods

curl https://arcadius-azure.vercel.app/equipments/fishingrods

Retrieves information about a specific fishing rod

curl https://arcadius-azure.vercel.app/equipments/fishingrods/simplerod

Retrieves information about the worm bait

curl https://arcadius-azure.vercel.app/baits~/worm

TODO

  • Pickaxes
  • Axes
  • Sickles
  • Ores
  • Ingots
  • Fish
  • Logs
  • Potions
  • Mushrooms
  • Plants
  • NPC
  • Island
  • Areas

In addition to these features, I also plan to create an API wrapper package to make it easier to interact with the Arcadius API in various programming languages.

Contribution

Contributions to this project are welcome. If you find a bug or want to add a new feature, please create a new issue or pull request on GitHub.

License

This project is licensed under the MIT License.